Last updated

API / geotoolkit / map / util / WebMap / WebMap

Class: WebMap

util.WebMap.WebMap

ArcGIS Web Map layers parser

Table of contents

Constructors
Methods

Contents

Constructors

new WebMap(options)

Protected new WebMap(options?)

Creates WebMap

Parameters

Name Type Description
Optional optionsOptionsoptions
Methods

getClassName

getClassName(): string

Returns

string


load

load(map, webmap): Promise<AbstractLayer[]>

Loads WebMap layers from the server and adds them to the map. When all added layers are loaded, the returned promise is resolved.

Parameters

Name Type Description
mapMapthe map widget for the result
webmapstring | ObjectTypethe ArcGIS WebMap server url or WebMap JSON settings object

Returns

Promise<AbstractLayer[]>


getClassName

Static getClassName(): string

Returns

string


getInstance

Static getInstance(options?): WebMap

Return instance of WebMap

Parameters

Name Type Description
Optional optionsOptionsoptions. if options is passed, a new instance is created

Returns

WebMap

new instance


load

Static load(map, webmap, httpservice?): Promise<AbstractLayer[]>

Loads WebMap layers from the server and adds them to the map. When all added layers are loaded, the returned promise is resolved.

Parameters

Name Type Description
mapMapthe map widget for the result
webmapstring | ObjectTypethe ArcGIS WebMap server url or WebMap JSON settings object
Optional httpserviceAbstractHttpServicehttp service to use for the webmap server

Returns

Promise<AbstractLayer[]>


setBingMapsKey

Static setBingMapsKey(key): void

Sets the Bing Maps API key to use in the Webmap-created Bing layers. Get yours key at http://www.bingmapsportal.com/

Parameters

Name Type Description
keystringBing Maps API key

Returns

void


setHttpRequestService

Static setHttpRequestService(service): void

Sets the default httpservice to use in Webmap requests if no widget-specific service is provided.

Parameters

Name Type Description
serviceAbstractHttpServicehttp service to be used by default

Returns

void