Class WmsLayer

A layer class which implements an ESRI WMS Layer.

Hierarchy (view full)

Constructors

constructor

Properties

$iApi _drawOrder _lastFilterUpdate _mouseTolerance _parentLayer _scaleSet _serverVisibility _sublayers _touchTolerance canModifyLayer canReload config dataFormat drawState esriLayer esriSubLayer esriView esriWatches expectedTime extent featureCount fieldList fields geomType hovertips id identify identifyMode initiationState isCosmetic isFile isRemoved isSublayer lastCancel layerFormat layerIdx layerState layerTree layerType legend loadDefProm loadPromDone mapLayer mimeType name nameField oidField origRampConfig sourceSR sublayerNames supportsFeatures supportsIdentify supportsSublayers timers uid url userAdded viewDefProm

Accessors

$element $vApp drawOrder isLoaded layerExists mouseTolerance opacity parentLayer scaleSet sublayers touchTolerance visibility

Methods

abortAttributeLoad applySqlFilter attribLoadAborted canIdentify cancelLoad checkVisibility clearFeatureCache controlAvailable downloadedAttributes getAttributes getFeatureInfo getFieldsToTrim getFilterOIDs getGraphic getGraphicExtent getIcon getLayerTree getLegendUrls getSR getSqlFilter getTabularAttributes initiate isOffscale loadPromise loadSymbology makeEsriLayerConfig noLayerErr notLoadedErr onError onInitiate onLoad onLoadActions reload removeEsriLayer runIdentify setCustomParameter setSqlFilter startTimer stopTimer stubError terminate updateDrawState updateInitiationState updateLayerState zoomToLayerBoundary zoomToVisibleScale

Constructors

constructor

Properties

Readonly$iApi

$iApi: InstanceAPI

The instance of RampMap API scoped to a single Vue R4MP application.

Memberof

APIScope

_drawOrder

_drawOrder: DrawOrder[]

_lastFilterUpdate

_lastFilterUpdate: string = ''

_mouseTolerance

_mouseTolerance: number

Protected_parentLayer

_parentLayer: undefined | LayerInstance

_scaleSet

_scaleSet: ScaleSet

_serverVisibility

_serverVisibility: undefined | boolean

Protected_sublayers

_sublayers: LayerInstance[]

_touchTolerance

_touchTolerance: number

canModifyLayer

canModifyLayer: boolean

Indicates if the layer can be modified with filters.

canReload

canReload: boolean

Indicates if the layer can be reloaded.

config

config: any = {}

dataFormat

dataFormat: DataFormat

The type of spatial data used to generate layer content

drawState

drawState: DrawState

State of drawing / refreshing data for a layer

esriLayer

esriLayer: undefined | WMSLayer

The internal ESRI API layer

esriSubLayer

esriSubLayer: undefined | Sublayer

The internal ESRI API sublayer. Valid only by sublayers

esriView

esriView: undefined | LayerView

The internal ESRI API layer view

esriWatches

esriWatches: WatchHandle[]

expectedTime

expectedTime: LayerTimes

Object that contains values for the expected draw/response time.

extent

extent: undefined | Extent

The extent of the layer on the map

featureCount

featureCount: number

Feature count

fieldList

fieldList: string

Comma delimited string of field names (or '*' for all). Useful for numerous ESRI api calls. Non-feature layers will return empty string;

fields

fields: FieldDefinition[]

Array of field definitions about the given layer's fields. Non-feature layers will have empty arrays.

geomType

geomType: GeometryType

The geometry type of the layer.

hovertips

hovertips: boolean

If the layer should show hovertips on the map

id

id: string

ID of this layer. Also known as the layerId.

Memberof

LayerInstance

identify

identify: boolean

If the layer is set to participate in identify requests

identifyMode

identifyMode: LayerIdentifyMode

The type of logic used to identify items on the layer

initiationState

initiationState: InitiationState

State of the initiation / termination process of the layer

isCosmetic

isCosmetic: boolean

If the layer is non-interactive and only displays content on the map

