A catalog layer is a collection of item references to local and shared datasets, layers, services, and workspaces from across various work environments. The references, which are catalogued and added as items in a dataset, can be visualized, filtered, and queried dynamically in maps and scenes.
Referenced by: operationalLayers
Properties
| Property | Details |
|---|---|
| customParameters | A sequence of custom parameters appended to the URL of all requests related to a layer. |
| dynamicGroupLayer | Object representing the dynamic group layer that loads layers selectively based on the current map extent, their scale visibility, time and range. |
| footprintLayer | Object representing the dynamic group layer to visualize the catalog layer items as a polygon feature layer. |
| 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 | Additional properties that define drawing information and other configurations for the layer. See layerDefinition properties table. |
| layerType | String indicating the layer type. Valid value of this property CatalogLayer |
| listMode | To show or hide layers in the layer list Valid values:
|
| opacity | The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency. |
| refreshInterval | Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled. |
| 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 | The URL to the service. |
| visibility | Boolean property determining whether the layer is initially visible in the web scene |
| visibilityTimeExtent | Represents time extent that will control when a layer should be visible based on webscene'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. |
| maxScale | Represents the maximum scale (most zoomed in) at which the layer is visible in the view. If the web scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. If set, the maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification. |
| minScale | Represents the minimum scale (most zoomed out) at which the layer is visible in the view. If the web scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. If set, the minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification. |
| orderBy[] | An array of orderByField objects specifying the feature display order. Features can be sorted in ascending or descending order of a numeric or date field only. If ascending, features with smaller values will be drawn on top of features with larger values. For date values, ascending order means features with older dates will be drawn on top of features with recent dates. If descending, the sort behavior is reversed. When this property is not defined, features are displayed in the order in which they are received by the client. |