SnapGridManager class

Package:

azure-maps-drawing-tools

Manages a pixel based grid for snapping positions at integer based zoom levels.

Constructors

SnapGridManager(azmaps.Map, SnapGridManagerOptions)

Manages a pixel based grid for snapping positions at integer based zoom levels.

Methods

dispose()	Disposes the manager.
getGridLayer()	Gets the line layer used to render the grid lines.
getOptions()	Gets the options used by the SnapGridManager.
setOptions(SnapGridManagerOptions)	Sets the options of the snap grid manager.
snapPositions(azmaps.data.Position[], number)	Snaps an array of positions to the grid. If optimize is set, duplicate sequential positions will be removed from the shape.
snapShape(azmaps, number)	Snaps a Shape or GeoJSON feature coordinates to the grid.

Constructor Details

SnapGridManager(azmaps.Map, SnapGridManagerOptions)

Manages a pixel based grid for snapping positions at integer based zoom levels.

new SnapGridManager(map: azmaps.Map, options?: SnapGridManagerOptions)

Parameters

map

azmaps.Map

The map to attache the snap grid manager to.

options

SnapGridManagerOptions

Options to apply to the snap grid manager.

Method Details

dispose()

Disposes the manager.

function dispose()

getGridLayer()

Gets the line layer used to render the grid lines.

function getGridLayer(): azmaps.layer.LineLayer

Returns

azmaps.layer.LineLayer

A line layer used to render the grid lines.

getOptions()

Gets the options used by the SnapGridManager.

function getOptions(): SnapGridManagerOptions

Returns

SnapGridManagerOptions

setOptions(SnapGridManagerOptions)

Sets the options of the snap grid manager.

function setOptions(options: SnapGridManagerOptions)

Parameters

options

SnapGridManagerOptions

Options to set.

snapPositions(azmaps.data.Position[], number)

Snaps an array of positions to the grid. If optimize is set, duplicate sequential positions will be removed from the shape.

function snapPositions(positions: azmaps.data.Position[], zoom?: number): azmaps.data.Position[]

Parameters

positions

azmaps.data.Position[]

The positions to snap.

zoom

number

Optionally specify which zoom level to optimize the snapping for. If not specified, the map's zoom level will be used.

Returns

azmaps.data.Position[]

A new array of snapped positions.

snapShape(azmaps, number)

Snaps a Shape or GeoJSON feature coordinates to the grid.

function snapShape(shape: azmaps, zoom?: number)

Parameters

shape

azmaps

A shape or GeoJSON feature to snap.

zoom

number

Optionally specify which zoom level to optimize the snapping for. If not specified, the maps zoom level will be used.