Class Grids

Grids

Hierarchy

BaseGrids<Grid, ZoomGrids>
- Grids

Index

Constructors

Properties

Constructors

constructor

new Grids(types?: GridType[]): Grids
Constructor
Parameters
- Optional types: GridType[]
  
  grid types to enable
Returns Grids
Overrides BaseGrids<Grid, ZoomGrids>.constructor
- Defined in lib/grid/Grids.ts:47

Properties

`Protected` `Readonly` properties

properties: GridProperties

Grid properties

Methods

`Protected` createZoomGrids

createZoomGrids(): void
Create the zoom level grids

Returns void
Inherited from BaseGrids.createZoomGrids
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:108

deletePropagatedStyles

deletePropagatedStyles(types?: GridType[]): void
Delete propagated styles for the grid types
Parameters
- Optional types: GridType[]
  
  grid types
Returns void
- Defined in lib/grid/Grids.ts:435

disable

disable(grid: Grid): void
Disable the grid
Parameters
- grid: Grid
  
  grid
Returns void
Inherited from BaseGrids.disable
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:152

disableAllLabelers

disableAllLabelers(): void
Disable all grid labelers

Returns void
- Defined in lib/grid/Grids.ts:529

disableByType

disableByType(type: GridType): void
Disable the grid type
Parameters
- type: GridType
  
  grid type
Returns void
- Defined in lib/grid/Grids.ts:343

disableGrids

disableGrids(grids: Grid[]): void
Disable grids
Parameters
- grids: Grid[]
  
  grids
Returns void
Inherited from BaseGrids.disableGrids
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:138

disableLabeler

disableLabeler(type: GridType): void
Disable the grid type labeler
Parameters
- type: GridType
  
  grid type
Returns void
- Defined in lib/grid/Grids.ts:585

disableLabelers

disableLabelers(types: GridType[]): void
Disable the labelers for the grid types
Parameters
- types: GridType[]
  
  grid types
Returns void
- Defined in lib/grid/Grids.ts:551

disableTypes

disableTypes(types: GridType[]): void
Disable grid types
Parameters
- types: GridType[]
  
  grid types
Returns void
- Defined in lib/grid/Grids.ts:310

enable

enable(grid: Grid): void
Enable the grid
Parameters
- grid: Grid
  
  grid
Returns void
Inherited from BaseGrids.enable
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:145

enableAllLabelers

enableAllLabelers(): void
Enable all grid labelers

Returns void
Inherited from BaseGrids.enableAllLabelers
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:203

enableByType

enableByType(type: GridType): void
Enable the grid type
Parameters
- type: GridType
  
  grid type
Returns void
- Defined in lib/grid/Grids.ts:333

enableGrids

enableGrids(grids: Grid[]): void
Enable grids
Parameters
- grids: Grid[]
  
  grids
Returns void
Inherited from BaseGrids.enableGrids
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:131

enableLabeler

enableLabeler(type: GridType): void
Enable the grid type labeler
Parameters
- type: GridType
  
  grid type
Returns void
- Defined in lib/grid/Grids.ts:575

enableLabelers

enableLabelers(types: GridType[]): void
Enable the labelers for the grid types
Parameters
- types: GridType[]
  
  grid types
Returns void
- Defined in lib/grid/Grids.ts:539

enableTypes

enableTypes(types: GridType[]): void
Enable grid types
Parameters
- types: GridType[]
  
  grid types
Returns void
- Defined in lib/grid/Grids.ts:298

getDefaultWidth

getDefaultWidth(): number
{@inheritDoc}

Returns number
Overrides BaseGrids.getDefaultWidth
- Defined in lib/grid/Grids.ts:68

getGrid

getGrid(type: GridType): undefined | Grid
Get the grid

Returns
grid
Parameters
- type: GridType
  
  grid type
Returns undefined | Grid
- Defined in lib/grid/Grids.ts:233

`Protected` getGridStyle

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

Returns
grid style
Parameters
- grid: Grid
  
  grid
- Optional color: Color
  
  color
- Optional width: number
  
  width
Returns GridStyle
Inherited from BaseGrids.getGridStyle
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:104

getGrids

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

Returns
grids
Parameters
- zoom: number
  
  zoom level
Returns undefined | ZoomGrids
Inherited from BaseGrids.getGrids
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:116

getLabelBuffer

getLabelBuffer(type: GridType): number
Get the label grid edge buffer