isFile

isFile: boolean

If the layer was sourced from a file or a WFS source (which disconnects after load).

isRemoved

isRemoved: boolean

Tracks if layer is removed from map. Is false during the period "before" the layer gets added to map.

isSublayer

isSublayer: boolean

If the layer is a Sublayer

lastCancel

lastCancel: number

Timecode value for the start of most recent cancel request. Used to avoid races between async things returning after layers cancel or reload.

layerFormat

layerFormat: LayerFormat

How the layer is instantiated in the map stack

layerIdx

layerIdx: number

Index of the layer. Aligns to index of arcgis server source, or defaults to 0 on other layers. Map Image Layers and layers that do not support attributes have a value of -1

layerState

layerState: LayerState

State of the actual layer on the map, such as loading, loaded, error'd.

ProtectedlayerTree

layerTree: TreeNode

layerType

layerType: LayerType

Type of layer this is (describes the overall layer)

legend

legend: LegendSymbology[]

Legend symbols of the layer

ProtectedloadDefProm

loadDefProm: DefPromise<void>

ProtectedloadPromDone

loadPromDone: boolean

A boolean to track whether the promise is pending (false) or fulfilled/rejected (true)

mapLayer

mapLayer: boolean

If the layer type can exist on the map

ReadonlymimeType

mimeType: string

name

name: string

The name of the layer.

nameField

nameField: string

Field name that contains value considered the name of a feature. Not applicable for non-feature layers.

oidField

oidField: string

Field name that contains the object ID of a feature. Not applicable for non-feature layers.

ProtectedorigRampConfig

origRampConfig: RampLayerConfig

sourceSR

sourceSR: undefined | SpatialReference

The spatial reference of the source of geometry (e.g. map server). Undefined for non-ArcServer and non-spatial layers.

sublayerNames

sublayerNames: string[]

supportsFeatures

supportsFeatures: boolean

If the layer type can support Feature type requests and operations

supportsIdentify

supportsIdentify: boolean

If the layer type can support an identify request

supportsSublayers

supportsSublayers: boolean

If the layer has Sublayers

timers

timers: {
    draw: undefined | number;
    load: undefined | number;
}

Tracks load and draw elapsed time

uid

uid: string

Unique identifier for this layer. Randomly generated at runtime.

url

url: string

url of the service

userAdded

userAdded: boolean

If the layer was added by user interaction during the session

ProtectedviewDefProm

viewDefProm: DefPromise<void>

Accessors

$element

  • get $element(): App<Element>

  • Returns App<Element>

$vApp

  • get $vApp(): ComponentPublicInstance

  • The instance of Vue R4MP application controlled by this InstanceAPI. This is just a shorthand for this.$iApi.$vApp.

    Returns ComponentPublicInstance

    Memberof

    APIScope

drawOrder

isLoaded

  • get isLoaded(): boolean

  • Indicates if the layer is in a state that is makes sense to interact with. I.e. False if layer has not done it's initial load, or is in error state. Acts as a handy shortcut to inspecting the layerState.

    Returns boolean

    true if layer is loaded

    Method

    isLoaded

layerExists

  • get layerExists(): boolean

  • Indicates if the Esri map layer exists

    Returns boolean

mouseTolerance

  • get mouseTolerance(): number

  • Get the mouse tolerance in pixels for this layer

    Returns number

    the mouse tolerance of this layer

  • set mouseTolerance(tolerance): void

  • Set the mouse tolerance for this layer in pixels

    Parameters

    • tolerance: number

      the new mouse tolerance

    Returns void

opacity

  • get opacity(): number

  • Returns the opacity of the layer.

    Returns number

    opacity of the layer (range between 0 and 1)

  • set opacity(value): void

  • Applies opacity to layer.

    Parameters

    • value: number

      the new opacity setting (range between 0 and 1)

    Returns void

parentLayer

