map

Available for:Map Panel

Methods

Name Summary
center

Centers the map.

getCurrentZoomLevel

Returns current zoom level.

getMode

Returns map mode.

getZoomLevels

Returns zoom levels.

info

Returns information about the map.

pan

Pans the map.

refresh

Reloads all layers with performing a new data request (GetMap, GetTile, GetFeatures).

setZoomLevels

Returns map mode.

transform

Transform.

zoom

Zooms the map.

Methods • Details

center(config, callback, errback) → {void}

Available for:Map Panel

Centers the map.

Parameters

Name Type Description
config Object
{
 "x": Number,
 "y": Number,
 "animationTime": Number,
 "token": Object
}

Configuration parameters

x optional

Easting coordinate of the map central point expressed in current CRS (Longitude)

y optional

Northing coordinate of the map central point expressed in current CRS (Latitude)

animationTime optional

Default value: 0.

3D only Animation time in miliseconds

token optional

Default value: "API".

Any object that will be returned in mapMoved event

callback optional

Callback executed on success

errback optional

Callback executed on failure

Returns

TypeDescription
void

getCurrentZoomLevel(callback) → {void}

deprecated
Available for:Map Panel

Returns current zoom level.

Parameters

Name Type Description
callback optional

Callback executed on success

Returns

TypeDescription
void

getMode(callback) → {void}

Available for:Map Panel

Returns map mode.

Parameters

Name Type Description
callback

Callback executed on success

Returns

TypeDescription
void

getZoomLevels(callback) → {void}

deprecated
Available for:Map Panel

Returns zoom levels.

Parameters

Name Type Description
callback optional

Callback executed on success

Returns

TypeDescription
void

info(callback) → {void}

Available for:Map Panel

Returns information about the map.

Parameters

Name Type Description
callback

Callback executed on success

Returns

TypeDescription
void

pan(config, callback, errback) → {void}

Available for:Map Panel

Pans the map.

Parameters

Name Type Description
config Object|Array.<Number>
{
 "x": Number,
 "y": Number,
 "animationTime": Number,
 "token": Object
}

Configuration parameters or array of vector endpoint coordinates in current CRS units

x optional

Easting vector in current CRS units

y optional

Northing vector in current CRS units

animationTime optional

Default value: 0.

3D only Animation time in miliseconds

token optional

Default value: "API".

Any object that will be returned in mapMoved event

callback optional

Callback executed on success

errback optional

Callback executed on failure

Returns

TypeDescription
void

refresh() → {void}

Available for:Map Panel

Reloads all layers with performing a new data request (GetMap, GetTile, GetFeatures).

Returns

TypeDescription
void

setZoomLevels(callback) → {void}

deprecated
Available for:Map Panel

Returns map mode.

Parameters

Name Type Description
callback optional

Callback executed on success

resul Array.<Number>

Array with minimal and maximal zoom levels. [minZoom, maxZoom]

Returns

TypeDescription
void

transform(config, callback, errback) → {void}

Available for:Map Panel

Transform.

Parameters

Name Type Description
config Object
{
 "offsetX": Number,
 "offsetY": Number,
 "x": Number,
 "y": Number,
 "yaw": Number,
 "pitch": Number,
 "roll": Number,
 "minX": Number,
 "minY": Number,
 "maxX": Number,
 "maxY": Number,
 "height": Number,
 "zoomFactor": Number,
 "animationTime": Number,
 "token": Object
}

Configuration parameters

offsetX optional

Offset X

offsetY optional

Offset Y

x optional

Point Y

y optional

Point X

yaw optional

3D only 3D Camera Yaw

pitch optional

3D only 3D Camera Pitch

roll optional

3D only 3D Camera Roll

minX optional

Min X

minY optional

Min Y

maxX optional

Max X

maxY optional

Max Y

height optional

Height above sea level

zoomFactor optional

Zoom factor

animationTime optional

Default value: 0.

3D only Animation time in miliseconds

token optional

Default value: "API".

Any object that will be returned in mapMoved event

callback optional

Callback executed on success

errback optional

Callback executed on failure

Returns

TypeDescription
void

zoom(config, callback, errback) → {void}

Available for:Map Panel

Zooms the map.

Parameters

Name Type Description
config Object|Array.<Number>|Number
{
 "bbox": Array.<Number>,
 "zoomFactor": Number,
 "height": Number,
 "x": Number,
 "y": Number,
 "animationTime": Number,
 "token": Object
}

Configuration parameters, BBOX (4 numbers array) or zoomFactor (number)

bbox optional

BBOX

zoomFactor optional

Zoom factor

height optional

Height above sea level

x optional

Point X

y optional

Point Y

animationTime optional

Default value: 0.

3D only Animation time in miliseconds

token optional

Default value: "API".

Any object that will be returned in mapMoved event

callback optional

Callback executed on success

errback optional

Callback executed on failure

Returns

TypeDescription
void