Catalog Layer (CatalogLayer)

Catalog layers can be created by referencing a feature service layer where the type is a 'Catalog Layer'. Catalog Layer helps visually explore the footprints of disperate layer types stored as references along with footprint in shape field and other attributes relavent to each layer reference.

Referenced by: operationalLayers


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.
dynamicGroupLayer Object representing the dynamic group layer that loads layers selectively based on the current map extent, their scale visibility, time and range.
effect Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.
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 A layerDefinition object defining the attribute schema and drawing information for the layer.
See layerDefinition properties table.
layerType String indicating the layer type.
Valid value of this property CatalogLayer
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 layer.
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.
displayFilterInfo Display filters provide information about which features should be rendered on the display.
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.
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.