Class BaseGrids<TGrid, TZoomGrids>`Abstract`

Grids

Type Parameters

TGrid extends BaseGrid

grid type
TZoomGrids extends BaseZoomGrids<TGrid>

zoom grids type

Hierarchy

BaseGrids

Index

Constructors

constructor

new BaseGrids<TGrid, TZoomGrids>(properties: GridProperties): BaseGrids<TGrid, TZoomGrids>
Constructor
Type Parameters
- TGrid extends BaseGrid<TGrid>
- TZoomGrids extends BaseZoomGrids<TGrid, TZoomGrids>
Parameters
- properties: GridProperties
  
  grid properties
Returns BaseGrids<TGrid, TZoomGrids>
- Defined in lib/BaseGrids.ts:36

Properties

`Protected` `Readonly` properties

properties: GridProperties

Grid properties

Methods

`Protected` createZoomGrids

createZoomGrids(): void
Create the zoom level grids

Returns void
- Defined in lib/BaseGrids.ts:279

disable

disable(grid: TGrid): void
Disable the grid
Parameters
- grid: TGrid
  
  grid
Returns void
- Defined in lib/BaseGrids.ts:370

disableGrids

disableGrids(grids: TGrid[]): void
Disable grids
Parameters
- grids: TGrid[]
  
  grids
Returns void
- Defined in lib/BaseGrids.ts:336

enable

enable(grid: TGrid): void
Enable the grid
Parameters
- grid: TGrid
  
  grid
Returns void
- Defined in lib/BaseGrids.ts:348

enableAllLabelers

enableAllLabelers(): void
Enable all grid labelers

Returns void
- Defined in lib/BaseGrids.ts:518

enableGrids

enableGrids(grids: TGrid[]): void
Enable grids
Parameters
- grids: TGrid[]
  
  grids
Returns void
- Defined in lib/BaseGrids.ts:324

`Abstract` getDefaultWidth

getDefaultWidth(): number
Get the default grid line width

Returns
width

Returns number
- Defined in lib/BaseGrids.ts:45

`Protected` getGridStyle

getGridStyle(grid: TGrid, color?: Color, width?: number): GridStyle
Get a combined grid style from the provided color, width, and grid

Returns
grid style
Parameters
- grid: TGrid
  
  grid
- Optional color: Color
  
  color
- Optional width: number
  
  width
Returns GridStyle
- Defined in lib/BaseGrids.ts:264

getGrids

getGrids(zoom: number): undefined | TZoomGrids
Get the grids for the zoom level

Returns
grids
Parameters
- zoom: number
  
  zoom level
Returns undefined | TZoomGrids
- Defined in lib/BaseGrids.ts:292

`Abstract` grids

grids(): TGrid[]
Get the grids

Returns
grids

Returns TGrid[]
- Defined in lib/BaseGrids.ts:52

`Protected` loadGrid

loadGrid(grid: TGrid, gridKey: string, labeler: Labeler, enabled?: boolean): void
Load the grid
Parameters
- grid: TGrid
  
  name
- gridKey: string
  
  grid name key
- labeler: Labeler
  
  grid labeler
- Optional enabled: boolean
  
  enable created grids
Returns void
- Defined in lib/BaseGrids.ts:75

`Protected` loadGridStyleColor

loadGridStyleColor(gridKey: string, gridKey2: string): undefined | Color
Load the grid style color

Returns
color
Parameters
- gridKey: string
  
  grid name key
- gridKey2: string
  
  second grid name key
Returns undefined | Color
- Defined in lib/BaseGrids.ts:225

`Protected` loadGridStyleWidth

loadGridStyleWidth(gridKey: string, gridKey2: string): undefined | number
Load the grid style width

Returns
width
Parameters
- gridKey: string
  
  grid name key
- gridKey2: string
  
  second grid name key
Returns undefined | number
- Defined in lib/BaseGrids.ts:246

`Protected` `Abstract` newZoomGrids

newZoomGrids(zoom: number): TZoomGrids
Create a new zoom grids

Returns
zoom grids
Parameters
- zoom: number
  
  zoom level
Returns TZoomGrids
- Defined in lib/BaseGrids.ts:61

setAllLabelBuffers

setAllLabelBuffers(buffer: number): void
Set all label grid edge buffers
Parameters
- buffer: number
  
  label buffer (greater than or equal to 0.0 and less than 0.5)
Returns void
- Defined in lib/BaseGrids.ts:533

setMaxZoom

setMaxZoom(grid: TGrid, maxZoom?: number): void
Set the grid maximum zoom
Parameters
- grid: TGrid
  
  grid
- Optional maxZoom: number
  
  maximum zoom
Returns void
- Defined in lib/BaseGrids.ts:410

setMinZoom

setMinZoom(grid: TGrid, minZoom: number): void
Set the grid minimum zoom
Parameters
- grid: TGrid
  
  grid
- minZoom: number
  
  minimum zoom
Returns void
- Defined in lib/BaseGrids.ts:394

setZoomRange

setZoomRange(grid: TGrid, minZoom: number, maxZoom?: number): void
Set the grid zoom range
Parameters
- grid: TGrid
  
  grid
- minZoom: number
  
  minimum zoom
- Optional maxZoom: number
  
  maximum zoom
Returns void
- Defined in lib/BaseGrids.ts:428

Generated using TypeDoc