scaleSet

  • get scaleSet(): ScaleSet

  • Returns the scale set (min and max visible scale) of the layer.

    Returns ScaleSet

    scale set of the layer

  • set scaleSet(scaleSet): void

  • Set the scale set (min and max visible scale) of the layer.

    Parameters

    • scaleSet: ScaleSet

      the new scale set of the layer

    Returns void

sublayers

touchTolerance

  • get touchTolerance(): number

  • Get the touch tolerance in pixels for this layer

    Returns number

    the touch tolerance of this layer

  • set touchTolerance(tolerance): void

  • Set the touch tolerance in pixels for this layer

    Parameters

    • tolerance: number

      the new touch tolerance

    Returns void

visibility

  • get visibility(): boolean

  • Returns the visibility of the layer.

    Returns boolean

    visibility of the layer

  • set visibility(value): void

  • Applies visibility to layer.

    Parameters

    • value: boolean

      the new visibility setting

    Returns void

Methods

abortAttributeLoad

applySqlFilter

  • applySqlFilter(exclusions?): void

  • Applies the current filter settings to the physical map layer.

    Parameters

    • exclusions: string[] = []

      list of any filters to exclude from the result. omission includes all keys

    Returns void

    Function

    applySqlFilter

attribLoadAborted

canIdentify

cancelLoad

  • cancelLoad(): void

  • Cancels an in-progress initialize or load of the layer and places it in an Error state. Has no effect on a layer that is loaded, has been terminated, or never initiazed.

    Returns void

checkVisibility

clearFeatureCache

controlAvailable

downloadedAttributes

getAttributes

getFeatureInfo

  • getFeatureInfo(layerList, point, mimeType): Promise<any>

  • Handles click events for WMS layers (makes a WMS GetFeatureInfo call behind the scenes).

    Parameters

    • layerList: string[]

      a list of strings identifying the WMS sublayers to be queried

    • point: Point

      a RAMP Point indicating where the user clicked

    • mimeType: string

      the format to be requested for the response

    Returns Promise<any>

    a promise which resolves with the GetFeatureInfo response

getFieldsToTrim

getFilterOIDs

  • getFilterOIDs(exclusions?, extent?): Promise<undefined | number[]>

  • Gets array of object ids that currently pass any filters for the layer

    Parameters

    • exclusions: string[] = []

      list of any filters keys to exclude from the result. omission includes all filters

    • extent: undefined | Extent = undefined

      if provided, the result list will only include features intersecting the extent

    Returns Promise<undefined | number[]>

    resolves with array of object ids that pass the filter. if no filters are active, resolves with undefined.

getGraphic

  • getGraphic(objectId, options): Promise<Graphic>

  • Gets information on a graphic in the most efficient way possible. Options object properties:

    • getGeom ; a boolean to indicate if the result should include graphic geometry
    • getAttribs ; a boolean to indicate if the result should include graphic attributes
    • getStyle ; a boolean to indicate if the result should include symbol styling information

    Parameters

    • objectId: number

      the object id of the graphic to find

    • options: GetGraphicParams

      options object for the request, see above

    Returns Promise<Graphic>

    resolves with a Graphic containing the requested information

getGraphicExtent

  • getGraphicExtent(objectId): Promise<Extent>

  • Gets the extent where the provided object id is on the map. Can only be used on feature layers with multipoint, polyline, polygon geometry.

    Parameters

    • objectId: number

      the object id to query

    Returns Promise<Extent>

    resolves with the extent where the object id is present

getIcon

  • getIcon(objectId): Promise<string>

  • Gets the icon for a specific feature, as an SVG string.

    Parameters

    • objectId: number

      the object id of the feature to find

    Returns Promise<string>

    resolves with an svg string encoding of the icon

getLayerTree

getLegendUrls

  • getLegendUrls(layerList): string[]

  • Finds the appropriate legend URLs for WMS layers.

    Parameters

    • layerList: any[]

      a list of objects identifying the WMS layers to be queried

    Returns string[]

    a list of strings containing URLs for specified layers (order is preserved)

getSR

