Last updated

API / geotoolkit / map / Map / Map

Namespace: Map

map.Map.Map

Table of contents

Type Aliases

Contents

Type Aliases

EventMap

Ƭ EventMap: EventMap & { LayerAdded: AbstractLayer[] ; LayerRemoved: AbstractLayer[] ; LayersModified: AbstractLayer[] ; onDoubleClick: ZoomEventArgs ; onResize: Rect ; onZoomEnd: ZoomEventArgs ; onZoomStart: ZoomEventArgs }


FlyToOptions

Ƭ FlyToOptions: Object

animation fly options

Type declaration

NameTypeDescription
callback?(status: FlyStatus) => voidcallback to be called when fly is over. Receives FlyStatus enum to check if animation was finished or interrupted by user actions.
duration?numberpositive fly duration (in ms)
easing?Functionseasing function for viewport change
level?numberfinal point zoom level (see .setZoomLevel for more info). Has less priority than 'scale', if both provided.
location?Point | Options | [number, number] | Point[] | Options[]final point location. May be a point, an array ([x, y]), coordinates object of the form {x: x, y: y}, or array of such locations to move along the corresponding trajectory
scale?numberfinal point scale (see .setMapScale for more info)
system?GeodeticSystem | AbstractSystemcoordinate system for the location coordinates. Latitude/longitude is used by default.

Options

Ƭ Options: Options & OptionsBase & { bounds?: Rect ; layerscontainer?: Group<AbstractLayer> ; model?: Group ; system?: GeodeticSystem | AbstractSystem ; tooltip?: { alignment?: AnchorType ; autoflip?: boolean ; autoupdate?: boolean ; delay?: number | null ; divelement?: HTMLElement ; fadeduration?: number | null ; hidedelay?: number | null ; max?: number ; mode?: PointerMode | string ; offsetx?: number ; offsety?: number ; showdelay?: number | null } ; viewcache?: boolean ; viewcacheasync?: boolean ; viewcachememorylimit?: number ; viewcachemode?: CacheMode ; viewcachesize?: { height?: number ; width?: number } ; wrapped?: boolean }

Data passed in


OptionsBase

Ƭ OptionsBase: Object

options

Type declaration

NameTypeDescription
mapimage?Imageimage to be displayed locked at the bottom right of the map
maplimits?Rectlimits of the map
mapscale?numbersets the initial map scale
mapscaleobject?MapScaleMapScale information to be locked at the bottom left of the map
scaleunit?AbstractUnit | stringscale unit
webmap?string | ObjectTypethe ArcGIS WebMap server url or WebMap JSON settings object. The old webmap layers will be removed. if the url equals to loaded webmap url then nothing happens.
webmapservice?AbstractHttpServiceHttp service to be used for the WebMap server
zoom?{ easing?: Functions ; max?: number ; min?: number ; speed?: number ; time?: number }map zoom options
zoom.easing?Functionseasing animation function for elastic zooming
zoom.max?numbermaximum zoom limit (i.e. '500' value means user cannot zoom-out after 1:500 scale - 500 meters in 1 pixel). Scale is counted on the equator (by .getMapScale() method), so it can be different with the actual scale on current parallel
zoom.min?numberminimum zoom limit (i.e. '100' value means user cannot zoom-in after 1:100 scale - 100 meters in 1 pixel). Scale is counted on the equator (by .getMapScale() method), so it can be different with the actual scale on current parallel
zoom.speed?numberzoom speed (e.g. 2 means that zoom-in brings the map x2 times closer)
zoom.time?numberzoom time in milliseconds (set to 0 for instant zoom)

Tools

Ƭ Tools: { measure: Measure ; polygon-selection: PolygonSelection ; tooltip: ToolTipTool } & Tools