Class BaseGrid

Base Grid

Hierarchy

BaseGrid

Constructors

constructor

new BaseGrid(): BaseGrid
Returns BaseGrid

Methods

getColor

getColor(): undefined | Color
Get the grid line color

Returns
grid line color

Returns undefined | Color
- Defined in lib/BaseGrid.ts:219

getLabelBuffer

getLabelBuffer(): number
Get the label grid edge buffer

Returns
label buffer (greater than or equal to 0.0 and less than 0.5)

Returns number
- Defined in lib/BaseGrid.ts:296

getLabeler

getLabeler(): undefined | Labeler
Get the grid labeler

Returns
grid labeler

Returns undefined | Labeler
- Defined in lib/BaseGrid.ts:257

getLinesMaxZoom

getLinesMaxZoom(): undefined | number
Get the maximum zoom level for drawing grid lines

Returns
maximum zoom level

Returns undefined | number
- Defined in lib/BaseGrid.ts:154

getLinesMinZoom

getLinesMinZoom(): number
Get the minimum zoom level for drawing grid lines

Returns
minimum zoom level

Returns number
- Defined in lib/BaseGrid.ts:126

getMaxZoom

getMaxZoom(): undefined | number
Get the maximum zoom level

Returns
maximum zoom level

Returns undefined | number
- Defined in lib/BaseGrid.ts:87

getMinZoom

getMinZoom(): number
Get the minimum zoom level

Returns
minimum zoom level

Returns number
- Defined in lib/BaseGrid.ts:68

getStyle

getStyle(): GridStyle
Get the grid line style

Returns
grid line style

Returns GridStyle
- Defined in lib/BaseGrid.ts:200

getWidth

getWidth(): number
Get the grid line width

Returns
grid line width

Returns number
- Defined in lib/BaseGrid.ts:238

hasLabeler

hasLabeler(): boolean
Has a grid labeler

Returns
true if has a grid labeler

Returns boolean
- Defined in lib/BaseGrid.ts:266

hasLinesMaxZoom

hasLinesMaxZoom(): boolean
Has a maximum zoom level override for drawing grid lines

Returns
true if has a maximum, false if not overridden

Returns boolean
- Defined in lib/BaseGrid.ts:163

hasLinesMinZoom

hasLinesMinZoom(): boolean
Has a minimum zoom level override for drawing grid lines

Returns
true if has a minimum, false if not overridden

Returns boolean
- Defined in lib/BaseGrid.ts:135

hasMaxZoom

hasMaxZoom(): boolean
Has a maximum zoom level

Returns
true if has a maximum, false if unbounded

Returns boolean
- Defined in lib/BaseGrid.ts:96

isEnabled

isEnabled(): boolean
Is the grid enabled

Returns
enabled flag

Returns boolean
- Defined in lib/BaseGrid.ts:49

isLabelerWithin

isLabelerWithin(zoom: number): boolean
Is labeler zoom level within the grid zoom range

Returns
true if within range
Parameters
- zoom: number
  
  zoom level
Returns boolean
- Defined in lib/BaseGrid.ts:287

isLinesWithin

isLinesWithin(zoom: number): boolean
Is the zoom level within the grid lines zoom range

Returns
true if within range
Parameters
- zoom: number
  
  zoom level
Returns boolean
- Defined in lib/BaseGrid.ts:184

isWithin

isWithin(zoom: number): boolean
Is the zoom level within the grid zoom range

Returns
true if within range
Parameters
- zoom: number
  
  zoom level
Returns boolean
- Defined in lib/BaseGrid.ts:117

setColor

setColor(color?: Color): void
Set the grid line color
Parameters
- Optional color: Color
  
  grid line color
Returns void
- Defined in lib/BaseGrid.ts:229

setEnabled

setEnabled(enabled: boolean): void
Set the enabled flag
Parameters
- enabled: boolean
  
  enabled flag
Returns void
- Defined in lib/BaseGrid.ts:59

setLabeler

setLabeler(labeler?: Labeler): void
Set the grid labeler
Parameters
- Optional labeler: Labeler
  
  grid labeler
Returns void
- Defined in lib/BaseGrid.ts:276

setLinesMaxZoom

setLinesMaxZoom(linesMaxZoom?: number): void
Set the maximum level override for drawing grid lines
Parameters
- Optional linesMaxZoom: number
  
  maximum zoom level or undefined to remove
Returns void
- Defined in lib/BaseGrid.ts:173

setLinesMinZoom

setLinesMinZoom(linesMinZoom?: number): void
Set the minimum level override for drawing grid lines
Parameters
- Optional linesMinZoom: number
  
  minimum zoom level or undefined to remove
Returns void
- Defined in lib/BaseGrid.ts:145

setMaxZoom

setMaxZoom(maxZoom?: number): void
Set the maximum zoom level
Parameters
- Optional maxZoom: number
  
  maximum zoom level
Returns void
- Defined in lib/BaseGrid.ts:106

setMinZoom

setMinZoom(minZoom: number): void
Set the minimum zoom level
Parameters
- minZoom: number
  
  minimum zoom level
Returns void
- Defined in lib/BaseGrid.ts:78

setStyle

setStyle(style?: GridStyle): void
Set the grid line style
Parameters
- Optional style: GridStyle
  
  grid line style
Returns void
- Defined in lib/BaseGrid.ts:210

setWidth

setWidth(width: number): void
Set the grid line width
Parameters
- width: number
  
  grid line width
Returns void
- Defined in lib/BaseGrid.ts:248

Generated using TypeDoc