Class GraphicLayer

A common layer class which implements a basic graphic layer (vector graphics not bound to a schema).

Hierarchy (view full)

CommonGraphicLayer
- GraphicLayer

Index

Constructors

Accessors

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

Constructors

constructor

new GraphicLayer(rampConfig, $iApi): GraphicLayer
Parameters
- rampConfig: RampLayerConfig
- $iApi: InstanceAPI
  The instance of RampMap API scoped to a single Vue R4MP application.
  
  Type
  Memberof
  APIScope
Returns GraphicLayer
Overrides CommonGraphicLayer.constructor
- Defined in src/geo/layer/graphic-layer.ts:15

Properties

`Readonly`$iApi

$iApi: InstanceAPI

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

Memberof

APIScope

_drawOrder

_drawOrder: DrawOrder[]

`Protected`_graphics

_graphics: Graphic[] = []

_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 | GraphicsLayer

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.

`Protected`layerTree

layerTree: TreeNode

layerType

layerType: LayerType

Type of layer this is (describes the overall layer)

legend

legend: LegendSymbology[]

Legend symbols of the layer

`Protected`loadDefProm

loadDefProm: DefPromise<void>

`Protected`loadPromDone

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

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.

`Protected`origRampConfig

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.

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

`Protected`viewDefProm

viewDefProm: DefPromise<void>

Accessors

$element

get $element(): App<Element>
Returns App<Element>
Inherited from CommonGraphicLayer.$element
- Defined in src/api/common.ts:32

$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
Inherited from CommonGraphicLayer.$vApp
- Defined in src/api/common.ts:28

drawOrder

get drawOrder(): DrawOrder[]
Returns an array describing the draw order of features, if applicable.

Returns DrawOrder[]
Inherited from CommonGraphicLayer.drawOrder
- Defined in src/geo/layer/map-layer.ts:429

graphics

get graphics(): Graphic[]
Returns a copy of the graphics in the layer.

Returns Graphic[]
Inherited from CommonGraphicLayer.graphics
- Defined in src/geo/layer/common-graphic-layer.ts:75

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
Inherited from CommonGraphicLayer.isLoaded
- Defined in src/geo/layer/common-layer.ts:366

layerExists

get layerExists(): boolean
Indicates if the Esri map layer exists

Returns boolean
Inherited from CommonGraphicLayer.layerExists
- Defined in src/geo/layer/map-layer.ts:422

mouseTolerance

get mouseTolerance(): number
Get the mouse tolerance in pixels for this layer

Returns number
the mouse tolerance of this layer
Inherited from CommonGraphicLayer.mouseTolerance
- Defined in src/geo/layer/map-layer.ts:367
set mouseTolerance(tolerance): void
Set the mouse tolerance for this layer in pixels
Parameters
- tolerance: number
  the new mouse tolerance
Returns void
Inherited from CommonGraphicLayer.mouseTolerance
- Defined in src/geo/layer/map-layer.ts:376

opacity

get opacity(): number
Returns the opacity of the layer.

Returns number
opacity of the layer (range between 0 and 1)
Inherited from CommonGraphicLayer.opacity
- Defined in src/geo/layer/map-layer.ts:478
set opacity(value): void
Applies opacity to layer.
Parameters
- value: number
  the new opacity setting (range between 0 and 1)
Returns void
Inherited from CommonGraphicLayer.opacity
- Defined in src/geo/layer/map-layer.ts:492

parentLayer

get parentLayer(): undefined | LayerInstance
Get the parent layer for this layer Only supported for sublayers

Returns undefined | LayerInstance
the parent layer of this layer
Inherited from CommonGraphicLayer.parentLayer
- Defined in src/geo/layer/layer-instance.ts:674
set parentLayer(layer): void
Set the parent layer for this layer Only supported for sublayers
Parameters
- layer: undefined | LayerInstance
  the new parent layer for this layer
Returns void
Inherited from CommonGraphicLayer.parentLayer
- Defined in src/geo/layer/layer-instance.ts:688

scaleSet

get scaleSet(): ScaleSet
Returns the scale set (min and max visible scale) of the layer.

Returns ScaleSet
scale set of the layer
Inherited from CommonGraphicLayer.scaleSet
- Defined in src/geo/layer/map-layer.ts:289
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
Inherited from CommonGraphicLayer.scaleSet
- Defined in src/geo/layer/map-layer.ts:298

sublayers

get sublayers(): LayerInstance[]
Get the sublayers for this layer

Returns LayerInstance[]
the sublayers of this layer
Inherited from CommonGraphicLayer.sublayers
- Defined in src/geo/layer/layer-instance.ts:701

touchTolerance

