Properties specific to the ArcGISStreamLayer layer type.
Referenced by: operationalLayers
Properties
| Property | Details |
|---|---|
| blendMode | Blend modes are used to create various effects by blending colors of top and background layers. normal blend mode is the default.Valid values: average, color, color-burn, color-dodge, 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 |
| customParameters | A sequence of custom parameters appended to the URL of all requests related to a layer. |
| definitionEditor | Stores interactive filters. |
| disablePopup | Indicates whether to ignore popups defined by the service item. |
| effect | Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work. |
| featureEffect | Feature Effect emphasizes or deemphasizes features that satisfy a filter using graphical effects |
| id | A unique identifying string for the layer. |
| itemId | Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal. |
| layerDefinition | An object that defines the attribute schema and drawing information for a layer drawn using client-side graphics. See layerDefinition properties table. |
| layerType | String indicating the layer type. Valid value of this property ArcGISStreamLayer |
| opacity | The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency. |
| popupInfo | A popupInfo object defining the content of pop-up windows when you click or query a feature. |
| showLabels | Labels will display if this property is set to true and the layer also has a labelingInfo property associated with it. This property can get stored in the web map config and in the item/data. |
| showLegend | Boolean value indicating whether to display the layer in the legend. Default value is true. |
| timeAnimation | Indicates whether to disable time animation if the layer supports it. |
| title | A user-friendly string title for the layer that can be used in a table of contents. |
| url | URL to the ArcGIS Server Stream Service. |
| visibility | Boolean property determining whether the layer is initially visible in the web map. |
| visibilityTimeExtent | Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data. |
layerDefinition properties
| Property | Details |
|---|---|
| definitionExpression | SQL-based definition expression string that narrows the data to be displayed in the layer. |
| definitionGeometry | An extent object used to filter features for StreamLayer. Only features that intersect the extent are displayed. |
| drawingInfo.labelingInfo[] | An object defining the properties used for labeling the layer. If working with Map Image layers, this property is only applicable if the layer is enabled with dynamic layers |
| drawingInfo.renderer | An object defined which provides the symbology for the layer. If working with Map Image layers, this property is only applicable if the layer is enabled with dynamic layers |
| maxScale | Integer property used to determine the maximum scale at which the layer is displayed. |
| minScale | Integer property used to determine the minimum scale at which the layer is displayed. |
Example
Live sample web map showing the ArcGISStreamLayer as an operationalLayer
{
"layerType": "ArcGISStreamLayer",
"id": "stream_9240",
"url": "https://geoeventsample3.esri.com:6080/arcgis/rest/services/SeattleBus/StreamServer",
"title": "SeattleBus",
"visibility": true,
"opacity": 1
}