Returns
label buffer (greater than or equal to 0.0 and less than 0.5)
Parameters
- type: GridType
  
  grid type
Returns number
- Defined in lib/grid/Grids.ts:680

getLabeler

getLabeler(type: GridType): GridLabeler
Get the labeler for the grid type

Returns
labeler or null
Parameters
- type: GridType
  
  grid type
Returns GridLabeler
- Defined in lib/grid/Grids.ts:499

getPrecision

getPrecision(zoom: number): undefined | GridType
Get the grid precision for the zoom level

Returns
grid type precision
Parameters
- zoom: number
  
  zoom level
Returns undefined | GridType
- Defined in lib/grid/Grids.ts:244

grids

grids(): Grid[]
{@inheritDoc}

Returns Grid[]
Overrides BaseGrids.grids
- Defined in lib/grid/Grids.ts:75

hasLabeler

hasLabeler(type: GridType): boolean
Has a labeler for the grid type

Returns
true if has labeler
Parameters
- type: GridType
  
  grid type
Returns boolean
- Defined in lib/grid/Grids.ts:510

isEnabled

isEnabled(type: GridType): boolean
Is the grid type enabled

Returns
true if enabled
Parameters
- type: GridType
  
  grid type
Returns boolean
- Defined in lib/grid/Grids.ts:323

isLabelerEnabled

isLabelerEnabled(type: GridType): boolean
Is a labeler enabled for the grid type

Returns
true if labeler enabled
Parameters
- type: GridType
  
  grid type
Returns boolean
- Defined in lib/grid/Grids.ts:564

`Protected` loadGrid

loadGrid(grid: Grid, gridKey: string, labeler: Labeler, enabled?: boolean): void
Load the grid
Parameters
- grid: Grid
  
  name
- gridKey: string
  
  grid name key
- labeler: Labeler
  
  grid labeler
- Optional enabled: boolean
  
  enable created grids
Returns void
Inherited from BaseGrids.loadGrid
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:63

`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
Inherited from BaseGrids.loadGridStyleColor
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:82

`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
Inherited from BaseGrids.loadGridStyleWidth
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:92

`Protected` newGrid

newGrid(type: GridType): Grid
Create a new grid, override to create a specialized grid

Returns
grid
Parameters
- type: GridType
  
  grid type
Returns Grid
- Defined in lib/grid/Grids.ts:92

`Protected` newZoomGrids

newZoomGrids(zoom: number): ZoomGrids
{@inheritDoc}
Parameters
- zoom: number
Returns ZoomGrids
Overrides BaseGrids.newZoomGrids
- Defined in lib/grid/Grids.ts:99

setAllColors

setAllColors(color: Color): void
Set all grid line colors
Parameters
- color: Color
  
  grid line color
Returns void
- Defined in lib/grid/Grids.ts:415

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

setAllLabelColors

setAllLabelColors(color: Color): void
Set all label colors
Parameters
- color: Color
  
  label color
Returns void
- Defined in lib/grid/Grids.ts:690

setAllLabelTextSizes

setAllLabelTextSizes(textSize: number): void
Set all label text sizes
Parameters
- textSize: number
  
  label text size
Returns void
- Defined in lib/grid/Grids.ts:718

setAllWidths

setAllWidths(width: number): void
Set all grid line widths
Parameters
- width: number
  
  grid line width
Returns void
- Defined in lib/grid/Grids.ts:425

setColor

setColor(types: GridType[], color: Color, precisionTypes?: GridType[]): void
Set the grid type precision line color for the grid types
Parameters
- types: GridType[]
  
  grid types
- color: Color
  
  grid line color
- Optional precisionTypes: GridType[]
  
  precision grid types
Returns void
- Defined in lib/grid/Grids.ts:454

setGridTypes

setGridTypes(types: GridType[]): void
Set the active grid types
Parameters
- types: GridType[]
  
  grid types
Returns void
- Defined in lib/grid/Grids.ts:259

setGrids

setGrids(grids: Grid[]): void
Set the active grids
Parameters
- grids: Grid[]
  
  grids
Returns void
- Defined in lib/grid/Grids.ts:279

setLabelBuffer

setLabelBuffer(buffer: number, types: GridType[]): void
Set the label grid edge buffer for the grid types
Parameters
- buffer: number
  
  label buffer (greater than or equal to 0.0 and less than 0.5)
- types: GridType[]
  
  grid types