get touchTolerance(): number
Get the touch tolerance in pixels for this layer

Returns number
the touch tolerance of this layer
Inherited from CommonGraphicLayer.touchTolerance
- Defined in src/geo/layer/map-layer.ts:396
set touchTolerance(tolerance): void
Set the touch tolerance in pixels for this layer
Parameters
- tolerance: number
  the new touch tolerance
Returns void
Inherited from CommonGraphicLayer.touchTolerance
- Defined in src/geo/layer/map-layer.ts:405

visibility

get visibility(): boolean
Returns the visibility of the layer.

Returns boolean
visibility of the layer
Inherited from CommonGraphicLayer.visibility
- Defined in src/geo/layer/map-layer.ts:438
set visibility(value): void
Applies visibility to layer.
Parameters
- value: boolean
  the new visibility setting
Returns void
Inherited from CommonGraphicLayer.visibility
- Defined in src/geo/layer/map-layer.ts:452

Methods

abortAttributeLoad

abortAttributeLoad(): void
Requests that an attribute load request be aborted. Useful when encountering a massive dataset or a runaway process.

Returns void
Inherited from CommonGraphicLayer.abortAttributeLoad
- Defined in src/geo/layer/common-layer.ts:419

addGraphic

addGraphic(graphics): Promise<void>
Adds graphics to the layer. Once added, the Graphic is not tightly bound to the layer. Updating the Graphic object will not automatically update what is on the layer.
Parameters
- graphics: Graphic | Graphic[]
  one or more RAMP Graphics to add to the layer
Returns Promise<void>
resolves when graphics have been added
Inherited from CommonGraphicLayer.addGraphic
- Defined in src/geo/layer/common-graphic-layer.ts:86

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
Inherited from CommonGraphicLayer.applySqlFilter
- Defined in src/geo/layer/common-layer.ts:488

attribLoadAborted

attribLoadAborted(): boolean
Indicates if the attribute load has been aborted.

Returns boolean
boolean if the process has been stopped
Inherited from CommonGraphicLayer.attribLoadAborted
- Defined in src/geo/layer/layer-instance.ts:568

canIdentify

canIdentify(): boolean
Indicates if layer should participate in an identify request.

Returns boolean
Inherited from CommonGraphicLayer.canIdentify
- Defined in src/geo/layer/common-layer.ts:375

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
Inherited from CommonGraphicLayer.cancelLoad
- Defined in src/geo/layer/common-layer.ts:333

checkVisibility

checkVisibility(): void
Checks the visibility of the sublayers If all sublayers are invisible, then this layer is also set to invisible

Returns void
Function
checkVisibility
Inherited from CommonGraphicLayer.checkVisibility
- Defined in src/geo/layer/map-layer.ts:467

clearFeatureCache

clearFeatureCache(): void
Requests that any downloaded attribute sets or cached geometry be removed from memory. The next requests will pull from the server again.

Returns void
Inherited from CommonGraphicLayer.clearFeatureCache
- Defined in src/geo/layer/common-layer.ts:423

controlAvailable

controlAvailable(control): boolean
Check if layer controls is available on this layer.
Parameters
- control: LayerControl
  the layer control to check
Returns boolean
Indicates if the given control is enabled on this layer
Inherited from CommonGraphicLayer.controlAvailable
- Defined in src/geo/layer/layer-instance.ts:801

downloadedAttributes

downloadedAttributes(): number
The number of attributes currently downloaded (will update as download progresses)

Returns number
current download count
Inherited from CommonGraphicLayer.downloadedAttributes
- Defined in src/geo/layer/layer-instance.ts:560

getAttributes

getAttributes(): Promise<AttributeSet>
Invokes the process to get the full set of attribute values for the layer. Repeat calls will re-use the downloaded values unless the values have been explicitly cleared.

Returns Promise<AttributeSet>
resolves with set of attribute values
Inherited from CommonGraphicLayer.getAttributes
- Defined in src/geo/layer/common-layer.ts:411

getEsriGraphic

getEsriGraphic(graphicId): undefined | Graphic
Gets the ESRI graphic from the layer, if it exists, that is rendering the Graphic with the provided id.
Parameters
- graphicId: string
  id of the graphic to find
Returns undefined | Graphic
the graphic, undefined if no matching id is found.
Inherited from CommonGraphicLayer.getEsriGraphic
- Defined in src/geo/layer/common-graphic-layer.ts:70

getFieldsToTrim

getFieldsToTrim(): string[]
Gets the fields whose string values should be trimmed.

Returns string[]
the field names.
Inherited from CommonGraphicLayer.getFieldsToTrim
- Defined in src/geo/layer/layer-instance.ts:374

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.
Inherited from CommonGraphicLayer.getFilterOIDs
- Defined in src/geo/layer/common-layer.ts:468

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
Inherited from CommonGraphicLayer.getGraphic
- Defined in src/geo/layer/common-layer.ts:449

getGraphicCount

getGraphicCount(): number
Get the number of graphics in the layer.

Returns number
number of graphics in the layer
Inherited from CommonGraphicLayer.getGraphicCount
- Defined in src/geo/layer/common-graphic-layer.ts:45

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
Inherited from CommonGraphicLayer.getGraphicExtent
- Defined in src/geo/layer/common-layer.ts:483

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
Inherited from CommonGraphicLayer.getIcon
- Defined in src/geo/layer/common-layer.ts:454

getLayerTree

getLayerTree(): TreeNode
Provides a tree structure describing the layer and any sublayers, including uid values. Should only be called after loadPromise resolves.

Returns TreeNode
the root of the layer tree

Method
getLayerTree
Inherited from CommonGraphicLayer.getLayerTree
- Defined in src/geo/layer/common-layer.ts:392

getLocalGraphic

getLocalGraphic(graphicId): undefined | Graphic
Gets a graphic from the layer, if it exists.
Parameters
- graphicId: string
  id of the graphic to find
Returns undefined | Graphic
the graphic, undefined if no matching id is found.
Inherited from CommonGraphicLayer.getLocalGraphic
- Defined in src/geo/layer/common-graphic-layer.ts:59

getSR

getSR(): SpatialReference
Provides the spatial reference of how the underlying ESRI layer is encoding geometry on the client.

Returns SpatialReference
the layer spatial reference in RAMP API format
Inherited from CommonGraphicLayer.getSR
- Defined in src/geo/layer/map-layer.ts:506

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.
Inherited from CommonGraphicLayer.getSqlFilter
- Defined in src/geo/layer/common-layer.ts:459

getTabularAttributes

getTabularAttributes(): Promise<TabularAttributeSet>
Invokes the process to get the full set of attribute values for the layer, formatted in a tabular format. Additional data properties are also included. Repeat calls will re-use the downloaded values unless the values have been explicitly cleared.

Returns Promise<TabularAttributeSet>
resolves with set of tabular attribute values
Inherited from CommonGraphicLayer.getTabularAttributes
- Defined in src/geo/layer/common-layer.ts:427

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>
Inherited from CommonGraphicLayer.initiate
- Defined in src/geo/layer/common-layer.ts:136

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
Inherited from CommonGraphicLayer.isOffscale
- Defined in src/geo/layer/map-layer.ts:309

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
Inherited from CommonGraphicLayer.loadPromise
- Defined in src/geo/layer/common-layer.ts:362

`Protected`makeEsriLayerConfig

makeEsriLayerConfig(rampLayerConfig): GraphicsLayerProperties
Take a layer config from the RAMP application and derives a configuration for an ESRI layer
Parameters
- rampLayerConfig: RampLayerConfig
  snippet from RAMP for this layer
Returns GraphicsLayerProperties
configuration object for the ESRI layer representing this layer
Overrides CommonGraphicLayer.makeEsriLayerConfig
- Defined in src/geo/layer/graphic-layer.ts:31

`Protected`noLayerErr

noLayerErr(): void
Returns void
Inherited from CommonGraphicLayer.noLayerErr
- Defined in src/geo/layer/map-layer.ts:50

`Protected`notLoadedErr

notLoadedErr(): void
Returns void
Inherited from CommonGraphicLayer.notLoadedErr
- Defined in src/geo/layer/map-layer.ts:58

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
Inherited from CommonGraphicLayer.onError
- Defined in src/geo/layer/common-layer.ts:280

`Protected`onInitiate

onInitiate(): Promise<void>
Returns Promise<void>
Overrides CommonGraphicLayer.onInitiate
- Defined in src/geo/layer/graphic-layer.ts:20

onLoad

onLoad(): void
Initiates actions after layer load. Should generally only be called internally by the RAMP core.

Returns void
Inherited from CommonGraphicLayer.onLoad
- Defined in src/geo/layer/common-layer.ts:218

`Protected`onLoadActions

onLoadActions(): Promise<void>[]
Returns Promise<void>[]
Overrides CommonGraphicLayer.onLoadActions
- Defined in src/geo/layer/graphic-layer.ts:39

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>
Inherited from CommonGraphicLayer.reload
- Defined in src/geo/layer/map-layer.ts:158

removeEsriLayer

removeEsriLayer(): void
If layer is map bound, and has an esri layer in the esri map, remove it from esri map. Typically should only be called by RAMP internals.

