Class GridLabeler`Abstract`

Grid Labeler

Hierarchy

Labeler
- GridLabeler
  - MGRSLabeler
  - GZDLabeler

Index

Constructors

constructor

new GridLabeler(enabled: boolean, minZoom?: number, maxZoom: undefined | number, color?: Color, textSize?: undefined | number, buffer?: undefined | number): GridLabeler
Parameters
- enabled: boolean
- minZoom: number = 0
- maxZoom: undefined | number
- color: Color = ...
- textSize: undefined | number = GridLabeler.DEFAULT_TEXT_SIZE
- buffer: undefined | number = GridLabeler.DEFAULT_BUFFER
Returns GridLabeler
Overrides Labeler.constructor
- Defined in lib/grid/GridLabeler.ts:30

Properties

`Static` `Readonly` DEFAULT_BUFFER

DEFAULT_BUFFER: undefined | number = ...

Default buffer size

`Static` `Readonly` DEFAULT_TEXT_SIZE

DEFAULT_TEXT_SIZE: undefined | number = ...

Default text size

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
Inherited from Labeler.getBuffer
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:132

getColor

getColor(): undefined | Color
Get the label color

Returns
label color

Returns undefined | Color
Inherited from Labeler.getColor
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:106

`Abstract` getLabels

getLabels(gridType: GridType, zone: GridZone, tileBounds?: Bounds): undefined | GridLabel[]
Get labels for the bounds

Returns
labels
Parameters
- gridType: GridType
  
  grid type
- zone: GridZone
  
  grid zone *
- Optional tileBounds: Bounds
  
  tile bounds
Returns undefined | GridLabel[]
- Defined in lib/grid/GridLabeler.ts:52

getMaxZoom

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

Returns
maximum zoom level

Returns undefined | number
Inherited from Labeler.getMaxZoom
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:79

getMinZoom

getMinZoom(): number
Get the minimum zoom level

Returns
minimum zoom level

Returns number
Inherited from Labeler.getMinZoom
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:66

getTextSize

getTextSize(): number
Get the label text size

Returns
label text size

Returns number
Inherited from Labeler.getTextSize
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:119

hasMaxZoom

hasMaxZoom(): boolean
Has a maximum zoom level

Returns
true if has a maximum, false if unbounded

Returns boolean
Inherited from Labeler.hasMaxZoom
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:85

isEnabled

isEnabled(): boolean
Is the grid enabled

Returns
enabled flag

Returns boolean
Inherited from Labeler.isEnabled
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:53

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
Inherited from Labeler.isWithin
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:100

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
Inherited from Labeler.setBuffer
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:139

setColor

setColor(color?: Color): void
Set the label color
Parameters
- Optional color: Color
  
  label color
Returns void
Inherited from Labeler.setColor
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:113

setEnabled

setEnabled(enabled: boolean): void
Set the enabled flag
Parameters
- enabled: boolean
  
  enabled flag
Returns void
Inherited from Labeler.setEnabled
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:60

setMaxZoom

setMaxZoom(maxZoom?: number): void
Set the maximum zoom level
Parameters
- Optional maxZoom: number
  
  maximum zoom level
Returns void
Inherited from Labeler.setMaxZoom
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:92

setMinZoom

setMinZoom(minZoom: number): void
Set the minimum zoom level
Parameters
- minZoom: number
  
  minimum zoom level
Returns void
Inherited from Labeler.setMinZoom
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:73

setTextSize

setTextSize(textSize: number): void
Set the label text size
Parameters
- textSize: number
  
  label text size
Returns void
Inherited from Labeler.setTextSize
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:126

Class GridLabelerAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

enabled: boolean

minZoom: number = 0

maxZoom: undefined | number

color: Color = ...

textSize: undefined | number = GridLabeler.DEFAULT_TEXT_SIZE

buffer: undefined | number = GridLabeler.DEFAULT_BUFFER

Returns GridLabeler

Properties

Static Readonly DEFAULT_BUFFER

Static Readonly DEFAULT_TEXT_SIZE

Methods

getBuffer

Returns

Returns number

getColor

Returns

Returns undefined | Color

Abstract getLabels

Returns

Parameters

gridType: GridType

zone: GridZone

Optional tileBounds: Bounds

Returns undefined | GridLabel[]

getMaxZoom

Returns

Returns undefined | number

getMinZoom

Returns

Returns number

getTextSize

Returns

Returns number

hasMaxZoom

Returns

Returns boolean

isEnabled

Returns

Returns boolean

isWithin

Returns

Parameters

zoom: number

Returns boolean

setBuffer

Parameters

buffer: number

Returns void

setColor

Parameters

Optional color: Color

Returns void

setEnabled

Parameters

enabled: boolean

Returns void

setMaxZoom

Parameters

Optional maxZoom: number

Returns void

setMinZoom

Parameters

minZoom: number

Returns void

setTextSize

Parameters

textSize: number

Returns void

Settings

Member Visibility

Theme

Class GridLabeler`Abstract`

`Static` `Readonly` DEFAULT_BUFFER

`Static` `Readonly` DEFAULT_TEXT_SIZE

`Abstract` getLabels

`Optional` tileBounds: Bounds

`Optional` color: Color

`Optional` maxZoom: number