Returns void
- Defined in lib/grid/Grids.ts:667

setLabelColor

setLabelColor(color: Color, types: GridType[]): void
Set the label color for the grid types
Parameters
- color: Color
  
  label color
- types: GridType[]
  
  grid types
Returns void
- Defined in lib/grid/Grids.ts:706

setLabelMaxZoom

setLabelMaxZoom(type: GridType, maxZoom: number): void
Set the grid maximum zoom
Parameters
- type: GridType
  
  grid type
- maxZoom: number
  
  maximum zoom
Returns void
- Defined in lib/grid/Grids.ts:632

setLabelMinZoom

setLabelMinZoom(type: GridType, minZoom: number): void
Set the grid minimum zoom
Parameters
- type: GridType
  
  grid type
- minZoom: number
  
  minimum zoom
Returns void
- Defined in lib/grid/Grids.ts:615

setLabelTextSize

setLabelTextSize(textSize: number, types: GridType[]): void
Set the label text size for the grid types
Parameters
- textSize: number
  
  label text size
- types: GridType[]
  
  grid types
Returns void
- Defined in lib/grid/Grids.ts:734

setLabelZoomRange

setLabelZoomRange(type: GridType, minZoom: number, maxZoom: number): void
Set the grid zoom range
Parameters
- type: GridType
  
  grid type
- minZoom: number
  
  minimum zoom
- maxZoom: number
  
  maximum zoom
Returns void
- Defined in lib/grid/Grids.ts:650

setLabeler

setLabeler(type: GridType, labeler: GridLabeler): void
Set the labeler for the grid type
Parameters
- type: GridType
  
  grid type
- labeler: GridLabeler
  
  labeler
Returns void
- Defined in lib/grid/Grids.ts:522

setLinesMaxZoom

setLinesMaxZoom(type: GridType, maxZoom?: number): void
Set the grid maximum level override for drawing grid lines
Parameters
- type: GridType
  
  grid type
- Optional maxZoom: number
  
  maximum zoom level or null to remove
Returns void
- Defined in lib/grid/Grids.ts:405

setLinesMinZoom

setLinesMinZoom(type: GridType, minZoom: number): void
Set the grid minimum level override for drawing grid lines
Parameters
- type: GridType
  
  grid type
- minZoom: number
  
  minimum zoom level or null to remove
Returns void
- Defined in lib/grid/Grids.ts:393

setMaxZoom

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

setMaxZoomByType

setMaxZoomByType(type: GridType, maxZoom: number): void
Set the grid maximum zoom
Parameters
- type: GridType
  
  grid type
- maxZoom: number
  
  maximum zoom
Returns void
- Defined in lib/grid/Grids.ts:367

setMinZoom

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

setMinZoomByType

setMinZoomByType(type: GridType, minZoom: number): void
Set the grid minimum zoom
Parameters
- type: GridType
  
  grid type
- minZoom: number
  
  minimum zoom
Returns void
- Defined in lib/grid/Grids.ts:355

setWidth

setWidth(types: GridType[], width: number, precisionTypes?: GridType[]): void
Set the grid type precision line width for the grid types
Parameters
- types: GridType[]
  
  grid types
- width: number
  
  grid line width
- Optional precisionTypes: GridType[]
Returns void
- Defined in lib/grid/Grids.ts:478

setZoomRange

setZoomRange(grid: Grid, minZoom: number, maxZoom?: number): void
Set the grid zoom range
Parameters
- grid: Grid
  
  grid
- minZoom: number
  
  minimum zoom
- Optional maxZoom: number
  
  maximum zoom
Returns void
Inherited from BaseGrids.setZoomRange
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseGrids.d.ts:181

setZoomRangeByType

setZoomRangeByType(type: GridType, minZoom: number, maxZoom: number): void
Set the grid zoom range
Parameters
- type: GridType
  
  grid type
- minZoom: number
  
  minimum zoom
- maxZoom: number
  
  maximum zoom
Returns void
- Defined in lib/grid/Grids.ts:381

`Static` create

create(types?: GridType[]): Grids
Create with grids to enable

Returns
grids
Parameters
- Optional types: GridType[]
  
  grid types to enable
Returns Grids
- Defined in lib/grid/Grids.ts:28

`Static` createGZD

createGZD(): Grids
Create only Grid Zone Designator grids

Returns
grids

Returns Grids
- Defined in lib/grid/Grids.ts:37

Generated using TypeDoc