itemUtils

November 12, 2019 ยท View on GitHub

A utility module containing common methods used to read, create and modify a PortalItem, WebMap, WebScene, MapView, or SceneView.

Methods

getConfigViewProperties(config: ApplicationConfig): Object

Returns the view poperties defined from an ApplicationConfig.

createMapFromItem(options: CreateMapFromItemOptions): Promise<WebMap | WebScene>

Creates a WebMap or WebScene from a PortalItem. You can optionally replace the WebMap's or WebScene's layer URLs by passing appProxies.

CreateMapFromItemOptions

propertydescriptiontype
itemA WebMap or WebScene itemPortalItem
appProxies?A list of application proxies to applyApplicationProxy[]

createWebMapFromItem(options: CreateMapFromItemOptions): Promise<WebMap>

Creates a WebMap from a PortalItem. You can optionally replace the WebMap's layer URLs by passing appProxies.

createWebSceneFromItem(options: CreateMapFromItemOptions): Promise<WebScene>

Creates a WebScene from a PortalItem. You can optionally replace the WebScene's layer URLs by passing appProxies.

createView(properties: any): Promise<MapView | SceneView>

Creates a MapView or SceneView with a WebMap or WebScene depending on the type of map it is.

getItemTitle(item: PortalItem): string

Returns the title of the PortalItem.

goToMarker(marker: string, view: MapView | SceneView): Promise<any>

Adds a Graphic marker and animates the view to its location if a marker string is defined.

findQuery(query: string, view: MapView | SceneView): Promise<any>

Finds a location by query string and animates to its geometry if a query string is defined.