Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StreamLayer

Hierarchy

Index

Properties

blendMode

blendMode: "average" | "color-burn" | "color-dodge" | "color" | "darken" | "destination-atop" | "destination-in" | "destination-out" | "destination-over" | "difference" | "exclusion" | "hard-light" | "hue" | "invert" | "lighten" | "lighter" | "luminosity" | "minus" | "multiply" | "normal" | "overlay" | "plus" | "reflect" | "saturation" | "screen" | "soft-light" | "source-atop" | "source-in" | "source-out" | "vivid-light" | "xor"

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.

Read more...

copyright

copyright: string

Copyright information for the layer.

Read more...

declaredClass

declaredClass: string

definitionExpression

definitionExpression: string

The SQL where clause used to filter features based on their attributes.

Read more...

destroyed

destroyed: boolean

displayField

displayField: string

The name of the layer's primary display field.

Read more...

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.

Read more...

elevationInfo

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

Read more...

featureReduction

featureReduction: FeatureReductionSelection

Configures the method for reducing the number of point features in the view.

Read more...

fields

fields: Field[]

An array of fields in the layer.

Read more...

Readonly fieldsIndex

fieldsIndex: FieldsIndex

A convenient property that can be used to make case-insensitive lookups for a field by name.

Read more...

fullExtent

fullExtent: Extent

The full extent of the layer.

Read more...

geometryDefinition

geometryDefinition: Extent

An extent object used to filter features.

Read more...

geometryType

geometryType: "polygon" | "point" | "multipoint" | "polyline"

The geometry type of features in the layer.

Read more...

id

id: string

The unique ID assigned to the layer.

Read more...

initialized

initialized: boolean

labelingInfo

labelingInfo: LabelClass[]

The label definition for this layer, specified as an array of LabelClass.

Read more...

labelsVisible

labelsVisible: boolean

Indicates whether to display labels for this layer.

Read more...

legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Read more...

listMode

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

Indicates how the layer should display in the LayerList widget.

Read more...

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

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

Represents the status of a load operation.

Read more...

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

Readonly loaded

loaded: boolean

Indicates whether the layer's resources have loaded.

Read more...

maxReconnectionAttempts

maxReconnectionAttempts: number

The maximum number of attempts to reconnect.

Read more...

maxReconnectionInterval

maxReconnectionInterval: number

The maximum time to wait in seconds between attempts to reconnect.

Read more...

maxScale

maxScale: number

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

Read more...

minScale

minScale: number

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

Read more...

objectIdField

objectIdField: string

The name of an oid field containing a unique value or identifier for each feature in the layer.

Read more...

opacity

opacity: number

The opacity of the layer.

Read more...

popupEnabled

popupEnabled: boolean

Indicates whether to display popups when features in the layer are clicked.

Read more...

popupTemplate

popupTemplate: PopupTemplate

The popup template for the layer.

Read more...

purgeOptions

Options for purging stale features.

Read more...

renderer

renderer: Renderer

The renderer assigned to the layer.

Read more...

screenSizePerspectiveEnabled

screenSizePerspectiveEnabled: boolean

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

Read more...

sourceJSON

sourceJSON: any

The stream service's metadata JSON exposed by the ArcGIS REST API.

Read more...

spatialReference

spatialReference: SpatialReference

The spatial reference of the layer.

Read more...

timeExtent

timeExtent: TimeExtent

The layer's time extent.

Read more...

timeInfo

timeInfo: TimeInfo

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.

Read more...

timeOffset

timeOffset: TimeInterval

A temporary offset of the time data based on a certain TimeInterval.

Read more...

title

title: string

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

Read more...

Readonly type

type: "stream"

For StreamLayer the type is stream.

Read more...

updateInterval

updateInterval: number

The minimum rate (ms) at which to poll for updates over the websocket connection.

Read more...

url

url: string

The URL of the stream service.

Read more...

useViewTime

useViewTime: boolean

Determines if the layer will update its temporal data based on the view's timeExtent.

Read more...

visible

visible: boolean

Indicates if the layer is visible in the View.

Read more...

webSocketUrl

webSocketUrl: string

The URL of a websocket connection.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns StreamLayer

cancelLoad

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

    Read more...

    Returns void

createLayerView

  • 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

    Returns Promise<LayerView>

createPopupTemplate

  • Creates a popup template for the layer, populated with all the fields of the layer.

    Read more...

    Parameters

    Returns PopupTemplate

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

emit

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

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

fetchAttributionData

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

    Read more...

    Returns Promise<any>

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getField

  • getField(fieldName: string): Field
  • Returns the Field instance for a field name (case-insensitive).

    Read more...

    Parameters

    • fieldName: string

    Returns Field

getFieldDomain

hasEventListener

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

    Read more...

    Parameters

    • type: string

    Returns boolean

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

isRejected

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

    Read more...

    Returns boolean

isResolved

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

    Read more...

    Returns boolean

load

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

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns StreamLayer

  • Parameters

    Returns StreamLayer

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): 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>

Generated using TypeDoc