Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StreamLayerProperties

Hierarchy

Index

Properties

Optional 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...

Optional copyright

copyright: string

Copyright information for the layer.

Read more...

Optional definitionExpression

definitionExpression: string

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

Read more...

Optional displayField

displayField: string

The name of the layer's primary display field.

Read more...

Optional effect

effect: string | any[]

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...

Optional elevationInfo

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

Read more...

Optional featureReduction

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

Read more...

Optional fields

fields: FieldProperties[]

An array of fields in the layer.

Read more...

Optional fullExtent

fullExtent: ExtentProperties

The full extent of the layer.

Read more...

Optional geometryDefinition

geometryDefinition: ExtentProperties

An extent object used to filter features.

Read more...

Optional geometryType

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

The geometry type of features in the layer.

Read more...

Optional id

id: string

The unique ID assigned to the layer.

Read more...

Optional labelingInfo

labelingInfo: LabelClassProperties[]

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

Read more...

Optional labelsVisible

labelsVisible: boolean

Indicates whether to display labels for this layer.

Read more...

Optional legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Read more...

Optional listMode

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

Indicates how the layer should display in the LayerList widget.

Read more...

Optional maxReconnectionAttempts

maxReconnectionAttempts: number

The maximum number of attempts to reconnect.

Read more...

Optional maxReconnectionInterval

maxReconnectionInterval: number

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

Read more...

Optional maxScale

maxScale: number

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

Read more...

Optional minScale

minScale: number

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

Read more...

Optional objectIdField

objectIdField: string

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

Read more...

Optional opacity

opacity: number

The opacity of the layer.

Read more...

Optional popupEnabled

popupEnabled: boolean

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

Read more...

Optional popupTemplate

The popup template for the layer.

Read more...

Optional purgeOptions

Options for purging stale features.

Read more...

Optional renderer

The renderer assigned to the layer.

Read more...

Optional screenSizePerspectiveEnabled

screenSizePerspectiveEnabled: boolean

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

Read more...

Optional sourceJSON

sourceJSON: any

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

Read more...

Optional spatialReference

spatialReference: SpatialReferenceProperties

The spatial reference of the layer.

Read more...

Optional timeExtent

The layer's time extent.

Read more...

Optional 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...

Optional timeOffset

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

Read more...

Optional title

title: string

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

Read more...

Optional updateInterval

updateInterval: number

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

Read more...

Optional url

url: string

The URL of the stream service.

Read more...

Optional useViewTime

useViewTime: boolean

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

Read more...

Optional visible

visible: boolean

Indicates if the layer is visible in the View.

Read more...

Optional webSocketUrl

webSocketUrl: string

The URL of a websocket connection.

Read more...

Generated using TypeDoc