getSqlFilter

  • getSqlFilter(filterKey): string

  • Returns the value of a named SQL filter for the layer.

    Parameters

    • filterKey: string

      the filter key / named filter to view

    Returns string

    the value of the where clause for the filter. Empty string if not defined.

getTabularAttributes

initiate

  • initiate(): Promise<void>

  • Sets up the internal layer object (ESRI) and initiates the loading process. The promise returned resolves when the object exists (i.e. .esriLayer is populated). This means the layer can be added to the map.

    Returns Promise<void>

isOffscale

  • isOffscale(testScale?): boolean

  • Indicates if the layer is not in a visible scale range.

    Parameters

    • OptionaltestScale: number = undefined

      optional scale to test against. if not provided, current map scale is used.

    Returns boolean

    true if the layer is outside of a visible scale range

    Function

    isOffscale

loadPromise

  • loadPromise(): Promise<void>

  • Provides a promise that resolves when the layer has finished loading. If accessing layer properties that depend on the layer being loaded, wait on this promise before accessing them.

    Returns Promise<void>

    resolves when the layer has finished loading

    Method

    loadPromise

loadSymbology

  • loadSymbology(): void

  • Download or refresh the internal symbology for the sublayer.

    Returns void

    Function

    loadSymbology

ProtectedmakeEsriLayerConfig

  • makeEsriLayerConfig(rampLayerConfig): WMSLayerProperties

  • Take a layer config from the RAMP application and derives a configuration for an ESRI layer

    Parameters

    Returns WMSLayerProperties

    configuration object for the ESRI layer representing this layer

ProtectednoLayerErr

ProtectednotLoadedErr

onError

  • onError(genuineError?): void

  • Initiates actions after layer load error. Should generally only be called internally by the RAMP core.

    Parameters

    • genuineError: boolean = true

      Flag to detect error setting due to manual cancellation. Only genuine errors will raise notifications.

    Returns void

ProtectedonInitiate

onLoad

ProtectedonLoadActions

reload

  • reload(): Promise<void>

  • Attempts to reload the internal layer object (ESRI). Effectively doing a terminate then initiate, and removing/re-adding layer to the map.

    Returns Promise<void>

removeEsriLayer

runIdentify

setCustomParameter

  • setCustomParameter(key, value, forceRefresh?): void

  • Add a WMS layer parameter, maybe even refresh the layer

    Parameters

    • key: string

      name of the key to be created or updated

    • value: string

      value of the key

    • forceRefresh: boolean = true

      show the new fancy version of the layer or not

    Returns void

    Function

    setCustomParameter

setSqlFilter

  • setSqlFilter(filterKey, whereClause): void

  • Applies an SQL filter to the layer. Will overwrite any existing filter for the given key. Use 1=2 for a "hide all" where clause.

    Parameters

    • filterKey: string

      the filter key / named filter to apply the SQL to

    • whereClause: string

      the WHERE clause of the filter

    Returns void

ProtectedstartTimer

  • startTimer(type): void

  • Start the draw/load timer for the layer, after which is a slow to load/draw notification is shown.

    Parameters

    • type: TimerType

      the type of timer to start (load or draw)

    Returns void

ProtectedstopTimer

ProtectedstubError

terminate

  • terminate(): Promise<void>

  • Resets the layer class to the state it was in "pre-initialize". Implementers can decide if they want to retain any state (e.g. UIDs/layerTree would be a good idea). Also an appropriate function to remove any event listeners/triggers. This would be called in situations like a layer getting deleted, or in a layer reload (initialize would be called again afterwards). Note this does not remove any layers from the map stack, that must be done by the caller.

    Returns Promise<void>

updateDrawState

updateInitiationState

updateLayerState

  • updateLayerState(newState, userCancel?): void

  • Updates layer load state and raises events. Should generally only be called internally by the RAMP core.

    Parameters

    • newState: LayerState

      load state the layer is entering

    • userCancel: boolean = false

      optional flag to indicate if an error state was intentional due to a user cancel request

    Returns void

zoomToLayerBoundary

zoomToVisibleScale

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods