Class EsriGraphicsLayer

Hierarchy

Layer
ScaleRangeLayer
BlendLayer
- EsriGraphicsLayer

Constructors

constructor

new EsriGraphicsLayer(properties?): EsriGraphicsLayer
A GraphicsLayer contains one or more client-side Graphics.

Read more...
Parameters
- Optional properties: GraphicsLayerProperties
Returns EsriGraphicsLayer
Inherited from Layer.constructor
- Defined in node_modules/@arcgis/core/interfaces.d.ts:12930

Properties

blendMode

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.

Default

normal

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#blendMode)

declaredClass

declaredClass: string

destroyed

destroyed: boolean

effect

effect: Effect

Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#effect)

elevationInfo

elevationInfo: GraphicsLayerElevationInfo

Specifies how graphics are placed on the vertical axis (z).

fullExtent

fullExtent: EsriExtent

The full extent of the layer.

graphics

graphics: Collection<EsriGraphic>

A collection of graphics in the layer.

id

id: string

The unique ID assigned to the layer.

initialized

initialized: boolean

listMode

listMode: "show" | "hide" | "hide-children"

Indicates how the layer should display in the LayerList widget.

Default

"show"

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode)

`Readonly` loadError

loadError: Error

The Error object returned if an error occurred while loading.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadError)

`Readonly` loadStatus

loadStatus: "loaded" | "loading" | "not-loaded" | "failed"

Represents the status of a load operation.

Default

not-loaded

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Loadable.html#loadStatus)

`Readonly` loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

`Readonly` loaded

loaded: boolean

Indicates whether the layer's resources have loaded.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#loaded)

maxScale

maxScale: number

The maximum scale (most zoomed in) at which the layer is visible in the view.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale)

minScale

minScale: number

The minimum scale (most zoomed out) at which the layer is visible in the view.

Default

0

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale)

opacity

opacity: number

The opacity of the layer.

Default

1

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#opacity)

screenSizePerspectiveEnabled

screenSizePerspectiveEnabled: boolean

Apply perspective scaling to screen-size point symbols in a SceneView.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html#screenSizePerspectiveEnabled)

title

title: string

The title of the layer used to identify it in places such as the LayerList widget.

`Readonly` type

type: "graphics"

visible

visible: boolean

Indicates if the layer is visible in the View.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#visible)

Methods

`Protected` _get

_get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Layer._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:32
_get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Layer._get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:33

`Protected` _set

_set<T>(propertyName, value): EsriGraphicsLayer
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriGraphicsLayer
Inherited from Layer._set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:34

add

add(graphic): void
Adds a graphic to the layer's graphic collection.

Read more...
Parameters
- graphic: EsriGraphic
Returns void
- Defined in node_modules/@arcgis/core/interfaces.d.ts:12936

addHandles

addHandles<T>(handles, groupKey?): void
Type Parameters
- T
Parameters
- handles: IHandle | IHandle[]
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Layer.addHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:28

addMany

addMany(graphics): void
Adds an array of graphics to the layer.

Read more...
Parameters
- graphics: EsriGraphic[]
Returns void
- Defined in node_modules/@arcgis/core/interfaces.d.ts:12942

cancelLoad

cancelLoad(): void
Cancels a load() operation if it is already in progress.

Read more...

Returns void
Inherited from Layer.cancelLoad
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2220

createLayerView

createLayerView(view, options?): Promise<LayerView>
Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.

Read more...
Parameters
- view: any
- Optional options: LayerCreateLayerViewOptions
Returns Promise<LayerView>
Inherited from Layer.createLayerView
- Defined in node_modules/@arcgis/core/interfaces.d.ts:14044

destroy

destroy(): void
Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).

Read more...

Returns void
Inherited from Layer.destroy
- Defined in node_modules/@arcgis/core/interfaces.d.ts:14050

emit

emit(type, event?): boolean
Emits an event on the instance.

Read more...
Parameters
- type: string
- Optional event: any
Returns boolean
Inherited from Layer.emit
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2063

fetchAttributionData

fetchAttributionData(): Promise<any>
Fetches custom attribution data for the layer when it becomes available.

Read more...

Returns Promise<any>
Inherited from Layer.fetchAttributionData
- Defined in node_modules/@arcgis/core/interfaces.d.ts:14056

get

get<T>(propertyName): T
Type Parameters
- T
Parameters
- propertyName: string
Returns T
Inherited from Layer.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:21
get(propertyName): any
Parameters
- propertyName: string
Returns any
Inherited from Layer.get
- Defined in node_modules/@arcgis/core/interfaces.d.ts:22

hasEventListener

hasEventListener(type): boolean
Indicates whether there is an event listener on the instance that matches the provided event name.

Read more...
Parameters
- type: string
Returns boolean
Inherited from Layer.hasEventListener
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2069

hasHandles

hasHandles<T>(groupKey?): boolean
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns boolean
Inherited from Layer.hasHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:30

isFulfilled

isFulfilled(): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

Read more...

Returns boolean
Inherited from Layer.isFulfilled
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2226

isRejected

isRejected(): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.

Read more...

Returns boolean
Inherited from Layer.isRejected
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2232

isResolved

isResolved(): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.

Read more...

Returns boolean
Inherited from Layer.isResolved
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2238

load

load(signal?): Promise<any>
Loads the resources referenced by this class.

Read more...
Parameters
- Optional signal: AbortSignal
Returns Promise<any>
Inherited from Layer.load
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2244

`Protected` notifyChange

notifyChange(propertyName): void
Parameters
- propertyName: string
Returns void
Inherited from Layer.notifyChange
- Defined in node_modules/@arcgis/core/interfaces.d.ts:31

on

on(name, eventHandler): IHandle
Parameters
- name: "layerview-create"
- eventHandler: LayerLayerviewCreateEventHandler
Returns IHandle
Inherited from Layer.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:14057
on(name, eventHandler): IHandle
Parameters
- name: "layerview-create-error"
- eventHandler: LayerLayerviewCreateErrorEventHandler
Returns IHandle
Inherited from Layer.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:14058
on(name, eventHandler): IHandle
Parameters
- name: "layerview-destroy"
- eventHandler: LayerLayerviewDestroyEventHandler
Returns IHandle
Inherited from Layer.on
- Defined in node_modules/@arcgis/core/interfaces.d.ts:14059

own

own(handles): void
Deprecated
Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.
Parameters
- handles: IHandle | IHandle[]
Returns void
Inherited from Layer.own
- Defined in node_modules/@arcgis/core/interfaces.d.ts:27

remove

remove(graphic): void
Removes a graphic from the layer.

Read more...
Parameters
- graphic: EsriGraphic
Returns void
- Defined in node_modules/@arcgis/core/interfaces.d.ts:12948

removeAll

removeAll(): void
Clears all the graphics from the layer.

Read more...

Returns void
- Defined in node_modules/@arcgis/core/interfaces.d.ts:12954

removeHandles

removeHandles<T>(groupKey?): void
Type Parameters
- T
Parameters
- Optional groupKey: Exclude<T, IHandle>
Returns void
Inherited from Layer.removeHandles
- Defined in node_modules/@arcgis/core/interfaces.d.ts:29

removeMany

removeMany(graphics): void
Removes an array of graphics from the layer.

Read more...
Parameters
- graphics: EsriGraphic[]
Returns void
- Defined in node_modules/@arcgis/core/interfaces.d.ts:12960

set

set<T>(propertyName, value): EsriGraphicsLayer
Type Parameters
- T
Parameters
- propertyName: string
- value: T
Returns EsriGraphicsLayer
Inherited from Layer.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:23
set(props): EsriGraphicsLayer
Parameters
- props: HashMap<any>
Returns EsriGraphicsLayer
Inherited from Layer.set
- Defined in node_modules/@arcgis/core/interfaces.d.ts:24

watch

watch(path, callback, sync?): WatchHandle
Parameters
- path: string | string[]
- callback: WatchCallback
- Optional sync: boolean
Returns WatchHandle
Inherited from Layer.watch
- Defined in node_modules/@arcgis/core/interfaces.d.ts:25

when

when(callback?, errback?): Promise<any>
when() may be leveraged once an instance of the class is created.

Read more...
Parameters
- Optional callback: Function
- Optional errback: Function
Returns Promise<any>
Inherited from Layer.when
- Defined in node_modules/@arcgis/core/interfaces.d.ts:2250

Class EsriGraphicsLayer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional properties: GraphicsLayerProperties

Returns EsriGraphicsLayer

Properties

blendMode

Default

declaredClass

destroyed

effect

Default

elevationInfo

fullExtent

graphics

id

initialized

listMode

Default

Readonly loadError

Default

Readonly loadStatus

Default

Readonly loadWarnings

Readonly loaded

Default

maxScale

Default

minScale

Default

opacity

Default

screenSizePerspectiveEnabled

Default

title

Readonly type

visible

Default

Methods

Protected _get

Parameters

propertyName: string

Returns any

Type Parameters

T

Parameters

propertyName: string

Returns T

Protected _set

Type Parameters

T

Parameters

propertyName: string

value: T

Returns EsriGraphicsLayer

add

Parameters

graphic: EsriGraphic

Returns void

addHandles

Type Parameters

T

Parameters

handles: IHandle | IHandle[]

Optional groupKey: Exclude<T, IHandle>

Returns void

addMany

Parameters

graphics: EsriGraphic[]

Returns void

cancelLoad

Returns void

createLayerView

Parameters

`Optional` properties: GraphicsLayerProperties

`Readonly` loadError

`Readonly` loadStatus

`Readonly` loadWarnings

`Readonly` loaded

`Readonly` type

`Protected` _get

`Protected` _set

`Optional` groupKey: Exclude<T, IHandle>

`Optional` options: LayerCreateLayerViewOptions

`Optional` event: any

`Optional` groupKey: Exclude<T, IHandle>

`Optional` signal: AbortSignal

`Protected` notifyChange