Class GARSLabeler

GARS grid labeler

Hierarchy

GridLabeler
- GARSLabeler

Index

Constructors

Properties

DEFAULT_BUFFER DEFAULT_TEXT_SIZE

Methods

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

Constructors

constructor

new GARSLabeler(enabled: boolean, minZoom?: number, maxZoom?: number, color?: Color, textSize?: number, buffer?: number): GARSLabeler
Parameters
- enabled: boolean
- minZoom: number = 0
- Optional maxZoom: number
- Optional color: Color
- Optional textSize: number
- Optional buffer: number
Returns GARSLabeler
Overrides GridLabeler.constructor
- Defined in lib/grid/GARSLabeler.ts:15

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 GridLabeler.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 GridLabeler.getColor
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:106

getLabels

getLabels(tileBounds: Bounds, gridType: GridType): GridLabel[]
{@inheritDoc}
Parameters
- tileBounds: Bounds
- gridType: GridType
Returns GridLabel[]
Overrides GridLabeler.getLabels
- Defined in lib/grid/GARSLabeler.ts:22

getMaxZoom

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

Returns
maximum zoom level

Returns undefined | number
Inherited from GridLabeler.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 GridLabeler.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 GridLabeler.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 GridLabeler.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 GridLabeler.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 GridLabeler.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 GridLabeler.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 GridLabeler.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 GridLabeler.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 GridLabeler.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 GridLabeler.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 GridLabeler.setTextSize
- Defined in node_modules/@ngageoint/grid-js/dist/lib/Labeler.d.ts:126

Generated using TypeDoc