Class Labeler`Abstract`

Grid Labeler

Hierarchy

Labeler

Index

Constructors

Methods

getBuffer getColor getMaxZoom getMinZoom getTextSize hasMaxZoom isEnabled isWithin setBuffer setColor setEnabled setMaxZoom setMinZoom setTextSize

Constructors

constructor

new Labeler(enabled: boolean, minZoom: number, maxZoom: undefined | number, color: undefined | Color, textSize: number, buffer: number): Labeler
Constructor
Parameters
- enabled: boolean
  
  enabled labeler
- minZoom: number
  
  minimum zoom
- maxZoom: undefined | number
  
  maximum zoom
- color: undefined | Color
  
  label color
- textSize: number
  
  label text size
- buffer: number
  
  grid edge buffer (greater than or equal to 0.0 and less than 0.5)
Returns Labeler
- Defined in lib/Labeler.ts:54

Methods

getBuffer

getBuffer(): number
Get the grid edge buffer

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

Returns number
- Defined in lib/Labeler.ts:190

getColor

getColor(): undefined | Color
Get the label color

Returns
label color

Returns undefined | Color
- Defined in lib/Labeler.ts:152

getMaxZoom

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

Returns
maximum zoom level

Returns undefined | number
- Defined in lib/Labeler.ts:113

getMinZoom

getMinZoom(): number
Get the minimum zoom level

Returns
minimum zoom level

Returns number
- Defined in lib/Labeler.ts:94

getTextSize

getTextSize(): number
Get the label text size

Returns
label text size

Returns number
- Defined in lib/Labeler.ts:171

hasMaxZoom

hasMaxZoom(): boolean
Has a maximum zoom level

Returns
true if has a maximum, false if unbounded

Returns boolean
- Defined in lib/Labeler.ts:122

isEnabled

isEnabled(): boolean
Is the grid enabled

Returns
enabled flag

Returns boolean
- Defined in lib/Labeler.ts:75

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/Labeler.ts:143

setBuffer

setBuffer(buffer: number): void
Set the grid edge buffer
Parameters
- buffer: number
  
  buffer (greater than or equal to 0.0 and less than 0.5)
Returns void
- Defined in lib/Labeler.ts:200

setColor

setColor(color?: Color): void
Set the label color
Parameters
- Optional color: Color
  
  label color
Returns void
- Defined in lib/Labeler.ts:162

setEnabled

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

setMaxZoom

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

setMinZoom

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

setTextSize

setTextSize(textSize: number): void
Set the label text size
Parameters
- textSize: number
  
  label text size
Returns void
- Defined in lib/Labeler.ts:181

Generated using TypeDoc