Class ZoomGrids

Zoom Level Matching Grids

Hierarchy

BaseZoomGrids<Grid>
- ZoomGrids

Index

Constructors

Properties

Methods

[iterator] addGrid getGrids getPrecision getZoom hasGrids next numGrids removeGrid reset

Constructors

constructor

new ZoomGrids(zoom: number): ZoomGrids
Constructor
Parameters
- zoom: number
  
  zoom level
Returns ZoomGrids
Overrides BaseZoomGrids<Grid>.constructor
- Defined in lib/grid/ZoomGrids.ts:17

Properties

`Protected` `Readonly` grids

grids: TreeSet<Grid>

Grids

Methods

[iterator]

[iterator](): IterableIterator<Grid>
Returns IterableIterator<Grid>
Inherited from BaseZoomGrids.__@iterator@56
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseZoomGrids.d.ts:68

addGrid

addGrid(grid: Grid): boolean
Add a grid

Returns
true if added
Parameters
- grid: Grid
  
  grid
Returns boolean
Inherited from BaseZoomGrids.addGrid
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseZoomGrids.d.ts:57

getGrids

getGrids(): TreeSet<Grid>
Get the grids within the zoom level

Returns
grids

Returns TreeSet<Grid>
Inherited from BaseZoomGrids.getGrids
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseZoomGrids.d.ts:37

getPrecision

getPrecision(): undefined | GridType
Get the grid type precision

Returns
grid type precision

Returns undefined | GridType
- Defined in lib/grid/ZoomGrids.ts:26

getZoom

getZoom(): number
Get the zoom level

Returns
zoom level

Returns number
Inherited from BaseZoomGrids.getZoom
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseZoomGrids.d.ts:31

hasGrids

hasGrids(): boolean
Determine if the zoom level has grids

Returns
true if has grids

Returns boolean
Inherited from BaseZoomGrids.hasGrids
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseZoomGrids.d.ts:49

next

next(): IteratorResult<Grid, any>
Returns IteratorResult<Grid, any>
Inherited from BaseZoomGrids.next
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseZoomGrids.d.ts:66

numGrids

numGrids(): number
Get the number of grids

Returns
number of grids

Returns number
Inherited from BaseZoomGrids.numGrids
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseZoomGrids.d.ts:43

removeGrid

removeGrid(grid: Grid): boolean
Remove the grid

Returns
true if removed
Parameters
- grid: Grid
  
  grid
Returns boolean
Inherited from BaseZoomGrids.removeGrid
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseZoomGrids.d.ts:65

reset

reset(): void
Returns void
Inherited from BaseZoomGrids.reset
- Defined in node_modules/@ngageoint/grid-js/dist/lib/BaseZoomGrids.d.ts:67

Generated using TypeDoc