Returns void
Inherited from CommonGraphicLayer.removeEsriLayer
- Defined in src/geo/layer/map-layer.ts:225

removeGraphic

removeGraphic(graphics?): void
If Graphics are specified, removes those graphics from the layer. Passing no parameter removes all Graphics.
Parameters
- Optionalgraphics: string | Graphic | (string | Graphic)[]
  Valid formats: A Graphic object, a graphic ID in string form, or an array of Graphic objects and/or graphic ID strings
Returns void
Inherited from CommonGraphicLayer.removeGraphic
- Defined in src/geo/layer/common-graphic-layer.ts:135

runIdentify

runIdentify(options): IdentifyResult[]
Baseline identify function for layers that do not support identify. Will return an empty result. Layers that support identify should override this method. Note: implementations that return real data must make that data reactive()
Parameters
- options: IdentifyParameters
  not used, present for nice signature of overrided function
Returns IdentifyResult[]
an empty result set
Inherited from CommonGraphicLayer.runIdentify
- Defined in src/geo/layer/layer-instance.ts:529

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
Inherited from CommonGraphicLayer.setCustomParameter
- Defined in src/geo/layer/common-layer.ts:500

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
Inherited from CommonGraphicLayer.setSqlFilter
- Defined in src/geo/layer/common-layer.ts:464

`Protected`startTimer

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
Inherited from CommonGraphicLayer.startTimer
- Defined in src/geo/layer/common-layer.ts:508

`Protected`stopTimer

stopTimer(type): void
Stop the draw/load timer for the layer, if it was started.
Parameters
- type: TimerType
  the type of timer to stop (load or draw)
Returns void
Inherited from CommonGraphicLayer.stopTimer
- Defined in src/geo/layer/common-layer.ts:529

`Protected`stubError

stubError(): void
Returns void
Inherited from CommonGraphicLayer.stubError
- Defined in src/geo/layer/common-layer.ts:401

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>
Inherited from CommonGraphicLayer.terminate
- Defined in src/geo/layer/map-layer.ts:147

updateDrawState

updateDrawState(newState): void
Updates layer draw state and raises events. Should generally only be called internally by the RAMP core.
Parameters
- newState: DrawState
Returns void
Inherited from CommonGraphicLayer.updateDrawState
- Defined in src/geo/layer/common-layer.ts:122

updateInitiationState

updateInitiationState(newState): void
Updates layer layer state and raises events. Should generally only be called internally by the RAMP core.
Parameters
- newState: InitiationState
Returns void
Inherited from CommonGraphicLayer.updateInitiationState
- Defined in src/geo/layer/common-layer.ts:103

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
Inherited from CommonGraphicLayer.updateLayerState
- Defined in src/geo/layer/common-layer.ts:112

zoomToLayerBoundary

zoomToLayerBoundary(): Promise<void>
Cause the map to zoom to this layer's boundary extent

Returns Promise<void>
resolves when map has finished zooming
Inherited from CommonGraphicLayer.zoomToLayerBoundary
- Defined in src/geo/layer/map-layer.ts:349

zoomToVisibleScale

zoomToVisibleScale(): Promise<void>
Cause the map to zoom to a scale level where the layer is visible.

Returns Promise<void>
resolves when map has finished zooming
Inherited from CommonGraphicLayer.zoomToVisibleScale
- Defined in src/geo/layer/map-layer.ts:330

Class GraphicLayer

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Type

Memberof

Returns GraphicLayer

Properties

Readonly$iApi

Memberof

_drawOrder

Protected_graphics

_lastFilterUpdate

_mouseTolerance

Protected_parentLayer

_scaleSet

_serverVisibility

Protected_sublayers

_touchTolerance

canModifyLayer

canReload

config

dataFormat

drawState

esriLayer

esriSubLayer

esriView

esriWatches

expectedTime

extent

featureCount

fieldList

fields

geomType

hovertips

id

Memberof

identify

identifyMode

initiationState

isCosmetic

isFile

isRemoved

isSublayer

lastCancel

layerFormat

layerIdx

layerState

ProtectedlayerTree

layerType

legend

ProtectedloadDefProm

ProtectedloadPromDone

mapLayer

name

nameField

oidField

ProtectedorigRampConfig

sourceSR

supportsFeatures

supportsIdentify

supportsSublayers

timers

uid

url

userAdded

ProtectedviewDefProm

Accessors

$element

Returns App<Element>

$vApp

Returns ComponentPublicInstance

Memberof

drawOrder

`Readonly`$iApi

`Protected`_graphics

`Protected`_parentLayer

`Protected`_sublayers

`Protected`layerTree

`Protected`loadDefProm

`Protected`loadPromDone

`Protected`origRampConfig

`Protected`viewDefProm