CIMVectorLayers.md

May 13, 2026 ยท View on GitHub

CIMAggregateField

A field holding the result of an aggregation of multiple field values.

CIMFieldDescription

PropertyTypeDescription
aliasstringThe field alias.
fieldNamestringThe field name.
highlightbooleanA value indicating whether the field is highlighted.
numberFormatNumberFormatThe number format.
readOnlybooleanA value indicating whether the field is read only.
visiblebooleanA value indicating whether the field is visible.
valueAsRatiobooleanA value indicating whether the field value is a ratio (used only by geoprocessing).
searchablebooleanA value indicating whether the values from this field should be included in the search.
searchModeenumeration DataSearchModeSearch mode to use when searching for values in this field.

CIMAggregateField

PropertyTypeDescription
aggregatedFieldNamestringThe field name on which the aggregation was done.
statisticTypeenumeration esriDataStatTypeThe type of statistic used to aggregate data.

CIMAggregateVisualization

Describes the appearance of aggregated features.

CIMAggregateVisualization

PropertyTypeDescription
rendererRendererThe renderer used by the aggregated features.
labelClassCIMLabelClassThe label class used by the aggregated features.
showLabelsbooleanA value indicating whether or not to show labels for the aggregated features.

CIMAnnotationLayer

Represents an annotation layer used to draw annotation feature classes.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMFeatureLayerDefinition

PropertyTypeDescription
autoGenerateFeatureTemplatesbooleanA value indicating whether to automatically generate feature templates from the renderer. When this value is set to true, appropriate templates will be added to whenever the renderer is changed.
extrusionCIMFeatureExtrusionThe feature extrusion.
featureElevationExpressionstringThe feature elevation expression.
featureTableCIMFeatureTableThe feature table.
featureTemplates[CIMEditingTemplate]The feature templates.
htmlPopupEnabledbooleanA value indicating whether HTML pop-ups are enabled.
htmlPopupFormatCIMHtmlPopupFormatThe HTML pop-ups format.
isFlattenedbooleanA value indicating whether the layer is rasterized and draped against the surface in 3D scenes.
selectablebooleanA value indicating whether the layer is selectable.
selectionColorColorThe selection color. For polygons, this is used as the outline color.
polygonSelectionFillColorColorThe selection fill color. Only used for polygons.
selectionSymbolCIMSymbolReferenceThe selection symbol.
useSelectionSymbolbooleanA value indicating whether to use the selection symbol.
pageDefinitionCIMPageDefinitionThe page definition which allows for using current map series page to filter features.
featureCacheTypeenumeration FeatureCacheTypeThe feature cache type.
enableDisplayFiltersbooleanA value indicating whether the current set of display filters are honored during drawing.
displayFilters[CIMDisplayFilter]The current set of scale based display filters.
displayFiltersTypeenumeration DisplayFilterTypeDisplayFiltersType value.
displayFilterNamestringThe name of the active display filter.
displayFilterChoices[CIMDisplayFilter]The current set of display filters.
featureElevationExpressionInfoCIMExpressionInfoThe expression for setting the feature elevation.
featureBlendingModeenumeration BlendingModeThe per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.
featureSortInfos[CIMFeatureSortInfo]The collection of field names and sort directions used to sort features during draw.
layerEffectsModeenumeration LayerEffectsModeThe layer effects mode.
featureEffectsCIMFeatureLayerEffectThe collection of layer effects that apply to subset of features.

CIMAnnotationLayerDefinition

PropertyTypeDescription
barrierWeightenumeration BarrierWeightThe weight of features in this layer when considered as barriers to labeling.
drawGeometrybooleanA value indicating whether the geometry of the text graphics should be drawn.
drawUnplacedAnnotationbooleanA value indicating whether unplaced annotation should be drawn.
drawGeometryLineSymbolCIMSymbolReferenceThe line symbol used to draw text graphic line geometries when the DrawGeometry option is true.
drawGeometryPointSymbolCIMSymbolReferenceThe point symbol used to draw text graphic line geometries when the DrawGeometry option is true.
unplacedAnnotationColorColorThe color that unplaced text graphics will be drawn with when Unplaced Annotation is drawn.
symbolSubstitutionTypeenumeration SymbolSubstitutionTypeThe type of symbol substitution this layer uses.
massColorSubstituteColorThe mass color substitute. When using the SymbolSubstitutionColor substitution type this is the color that all text graphics will be overridden with.
inlineColorColorThe in-line color. When using the SymbolSubstitutionIndividualSubordinate or SymbolSubstitutionIndividualDominant substitution types this is the color that all text graphics that are stored in-line (bloated) will be overridden with.
substitutionSymbolCollection[CIMSymbolIdentifier]A symbol substitution collection. When using the SymbolSubstitutionIndividualSubordinate or SymbolSubstitutionIndividualDominant substitution types this collection defines which symbols in the symbol collection are substituted and what their substitute values are. The symbol substitution properties allow the users to swap out symbols/colors of annotation stored in the geodatabase at the layer level. This allows annotation to be re-purposed in maps without duplicating the annotation. The classic case for this behavior is when a user wishes to utilize black text generated for standard parcel maps on top of a map with raster imagery. By substituting the color or symbol collection of the annotation the user is allowed to change the appearance for this one map without a large performance or data management overhead. One complex aspect of symbol substitution is how overrides are treated when it is enabled. When this feature was originally added some wanted overrides to be respected and others did not, so options were added for this (dominant and subordinate substitution types). When the dominant type is chosen overrides are ignored. When the subordinate type is chosen overrides are applied on top of the new symbols.
subLayers[CIMAnnotationSubLayer]A collection of AnnotationSubLayers, corresponding to the annotation subclasses defined by the annotation feature class.

CIMAnnotationSubLayer

Represents an annotation sublayer used to draw annotation feature classes subclasses.

CIMSubLayer

PropertyTypeDescription
descriptionstringThe description.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
namestringThe name.
showLegendsbooleanA value indicating whether or not to show legends.
subLayerIDstringThe unique identifier for this sublayer within its layer. Set by the system and typically a number.
visibilitybooleanA value indicating whether or not this layer is visible.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.

CIMAnnotationSubLayer

PropertyTypeDescription

CIMAttributeCondition

Represents an attribute condition.

CIMCondition

PropertyTypeDescription

CIMAttributeCondition

PropertyTypeDescription
whereClausestringThe where clause.

Enumeration: BarrierWeight

Weights for symbols that are used as barriers to labeling.

PropertyValueDescription
None0No weight.
Low1Low weight.
Medium2Medium weight.
High3High weight.

Enumeration: BindVariableType

Bind variable types.

PropertyValueDescription
String0String variable type.
Integer1Integer variable type.
Double2Double variable type.
Date3Date variable type.
Geometry4Geometry variable type.
Boolean5Boolean variable type.
DateOnly6Date only variable type.
TimeOnly7Time only variable type.
Duration8Duration variable type.
TimestampOffset9Timestamp offset variable type.
EntityID10Entity ID variable type.
RelationshipID11Relationship ID variable type.

CIMBinningFeatureReduction

Represents a technique for reducing features by aggregating them into polygon bins.

CIMFeatureReduction

PropertyTypeDescription
enabledbooleanA value indicating whether feature reduction is enabled in the feature layer.

CIMAggregationFeatureReduction

PropertyTypeDescription
fields[CIMAggregateField]The fields that should be shown with the aggregated features.
popupInfoCIMPopupInfoThe popup info for the aggregated features.

CIMBinningFeatureReduction

PropertyTypeDescription
thresholdTypeenumeration BinsToPointsThresholdTypeThe threshold at which points are shown.
maximumScaledoubleThe maximum scale to use when .
featureCountlongThe number of features to use when .
minimumBinSizedoubleThe minimum size (in points) to maintain as the bins are drawn at different scales.
visualizationCIMBinningVisualizationThe visualization used by the bins.
spatialReferenceSpatialReferenceThe spatial reference in which features are aggregated. A dataset may be aggregated in one or more spatial references. These may differ from the spatial reference of the dataset itself (the Geohash scheme always uses WGS84, for example). This property is the user's choice from among those spatial references.
fixedLevellongThe bin level at which bins will be drawn. If -1, the bin level will be automatically chosen based on the minimum bin size.
binTypeenumeration esriFeatureBinTypeThe bin type in which features are aggregated. A dataset may be aggregated using one or more binning types. This property is the user's choice from among those binning types.
clientSideBinningbooleanA value indicating whether binning should be performed on the client side, even when the data source has binning capabilities.

CIMBinningVisualization

Describes the appearance and application behavior of polygon aggregation bins.

CIMAggregateVisualization

PropertyTypeDescription
rendererRendererThe renderer used by the aggregated features.
labelClassCIMLabelClassThe label class used by the aggregated features.
showLabelsbooleanA value indicating whether or not to show labels for the aggregated features.

CIMBinningVisualization

PropertyTypeDescription
standardDeviationMultiplierenumeration StandardDeviationMultiplierThe standard deviation multiplier used to define the data min, max values for visualization.

Enumeration: BinsToPointsThresholdType

A threshold for determining when binned features should be shown as points.

PropertyValueDescription
MaxScale0Points will be shown when the map is zoomed in beyond the largest scale of the bin levels.
FeatureCount1Points will be shown when the number of features in a given map view falls below a certain number.

CIMBuildingDisciplineLayer

Represents a building discipline layer.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMBuildingDisciplineLayerDefinition

PropertyTypeDescription
disciplineTypeenumeration DisciplineTypeThe discipline type of this layer.
categoryLayers[string]The category layers for this discipline in the project.

CIMBuildingLayer

Represents a building composite layer.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMObject3DRenderingFilters

PropertyTypeDescription
filters[CIMObject3DRenderingFilter]The 3D object rendering filters.
activeFilterIDstringThe ID of the filter currently used for rendering.

CIMBuildingLayerDefinition

PropertyTypeDescription
buildingDisciplineLayers[string]The building discipline composite layers in the project.
exteriorLayerstringThe exterior shell feature layer in the project.
buildingIDstringThe building ID to filter by building.
dataConnectionDataConnectionThe data connection to the workspace.
summaryStatisticsURIstringThe URI of the binary reference containing the summary statistics.

CIMCatalogDynamicGroupLayer

Composite layer to hold all the dynamic content of a Catalog layer.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMCatalogDynamicGroupLayerDefinition

PropertyTypeDescription

CIMCatalogLayer

Represents a layer which dynamically loads its sublayers according to scale and extent constraints.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMFeatureLayerDefinition

PropertyTypeDescription
autoGenerateFeatureTemplatesbooleanA value indicating whether to automatically generate feature templates from the renderer. When this value is set to true, appropriate templates will be added to whenever the renderer is changed.
extrusionCIMFeatureExtrusionThe feature extrusion.
featureElevationExpressionstringThe feature elevation expression.
featureTableCIMFeatureTableThe feature table.
featureTemplates[CIMEditingTemplate]The feature templates.
htmlPopupEnabledbooleanA value indicating whether HTML pop-ups are enabled.
htmlPopupFormatCIMHtmlPopupFormatThe HTML pop-ups format.
isFlattenedbooleanA value indicating whether the layer is rasterized and draped against the surface in 3D scenes.
selectablebooleanA value indicating whether the layer is selectable.
selectionColorColorThe selection color. For polygons, this is used as the outline color.
polygonSelectionFillColorColorThe selection fill color. Only used for polygons.
selectionSymbolCIMSymbolReferenceThe selection symbol.
useSelectionSymbolbooleanA value indicating whether to use the selection symbol.
pageDefinitionCIMPageDefinitionThe page definition which allows for using current map series page to filter features.
featureCacheTypeenumeration FeatureCacheTypeThe feature cache type.
enableDisplayFiltersbooleanA value indicating whether the current set of display filters are honored during drawing.
displayFilters[CIMDisplayFilter]The current set of scale based display filters.
displayFiltersTypeenumeration DisplayFilterTypeDisplayFiltersType value.
displayFilterNamestringThe name of the active display filter.
displayFilterChoices[CIMDisplayFilter]The current set of display filters.
featureElevationExpressionInfoCIMExpressionInfoThe expression for setting the feature elevation.
featureBlendingModeenumeration BlendingModeThe per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.
featureSortInfos[CIMFeatureSortInfo]The collection of field names and sort directions used to sort features during draw.
layerEffectsModeenumeration LayerEffectsModeThe layer effects mode.
featureEffectsCIMFeatureLayerEffectThe collection of layer effects that apply to subset of features.

CIMCatalogLayerDefinition

PropertyTypeDescription
footprintLayerstringThe path of the footprint feature layer.
catalogDynamicGroupLayerstringThe path of the composite layer that contains all the currently-visible layers. The layers inside the composite layer are updated as the extent of the active view changes.
maximumVisibleSublayerslongUpper bound for number of layers in view.

CIMClusteringFeatureReduction

Represents a technique for reducing features by aggregating them into point clusters.

CIMFeatureReduction

PropertyTypeDescription
enabledbooleanA value indicating whether feature reduction is enabled in the feature layer.

CIMAggregationFeatureReduction

PropertyTypeDescription
fields[CIMAggregateField]The fields that should be shown with the aggregated features.
popupInfoCIMPopupInfoThe popup info for the aggregated features.

CIMClusteringFeatureReduction

PropertyTypeDescription
maximumScaledoubleThe maximum scale. Beyond this scale, unclustered points will be shown.
clusterRadiusdoubleThe radius within which points are clustered. Units are points.
visualizationAggregateVisualizationThe visualization used by the clusters.

Enumeration: DataSearchMode

Field search modes.

PropertyValueDescription
Contains0Search for values that contain the search text.
Exact1Search for values that are the exact match with the search text.
StartsWith2Search for values that start with the search text.
FullTextSearchStartsWith3Search for values that start with the search text using full text index.
FullTextSearchExact4Search for values that are the exact match with the search text using full text index.

CIMDatabaseRelateInfo

Represents database relationship info that is used to represent layer or table level overrides.

CIMDatabaseRelateInfo

PropertyTypeDescription
relationshipClassNamestringThe relationship class Name.
serviceRelateIDlongA integer indicating the relate ID when published in a map service.
relatedMapMemberURIstringThe related layer/table URI. This value is used to disambiguate cases where the same data connection is used by multiple layers or tables in a map.

CIMDimensionLayer

Represents an dimension layer used to draw dimension feature classes.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMFeatureLayerDefinition

PropertyTypeDescription
autoGenerateFeatureTemplatesbooleanA value indicating whether to automatically generate feature templates from the renderer. When this value is set to true, appropriate templates will be added to whenever the renderer is changed.
extrusionCIMFeatureExtrusionThe feature extrusion.
featureElevationExpressionstringThe feature elevation expression.
featureTableCIMFeatureTableThe feature table.
featureTemplates[CIMEditingTemplate]The feature templates.
htmlPopupEnabledbooleanA value indicating whether HTML pop-ups are enabled.
htmlPopupFormatCIMHtmlPopupFormatThe HTML pop-ups format.
isFlattenedbooleanA value indicating whether the layer is rasterized and draped against the surface in 3D scenes.
selectablebooleanA value indicating whether the layer is selectable.
selectionColorColorThe selection color. For polygons, this is used as the outline color.
polygonSelectionFillColorColorThe selection fill color. Only used for polygons.
selectionSymbolCIMSymbolReferenceThe selection symbol.
useSelectionSymbolbooleanA value indicating whether to use the selection symbol.
pageDefinitionCIMPageDefinitionThe page definition which allows for using current map series page to filter features.
featureCacheTypeenumeration FeatureCacheTypeThe feature cache type.
enableDisplayFiltersbooleanA value indicating whether the current set of display filters are honored during drawing.
displayFilters[CIMDisplayFilter]The current set of scale based display filters.
displayFiltersTypeenumeration DisplayFilterTypeDisplayFiltersType value.
displayFilterNamestringThe name of the active display filter.
displayFilterChoices[CIMDisplayFilter]The current set of display filters.
featureElevationExpressionInfoCIMExpressionInfoThe expression for setting the feature elevation.
featureBlendingModeenumeration BlendingModeThe per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.
featureSortInfos[CIMFeatureSortInfo]The collection of field names and sort directions used to sort features during draw.
layerEffectsModeenumeration LayerEffectsModeThe layer effects mode.
featureEffectsCIMFeatureLayerEffectThe collection of layer effects that apply to subset of features.

CIMDimensionLayerDefinition

PropertyTypeDescription
barrierWeightenumeration BarrierWeightThe weight of features in this layer when considered as barriers to labeling.
snappablebooleanA value indicating whether or not geometries are snappable.

Enumeration: DimensionMarkerFit

Dimension marker fit options.

PropertyValueDescription
None0Do not fit markers with text.
Tolerance1Fit markers with text using the length of the dimension line.
Text2Fit markers when overlapping the text.

Enumeration: DimensionPartOptions

Dimension part options.

PropertyValueDescription
Begin1Only display the beginning dimension part.
End2Only display the end dimension part.
None3Do not display any dimension parts.
Both0Display both dimension parts.

CIMDimensionShape

Represents a dimension shape as used by a dimension feature.

CIMDimensionShape

PropertyTypeDescription
beginDimensionPointPointThe begin dimension point.
endDimensionPointPointThe end dimension point.
dimensionLinePointPointThe point which describes the height of the dimension line.
textPointPointThe point for the text placement.
extensionLineAngledoubleThe angle of the extension lines in radians.
textAngledoubleThe angle of the text in radians.

CIMDimensionStyle

Represents an dimension style which defines dimension appearance.

CIMDimensionStyle

PropertyTypeDescription
alignbooleanA value indicating whether the text should be aligned with the dimension line.
baselineHeightdoubleThe height of the construction for creating baseline dimensions with this style.
beginMarkerSymbolCIMPointSymbolThe symbol used for the begin arrow.
convertUnitsbooleanA value indicating whether the length of the dimension needs to be converted for display.
dimensionLineOptionenumeration DimensionPartOptionsThe dimension line display of the style.
dimensionLineSymbolCIMLineSymbolThe symbol used for the dimension line.
displayPrecisionlongThe precision for the value displayed by the dimension text.
displayUnitsUnitThe units the length of the dimension text is displayed in.
drawLineOnFitbooleanA value indicating whether a dimension line should be drawn between the extension lines for an inward dimension.
endMarkerSymbolCIMPointSymbolThe symbol used for the end arrow.
expressionstringThe text expression for the style.
expressionParserNamestringThe text expression parser for the text expression for the style.
expressionTitlestringThe human readable text title that describes the dimension expression.
extendLineOnFitbooleanA value indicating whether the dimension line will be extended to underline the text on inward dimensions.
extensionLineOffsetdoubleThe length of the extension line offset.
extensionLineOptionenumeration DimensionPartOptionsThe extension line display options of the style.
extensionLineOvershotdoubleThe length of the extension line overshot.
extensionLineSymbolCIMLineSymbolThe symbol used for extension lines.
IDlongThe ID of the style.
markerFitenumeration DimensionMarkerFitThe arrow fit policy of the style.
markerFitTolerancedoubleThe arrow fit tolerance of the style.
markerOptionenumeration DimensionPartOptionsThe arrow display properties of the style.
namestringThe name of the style.
prefixstringThe prefix for the text expression for the style.
suffixstringThe suffix for the text expression for the style.
textFitenumeration DimensionTextFitThe text fit policy for the style.
textOptionenumeration DimensionTextOptionThe text display option for the style.
textSymbolCIMTextSymbolThe text symbol used for the text.

Enumeration: DimensionTextFit

Dimension text fit options.

PropertyValueDescription
None0Do not fit the text.
MoveBegin1Move the text outside the begin extension line.
MoveEnd2Move the text outside the end extension line.

Enumeration: DimensionTextOption

Dimension text options.

PropertyValueDescription
Only0Only display the value of the dimension length.
Suffix1Display the value of the dimension length with a prefix and suffix.
Expression2Display a text string derived from a custom expression.
None3Do not display any text.

Enumeration: DimensionType

Dimension types supported by dimension features.

PropertyValueDescription
Aligned0An aligned dimension that displays the distance between the measure points.
Linear1A linear dimension that displays the distance between the extension lines.

Enumeration: DisciplineType

Represents the discipline type of a building layer.

PropertyValueDescription
Architectural0Architectural.
Electrical1Electrical.
Mechanical2Mechanical.
Piping3Piping.
Structural4Structural.
Infrastructure5Infrastructure.

CIMDiscreteVariable

Represents a single bind variable.

CIMBindVariable

PropertyTypeDescription
variableNamestringThe name of the variable. The name must be unique among all variables.
aliasstringThe alias of the variable.
dataTypeenumeration BindVariableTypeThe type of the variable.

CIMDiscreteVariable

PropertyTypeDescription
defaultValue[[any]]The variable's required default value. The array can have multiple values only if AllowMultiple is true.
boundValue[[any]]The variable's currently-bound value. The array can have multiple values only if AllowMultiple is true.
allowMultiplebooleanA value indicating whether the variable will accept an array of values.

CIMDisplayFilter

Represents a display filter used to restrict the display of features across scale ranges.

CIMDisplayFilter

PropertyTypeDescription
namestringThe name of the display filter.
whereClausestringThe where clause that filters features for a given scale range.
minScaledoubleThe minimum scale for this display filter.
maxScaledoubleThe maximum scale for this display filter.

Enumeration: DisplayFilterType

DisplayFilterType.

PropertyValueDescription
ByChoice0DisplayFilter independent of scale.
ByScale1Scale based DisplayFilter.

CIMENCDataConnection

Represents an ENC layer data connection.

CIMDataConnection

PropertyTypeDescription

CIMServiceDataConnectionProperties

PropertyTypeDescription
customParameters[CIMStringMap]Vendor specific parameters.

CIMENCDataConnection

PropertyTypeDescription
URIstringThe URI of the ENC files or resources.

CIMENCLayer

Represents an Electronic Navigational Charts (ENC) layer. ENC layers allow to visualize nautical charts from S-57 cells using S-52 symbology.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMENCLayerDefinition

PropertyTypeDescription
dataConnectionCIMENCDataConnectionThe data connection to the ENC resource.
displaySettingsENCDisplaySettingsThe display settings of the ENC layer.
subLayers[CIMENCSubLayer]A collection of ENCSubLayers, used to access features by type.
subTables[CIMENCSubTable]A collection of ENCSubTables.
selectionSetURIstringThe URI of the selection set for the layer.
selectablebooleanA value indicating whether the layer is selectable.

CIMENCSubLayer

Represents an ENC sublayer used to access features by type.

CIMSubLayer

PropertyTypeDescription
descriptionstringThe description.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
namestringThe name.
showLegendsbooleanA value indicating whether or not to show legends.
subLayerIDstringThe unique identifier for this sublayer within its layer. Set by the system and typically a number.
visibilitybooleanA value indicating whether or not this layer is visible.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.

CIMENCSubLayer

PropertyTypeDescription

CIMENCSubTable

Represents an ENC subtable.

CIMENCSubTable

PropertyTypeDescription
namestringThe name.
subTableIDstringThe sub table ID.

CIMEditingTemplateRelationship

Represents an editing template relationship.

CIMEditingTemplateRelationship

PropertyTypeDescription
tableURIstringThe table URI of the table the relationship corresponds to.
namestringThe name.
relationshipIDlongThe relationship ID.

CIMEditingTemplateToolOptions

Represents editing template tool options.

CIMEditingTemplateToolOptions

PropertyTypeDescription
toolProgIDstringThe tool ProgID.
options{JSON_object}The options for the specified creation tool.

Enumeration: FeatureCacheType

Feature cache type options.

PropertyValueDescription
None0No cache.
Session1Cache is maintained in session.

CIMFeatureDatasetDataConnection

Represents a feature dataset data connection.

CIMDataConnection

PropertyTypeDescription

CIMFeatureDatasetDataConnection

PropertyTypeDescription
featureDatasetstringFeature dataset.

CIMStandardDataConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.
datasetstringThe dataset name.
datasetTypeenumeration esriDatasetTypeThe dataset type.

CIMServiceDataConnectionProperties

PropertyTypeDescription
customParameters[CIMStringMap]Vendor specific parameters.

Enumeration: FeatureExpirationMethod

Stream service feature expiration method.

PropertyValueDescription
MaximumFeatureCount0The oldest features will expire after a threshold number of features has been reached.
MaximumFeatureAge1Features will expire after the specified time since the beginning of their lifetime.

CIMFeatureExtrusion

Represents the extrusion properties of a feature layer.

CIMFeatureExtrusion

PropertyTypeDescription
extrusionTypeenumeration ExtrusionTypeThe extrusion type.
extrusionExpressionstringThe extrusion expression.
extrusionUnitLinearUnitThe feature layer's extrusion unit.
extrusionExpressionInfoCIMExpressionInfoAn Arcade expression info object for an expression that returns a numeric value.

CIMFeatureLayer

Represents a layer that draws data from feature classes. A feature layer displays a set of geographic features. A geographic feature represents a real-world object on the earth. It has a spatially-referenced location, stored as a point, line, or polygon, and a set of attributes that describe the feature. Its position is accurate and relevant within a particular scale range. Geographic features are the core spatial data holdings of an organization. They can serve as official records, are used in spatial analysis, and are used as source data for cartography. Feature layers draw their features by using a feature renderer to transform the geographic feature into one or more graphic entities. Feature renderers read the feature's geometry and attribute values to generate graphic entities that graphically depict the feature on a map.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMFeatureLayerDefinition

PropertyTypeDescription
autoGenerateFeatureTemplatesbooleanA value indicating whether to automatically generate feature templates from the renderer. When this value is set to true, appropriate templates will be added to whenever the renderer is changed.
extrusionCIMFeatureExtrusionThe feature extrusion.
featureElevationExpressionstringThe feature elevation expression.
featureTableCIMFeatureTableThe feature table.
featureTemplates[CIMEditingTemplate]The feature templates.
htmlPopupEnabledbooleanA value indicating whether HTML pop-ups are enabled.
htmlPopupFormatCIMHtmlPopupFormatThe HTML pop-ups format.
isFlattenedbooleanA value indicating whether the layer is rasterized and draped against the surface in 3D scenes.
selectablebooleanA value indicating whether the layer is selectable.
selectionColorColorThe selection color. For polygons, this is used as the outline color.
polygonSelectionFillColorColorThe selection fill color. Only used for polygons.
selectionSymbolCIMSymbolReferenceThe selection symbol.
useSelectionSymbolbooleanA value indicating whether to use the selection symbol.
pageDefinitionCIMPageDefinitionThe page definition which allows for using current map series page to filter features.
featureCacheTypeenumeration FeatureCacheTypeThe feature cache type.
enableDisplayFiltersbooleanA value indicating whether the current set of display filters are honored during drawing.
displayFilters[CIMDisplayFilter]The current set of scale based display filters.
displayFiltersTypeenumeration DisplayFilterTypeDisplayFiltersType value.
displayFilterNamestringThe name of the active display filter.
displayFilterChoices[CIMDisplayFilter]The current set of display filters.
featureElevationExpressionInfoCIMExpressionInfoThe expression for setting the feature elevation.
featureBlendingModeenumeration BlendingModeThe per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.
featureSortInfos[CIMFeatureSortInfo]The collection of field names and sort directions used to sort features during draw.
layerEffectsModeenumeration LayerEffectsModeThe layer effects mode.
featureEffectsCIMFeatureLayerEffectThe collection of layer effects that apply to subset of features.

CIMGeoFeatureLayerDefinition

PropertyTypeDescription
actions[CIMLayerAction]The layer actions.
exclusionSet[long long]The set of excluded features.
featureMasks[CIMDataConnection]The data connection of the masking data.
labelClasses[CIMLabelClass]The collection of label class definitions.
labelVisibilitybooleanA value indicating whether to display labels for this layer's label classes.
maskedSymbolLayers[CIMSymbolLayerMasking]The masked symbol layers. Each SymbolLayerMasking gives the symbol layers that are masked by that masking layer.
rendererRendererThe primary symbol renderer.
scaleSymbolsbooleanA value indicating whether to scale the symbols in this layer based on the map's reference scale.
snappablebooleanA value indicating whether this layer participates in snapping in the editor.
symbolLayerDrawingCIMSymbolLayerDrawingThe symbol layer drawing properties.
trackLinesRendererRendererThe track renderer when displaying tracks.
previousObservationsRendererRendererThe previous observations renderer.
previousObservationsCountlongThe previous observation count.
useRealWorldSymbolSizesbooleanA value indicating whether to use real world symbols sizes (meters) vs. points. This value should always be in sync with the UseRealWorldSymbolSizes property at the symbol level.
showPreviousObservationsbooleanA value indicating whether previous observations are being drawn.
featureReductionFeatureReductionThe feature reduction technique in use by this layer.
showTracksbooleanA value indicating whether track lines are being drawn.

CIMFeatureSortInfo

Contains information about the field name and sort order used to draw features.

CIMFeatureSortInfo

PropertyTypeDescription
fieldNamestringThe name of the Field.
sortDirectionenumeration SortOrderTypeA value indicating the sort direction.

CIMFeatureTable

Represents a feature table.

CIMDisplayTableDefinition

PropertyTypeDescription
definitionExpressionstringThe definition expression that can subset the rows in the layer or table.
definitionExpressionNamestringThe name of the active definition expression.
definitionFilterChoices[CIMDefinitionFilter]The definition filter choices.
displayFieldstringThe name of the attribute field that will be used as a label that represents each row in the layer or table. The display field must be able to be represented as a string (string or numeric).
editablebooleanA value indicating whether or not the layer or table can be edited.
relates[CIMRelateInfoBase]The relates.
fieldDescriptions[CIMFieldDescription]The field descriptions. Field descriptions for fields may only be written if values are overridden from defaults.
timeFieldsCIMTimeTableDefinitionThe time fields.
timeDefinitionCIMTimeDataDefinitionThe time definition.
timeDisplayDefinitionCIMTimeDisplayDefinitionThe time display definition.
timeDimensionFieldsCIMTimeDimensionDefinitionThe time definition fields.
rangeDefinitions[CIMRangeDefinition]The range definitions.
activeRangeNamestringThe active range name.
selectRelatedDatabooleanA value indicating whether related data should be selected when creating a new selection.
bindVariables[CIMBindVariable]The bind variables.
subtypeValuelongThe subtype value that should be used in the feature layer definition. This property is honored only when feature layer is a member of SubtypeLayer.
useSubtypeValuebooleanA value indicating whether or not the SubtypeValue should be used.
displayExpressionInfoCIMExpressionInfoThe expression information used for coming up with a string that represents a row or a feature. This property takes precedence over .
selectionSetURIstringThe URI of the selection set for the layer or table.
floorAwareTablePropertiesCIMFloorAwareTablePropertiesFloor-aware properties for the layer or table used in floor filtering.
routeIDFieldNamestringThe route identifier field of a route feature class. This property will only be set for route feature classes, namely line and polyline feature classes that are m-aware.
databaseRelates[CIMDatabaseRelateInfo]Overrides for database relationships as relationship info. By default this property is null. This will contain relationship info elements for those database relationships that have overrides.
formInfoCIMFormInfoThe form information for the layer or table.

CIMFeatureTableDefinition

PropertyTypeDescription
dataConnectionDataConnectionThe data connection.
studyAreaAreaAn area that can be used to subset the rows in the virtual table.
studyAreaSpatialRelenumeration esriSpatialRelEnumThe study area spatial relationship.
searchOrderenumeration esriSearchOrderThe search order option.
isLicensedDataSourcebooleanA value indicating whether the data source is licensed.
definitionSetURIstringThe DefinitionSet for the table.

CIMFeatureTrajectorySubLayer

Represents the trajectory feature sublayer.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMFeatureLayerDefinition

PropertyTypeDescription
autoGenerateFeatureTemplatesbooleanA value indicating whether to automatically generate feature templates from the renderer. When this value is set to true, appropriate templates will be added to whenever the renderer is changed.
extrusionCIMFeatureExtrusionThe feature extrusion.
featureElevationExpressionstringThe feature elevation expression.
featureTableCIMFeatureTableThe feature table.
featureTemplates[CIMEditingTemplate]The feature templates.
htmlPopupEnabledbooleanA value indicating whether HTML pop-ups are enabled.
htmlPopupFormatCIMHtmlPopupFormatThe HTML pop-ups format.
isFlattenedbooleanA value indicating whether the layer is rasterized and draped against the surface in 3D scenes.
selectablebooleanA value indicating whether the layer is selectable.
selectionColorColorThe selection color. For polygons, this is used as the outline color.
polygonSelectionFillColorColorThe selection fill color. Only used for polygons.
selectionSymbolCIMSymbolReferenceThe selection symbol.
useSelectionSymbolbooleanA value indicating whether to use the selection symbol.
pageDefinitionCIMPageDefinitionThe page definition which allows for using current map series page to filter features.
featureCacheTypeenumeration FeatureCacheTypeThe feature cache type.
enableDisplayFiltersbooleanA value indicating whether the current set of display filters are honored during drawing.
displayFilters[CIMDisplayFilter]The current set of scale based display filters.
displayFiltersTypeenumeration DisplayFilterTypeDisplayFiltersType value.
displayFilterNamestringThe name of the active display filter.
displayFilterChoices[CIMDisplayFilter]The current set of display filters.
featureElevationExpressionInfoCIMExpressionInfoThe expression for setting the feature elevation.
featureBlendingModeenumeration BlendingModeThe per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.
featureSortInfos[CIMFeatureSortInfo]The collection of field names and sort directions used to sort features during draw.
layerEffectsModeenumeration LayerEffectsModeThe layer effects mode.
featureEffectsCIMFeatureLayerEffectThe collection of layer effects that apply to subset of features.

CIMGeoFeatureLayerDefinition

PropertyTypeDescription
actions[CIMLayerAction]The layer actions.
exclusionSet[long long]The set of excluded features.
featureMasks[CIMDataConnection]The data connection of the masking data.
labelClasses[CIMLabelClass]The collection of label class definitions.
labelVisibilitybooleanA value indicating whether to display labels for this layer's label classes.
maskedSymbolLayers[CIMSymbolLayerMasking]The masked symbol layers. Each SymbolLayerMasking gives the symbol layers that are masked by that masking layer.
rendererRendererThe primary symbol renderer.
scaleSymbolsbooleanA value indicating whether to scale the symbols in this layer based on the map's reference scale.
snappablebooleanA value indicating whether this layer participates in snapping in the editor.
symbolLayerDrawingCIMSymbolLayerDrawingThe symbol layer drawing properties.
trackLinesRendererRendererThe track renderer when displaying tracks.
previousObservationsRendererRendererThe previous observations renderer.
previousObservationsCountlongThe previous observation count.
useRealWorldSymbolSizesbooleanA value indicating whether to use real world symbols sizes (meters) vs. points. This value should always be in sync with the UseRealWorldSymbolSizes property at the symbol level.
showPreviousObservationsbooleanA value indicating whether previous observations are being drawn.
featureReductionFeatureReductionThe feature reduction technique in use by this layer.
showTracksbooleanA value indicating whether track lines are being drawn.

CIMTrajectorySubLayerDefinition

PropertyTypeDescription
trajectorySubLayerTypeenumeration TrajectorySubLayerTypeThe trajectory sublayer type.

CIMFieldDescription

Represents a field description.

CIMFieldDescription

PropertyTypeDescription
aliasstringThe field alias.
fieldNamestringThe field name.
highlightbooleanA value indicating whether the field is highlighted.
numberFormatNumberFormatThe number format.
readOnlybooleanA value indicating whether the field is read only.
visiblebooleanA value indicating whether the field is visible.
valueAsRatiobooleanA value indicating whether the field value is a ratio (used only by geoprocessing).
searchablebooleanA value indicating whether the values from this field should be included in the search.
searchModeenumeration DataSearchModeSearch mode to use when searching for values in this field.

CIMFloorAwareTableProperties

Represents floor-aware properties for the layer/table used in floor filtering.

CIMFloorAwareTableProperties

PropertyTypeDescription
floorFilterRankenumeration FloorFilterRankRank or "level" at which the layer/table participates in filtering for Indoors or floor-aware layers/tables.
floorFieldstringThe name of the field that carries the floor value used for floor filtering.
ZFilteringbooleanA value indicating whether Z value floor filtering will be used.

Enumeration: FloorFilterRank

Represents the rank or "level" at which the layer participates in filtering for Indoors or floor-aware layers.

PropertyValueDescription
None0Does not participate in floor filtering.
Site1Layer is an Indoors Site layer and will be filtered according to the selected site.
Facility2Layer is an Indoors Facility layer and will be filtered according to the selected facility or facilities within the selected site.
Level3Layer is a "floor-aware" layer and will be filtered according to the selected level or levels within the selected site.

CIMFolderConnection

Represents a folder connection.

CIMFolderConnection

PropertyTypeDescription
folderConnectionStringstringThe folder connection string.
aliasstringThe connection alias.

CIMGeometryLocationCondition

Represents geometry location condition.

CIMCondition

PropertyTypeDescription

CIMLocationCondition

PropertyTypeDescription
conditionTypeenumeration LocationConditionTypeThe location condition type.

CIMGeometryLocationCondition

PropertyTypeDescription
geometriesGeometryArrayThe geometries.

CIMGroupEditingTemplate

Represents a group editing template.

CIMEditingTemplate

PropertyTypeDescription
descriptionstringThe description.
namestringThe name.
tagsstringThe tags.
defaultToolGUIDstringThe default tool GUID.
excludedToolGUIDs[string]The excluded tool GUIDs.
toolOptions[CIMEditingTemplateToolOptions]The per-tool options.

CIMGroupEditingTemplate

PropertyTypeDescription
baseNamestringThe base name.
basePartCIMGroupEditingTemplatePartThe base part.
parts[CIMGroupEditingTemplatePart]The parts.
createUtilityNetworkAssociationsbooleanA value indicating whether this template will attempt to create associations between features being created. This property is only used with group templates in layers participating in a utility network.

CIMGroupEditingTemplatePart

Represents a group editing template part.

CIMGroupEditingTemplatePart

PropertyTypeDescription
layerURIstringThe URI of the layer this template is defined for.
namestringThe name.
transformationIDstringThe transformation ID.
options{JSON_object}The options.

CIMHighlightActivity

Represents a highlight activity.

CIMActivity

PropertyTypeDescription

CIMHighlightActivity

PropertyTypeDescription
highlightSymbolCIMSymbolReferenceThe highlight symbol.

CIMHtmlPopupFormat

Represents an HTML pop-up format.

CIMHtmlPopupFormat

PropertyTypeDescription
htmlRedirectFieldstringThe redirect field.
htmlRedirectFieldPrefixstringThe redirect field prefix.
htmlRedirectFieldSuffixstringThe redirect field suffix.
htmlXSLStyleSheetstringThe XSL style sheet.
htmlHideFieldNameColumnbooleanA value indicating whether of not to hide the field name column.
htmlUseCodedDomainValuesbooleanA value indicating whether of not to use coded domain values.
htmlPresentationStyleenumeration HtmlPopupStyleThe presentation style.

Enumeration: HtmlPopupStyle

HTML pop-up styles.

PropertyValueDescription
TwoColumnTable0A two column table.
RedirectedHTML1Redirected HTML.
XSLStyleSheet2An XSL style sheet.

CIMLayerAction

Represents a layer action.

CIMLayerAction

PropertyTypeDescription
namestringThe name.
activities[CIMActivity]Activities.
conditions[CIMCondition]Conditions.

CIMLayerRange

Represents a layer range.

CIMLayerRange

PropertyTypeDescription
layerURIstringThe URI of the layer this range is defined for.
rangeNamestringThe range name.
currentRangeCIMRangeThe current range.
currentRangeRelationenumeration RangeRelationThe current range relation.
isExclusionbooleanA value indicating whether or not this is an exclusion range.

Enumeration: LocationConditionType

Location condition types.

PropertyValueDescription
In0In.
Depart1Depart.
Out2Out.
Arrive3Arrive.
Cross4Cross.
Crossover5Crossover.

Enumeration: MappedOIDFieldType

A list of mapped OID field types.

PropertyValueDescription
OID32Bit4Mapped OID field type is 32 bit.
OID64Bit8Mapped OID field type is 64 bit.

CIMMaterializedViewProperties

Properties relevant to query layers based on materialized views.

CIMMaterializedViewProperties

PropertyTypeDescription
materializedViewQuerystringThe original definition of the materialized view.
materializedViewExpirationlongThe number of days after creating a materialized view that it is set to expire.

CIMMultipatchFeatureTemplate

Represents a multipatch feature template.

CIMEditingTemplate

PropertyTypeDescription
descriptionstringThe description.
namestringThe name.
tagsstringThe tags.
defaultToolGUIDstringThe default tool GUID.
excludedToolGUIDs[string]The excluded tool GUIDs.
toolOptions[CIMEditingTemplateToolOptions]The per-tool options.

CIMBasicRowTemplate

PropertyTypeDescription
defaultValues{JSON_object}The default values.
requiredFields[string]The required fields.
hiddenFields[string]The hidden fields.
relationships[CIMEditingTemplateRelationship]The template relationships.

CIMMultipatchFeatureTemplate

PropertyTypeDescription
galleryModebooleanA value indicating whether or not this is gallery mode.
models[CIMMultipatchFeatureTemplateModel]The models.

CIMMultipatchFeatureTemplateModel

Represents a multipatch feature template model.

CIMMultipatchTemplateModel

PropertyTypeDescription
isActivebooleanA value indicating whether or not this is active.
modelURIstringThe URI of the binary reference containing the model.
modelSourceURIstringThe file path to the original model source.
thumbnailURIstringThe URI of the binary reference containing the thumbnail.
cameraCIMViewCameraThe camera.

CIMNetCDFRasterDataConnection

Represents a NetCDF raster data connection.

CIMDataConnection

PropertyTypeDescription

CIMStandardDataConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.
datasetstringThe dataset name.
datasetTypeenumeration esriDatasetTypeThe dataset type.

CIMNetCDFRasterDataConnection

PropertyTypeDescription
bandDimensionstringThe band dimension.
extentEnvelopeThe extent.
invertRowsbooleanA value indicating whether or not to invert rows.
selectedDimensionIndexes[long]The selected dimension indexes.
selectedDimensions[string]The selected dimensions.
selectedDimensionValues[[any]]The selected dimension values.
variablestringThe variable.
verticalDimensionstringThe vertical dimension.
verticalDimensionUnitstringThe vertical dimension unit.
XDimensionstringThe X dimension.
YDimensionstringThe Y dimension.

CIMNetCDFStandardDataConnection

Represents a NetCDF standard data connection.

CIMDataConnection

PropertyTypeDescription

CIMStandardDataConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.
datasetstringThe dataset name.
datasetTypeenumeration esriDatasetTypeThe dataset type.

CIMNetCDFStandardDataConnection

PropertyTypeDescription
variableList[string]The variable list.
rowDimensionList[string]The row dimension list.
XDimensionstringThe X dimension.
YDimensionstringThe Y dimension.
ZDimensionstringThe Z dimension.
MDimensionstringThe M dimension.
selectedDimensions[string]The selected dimensions.
selectedDimensionIndexes[long]The selected dimension indexes.
selectedDimensionValues[[any]]The selected dimension values.
shapeFieldNamestringThe shape field name.
verticalDimensionstringThe vertical dimension.
verticalDimensionUnitstringThe vertical dimension unit.
selectedVolumestringThe selected volume in a multi-volume dataset.

CIMOrientedImageryLayer

Represents an oriented imagery layer.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMFeatureLayerDefinition

PropertyTypeDescription
autoGenerateFeatureTemplatesbooleanA value indicating whether to automatically generate feature templates from the renderer. When this value is set to true, appropriate templates will be added to whenever the renderer is changed.
extrusionCIMFeatureExtrusionThe feature extrusion.
featureElevationExpressionstringThe feature elevation expression.
featureTableCIMFeatureTableThe feature table.
featureTemplates[CIMEditingTemplate]The feature templates.
htmlPopupEnabledbooleanA value indicating whether HTML pop-ups are enabled.
htmlPopupFormatCIMHtmlPopupFormatThe HTML pop-ups format.
isFlattenedbooleanA value indicating whether the layer is rasterized and draped against the surface in 3D scenes.
selectablebooleanA value indicating whether the layer is selectable.
selectionColorColorThe selection color. For polygons, this is used as the outline color.
polygonSelectionFillColorColorThe selection fill color. Only used for polygons.
selectionSymbolCIMSymbolReferenceThe selection symbol.
useSelectionSymbolbooleanA value indicating whether to use the selection symbol.
pageDefinitionCIMPageDefinitionThe page definition which allows for using current map series page to filter features.
featureCacheTypeenumeration FeatureCacheTypeThe feature cache type.
enableDisplayFiltersbooleanA value indicating whether the current set of display filters are honored during drawing.
displayFilters[CIMDisplayFilter]The current set of scale based display filters.
displayFiltersTypeenumeration DisplayFilterTypeDisplayFiltersType value.
displayFilterNamestringThe name of the active display filter.
displayFilterChoices[CIMDisplayFilter]The current set of display filters.
featureElevationExpressionInfoCIMExpressionInfoThe expression for setting the feature elevation.
featureBlendingModeenumeration BlendingModeThe per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.
featureSortInfos[CIMFeatureSortInfo]The collection of field names and sort directions used to sort features during draw.
layerEffectsModeenumeration LayerEffectsModeThe layer effects mode.
featureEffectsCIMFeatureLayerEffectThe collection of layer effects that apply to subset of features.

CIMGeoFeatureLayerDefinition

PropertyTypeDescription
actions[CIMLayerAction]The layer actions.
exclusionSet[long long]The set of excluded features.
featureMasks[CIMDataConnection]The data connection of the masking data.
labelClasses[CIMLabelClass]The collection of label class definitions.
labelVisibilitybooleanA value indicating whether to display labels for this layer's label classes.
maskedSymbolLayers[CIMSymbolLayerMasking]The masked symbol layers. Each SymbolLayerMasking gives the symbol layers that are masked by that masking layer.
rendererRendererThe primary symbol renderer.
scaleSymbolsbooleanA value indicating whether to scale the symbols in this layer based on the map's reference scale.
snappablebooleanA value indicating whether this layer participates in snapping in the editor.
symbolLayerDrawingCIMSymbolLayerDrawingThe symbol layer drawing properties.
trackLinesRendererRendererThe track renderer when displaying tracks.
previousObservationsRendererRendererThe previous observations renderer.
previousObservationsCountlongThe previous observation count.
useRealWorldSymbolSizesbooleanA value indicating whether to use real world symbols sizes (meters) vs. points. This value should always be in sync with the UseRealWorldSymbolSizes property at the symbol level.
showPreviousObservationsbooleanA value indicating whether previous observations are being drawn.
featureReductionFeatureReductionThe feature reduction technique in use by this layer.
showTracksbooleanA value indicating whether track lines are being drawn.

CIMOrientedImageryLayerDefinition

PropertyTypeDescription
orientedImageryPropertyOverrides{JSON_object}The overrides for editable properties of the oriented imagery dataset on the layer.

CIMPageDefinition

Represents page definition.

CIMPageDefinition

PropertyTypeDescription
pageFieldNamestringThe page field name. Show features where the value of this field either matches or doesn't match the current map series page name. Match versus don't match is controlled by ExcludePages.
excludePagesbooleanA value indicating whether to exclude pages. Specify false to show features that match or true to show features that don't match.

CIMParcelFabricActiveRecord

Defines the parcel fabric active record properties needed for record-driven parcel workflows.

CIMParcelFabricActiveRecord

PropertyTypeDescription
activeRecordstringThe active record GlobalID.
enabledbooleanA value indicating whether or not there is an active record.
showActiveRecordOnlybooleanA value indicating whether to show only the features associated with the active record in the map.

CIMParcelFabricLayer

Represents a parcel fabric layer.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMParcelFabricLayerDefinition

PropertyTypeDescription
accuracyTablestringThe path of the accuracy table.
allLayers[string]The paths of the layers in the parcel fabric layer.
adjustmentsTablestringThe path of the adjustments table.
cadastralFabricConnectionDataConnectionThe data connection to the fabric.
controlPointLayerstringThe path of the control point layer.
controlPointSelectionSymbolCIMSymbolReferenceThe control point selection symbol.
jobsTablestringThe path to the jobs table.
lineLayerstringThe path to the line layer.
linePointLayerstringThe path to the line point layer.
parcelLayerstringThe path to the parcel layer.
plansTablestringThe path to the plans table.
pointLayerstringThe path to the point layer.

CIMParcelLayer

Represents a parcel fabric layer.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMParcelLayerDefinition

PropertyTypeDescription
recordsLayerstringThe path to the parcel polygon records layer. The records layer links parcel polygons and lines to the legal record that created / retired it as well as integration point to business systems.
parcelConnectionDataConnectionThe data connection to the Parcel Fabric. A Parcel Fabric controls simple feature classes and uses topology rules and parcel rules. Parcel geometry is edited using feature services The Parcel Layer provides additional services to control the fabric classes such as validate.
parcelFabricActiveRecordCIMParcelFabricActiveRecordThe Parcel Fabric Active Record properties.

CIMRange

Represents a range.

CIMRange

PropertyTypeDescription
mindoubleThe minimum.
maxdoubleThe maximum.

CIMRangeDefinition

Represents a range definition.

CIMRangeDefinition

PropertyTypeDescription
namestringThe name.
fieldNamestringThe field name. Used as the start field name when an end field name is set.
endFieldNamestringThe end field name.
uniqueValues[double]A cached set of unique range values.
currentRangeCIMRangeThe current range.
currentRangeRelationenumeration RangeRelationThe current range relation.
customFullExtentCIMRangeThe custom full extent.
isExclusionbooleanA value indicating whether or not range is exclusion.
aliasExpressionInfoCIMExpressionInfoExpressionInfo that contains the Arcade expression that returns a string representing range alias value.

CIMRangeVariable

Represents a range variable.

CIMBindVariable

PropertyTypeDescription
variableNamestringThe name of the variable. The name must be unique among all variables.
aliasstringThe alias of the variable.
dataTypeenumeration BindVariableTypeThe type of the variable.

CIMRangeVariable

PropertyTypeDescription
fieldExpressionstringThe field for which the value range will be specified.
optionalbooleanA value indicating whether this variable is optional. If not, default values must be provided.
defaultMinanyThe default minimum value.
defaultMaxanyThe default maximum value.
tableNamestringThe name of the table to which the field in FieldExpression belongs.
valueIfMissingbooleanA value indicating whether the resulting expression should take if the variable is optional and no value is passed.

CIMRasterTable

Represents a raster table.

CIMDisplayTableDefinition

PropertyTypeDescription
definitionExpressionstringThe definition expression that can subset the rows in the layer or table.
definitionExpressionNamestringThe name of the active definition expression.
definitionFilterChoices[CIMDefinitionFilter]The definition filter choices.
displayFieldstringThe name of the attribute field that will be used as a label that represents each row in the layer or table. The display field must be able to be represented as a string (string or numeric).
editablebooleanA value indicating whether or not the layer or table can be edited.
relates[CIMRelateInfoBase]The relates.
fieldDescriptions[CIMFieldDescription]The field descriptions. Field descriptions for fields may only be written if values are overridden from defaults.
timeFieldsCIMTimeTableDefinitionThe time fields.
timeDefinitionCIMTimeDataDefinitionThe time definition.
timeDisplayDefinitionCIMTimeDisplayDefinitionThe time display definition.
timeDimensionFieldsCIMTimeDimensionDefinitionThe time definition fields.
rangeDefinitions[CIMRangeDefinition]The range definitions.
activeRangeNamestringThe active range name.
selectRelatedDatabooleanA value indicating whether related data should be selected when creating a new selection.
bindVariables[CIMBindVariable]The bind variables.
subtypeValuelongThe subtype value that should be used in the feature layer definition. This property is honored only when feature layer is a member of SubtypeLayer.
useSubtypeValuebooleanA value indicating whether or not the SubtypeValue should be used.
displayExpressionInfoCIMExpressionInfoThe expression information used for coming up with a string that represents a row or a feature. This property takes precedence over .
selectionSetURIstringThe URI of the selection set for the layer or table.
floorAwareTablePropertiesCIMFloorAwareTablePropertiesFloor-aware properties for the layer or table used in floor filtering.
routeIDFieldNamestringThe route identifier field of a route feature class. This property will only be set for route feature classes, namely line and polyline feature classes that are m-aware.
databaseRelates[CIMDatabaseRelateInfo]Overrides for database relationships as relationship info. By default this property is null. This will contain relationship info elements for those database relationships that have overrides.
formInfoCIMFormInfoThe form information for the layer or table.

CIMRasterTableDefinition

PropertyTypeDescription
joinsDataConnectionThe joins as a data connection.

CIMRelQueryTableDataConnection

Represents a RelQuery table data connection.

CIMDataConnection

PropertyTypeDescription

CIMRelQueryTableDataConnection

PropertyTypeDescription
sourceTableDataConnectionThe source table data connection.
destinationTableDataConnectionThe destination table.
primaryKeystringThe primary key.
foreignKeystringThe foreign key.
namestringThe name.
cardinalityenumeration esriRelCardinalityThe join cardinality.
joinTypeenumeration esriJoinTypeThe join type.
joinForwardbooleanA value indicating whether or not this is a forward join.
oneToFirstbooleanA value indicating whether or not the join will be one-to-first.

CIMRelateInfo

Represents relate info.

CIMRelateInfo

PropertyTypeDescription
dataConnectionDataConnectionThe relate data connection.
foreignKeystringThe foreign key.
primaryKeystringThe primary key.
cardinalityenumeration esriRelCardinalityThe relate cardinality.
namestringThe name.
serviceRelateIDlongA integer indicating the relate ID when published in a map service.
relatedMapMemberURIstringThe related layer/table URI. This value is used to disambiguate cases where the same data connection is used by multiple layers or tables in a map.

CIMRouteEventDataConnection

Represents a route event data connection.

CIMDataConnection

PropertyTypeDescription

CIMRouteEventDataConnection

PropertyTypeDescription
routeFeatureClassDataConnectionThe data connection for the route feature class.
routeIDFieldNamestringThe route identifier field of the route feature class.
routeWhereClausestringThe where clause that limits the routes that events can be located on.
routeMeasureUnitUnitThe route measure units.
eventMeasureUnitUnitThe units of the event measure(s).
eventRouteIDFieldNamestringThe route identifier field name.
isLineEventbooleanA value indicating whether or not this is a line event.
lateralOffsetFieldNamestringThe lateral offset field name.
MDirectionOffsettingbooleanA value indicating whether the offset should based on the M direction or the digitized direction.
errorFieldNamestringThe error field name.
addErrorFieldbooleanA value indicating whether an error field should be added to the field set.
fromMeasureFieldNamestringThe from measure field name.
toMeasureFieldNamestringThe to measure field name.
addAngleFieldbooleanA value indicating whether an angle field should be added to the field set.
angleFieldNamestringThe angle field name.
asPointFeaturebooleanA value indicating whether the point event shape should be output as a multipoint or a point.
complementAnglebooleanA value indicating whether 180 degrees should be added to the angle field value.
normalAnglebooleanA value indicating whether the angle field should be the normal or the tangent angles.
eventTableDataConnectionThe data connection for the route events.

CIMRowTemplate

Represents a row template.

CIMEditingTemplate

PropertyTypeDescription
descriptionstringThe description.
namestringThe name.
tagsstringThe tags.
defaultToolGUIDstringThe default tool GUID.
excludedToolGUIDs[string]The excluded tool GUIDs.
toolOptions[CIMEditingTemplateToolOptions]The per-tool options.

CIMBasicRowTemplate

PropertyTypeDescription
defaultValues{JSON_object}The default values.
requiredFields[string]The required fields.
hiddenFields[string]The hidden fields.
relationships[CIMEditingTemplateRelationship]The template relationships.

CIMRowTemplate

PropertyTypeDescription

CIMS101DisplaySettings

Represents S-101 portrayal settings.

CIMENCDisplaySettings

PropertyTypeDescription

CIMS101DisplaySettings

PropertyTypeDescription
contextParameters{JSON_object}The catalogue context parameter values.
displayPlanes{JSON_object}The catalogue display plane values.
viewingGroupLayers{JSON_object}The catalogue viewing group layer values. Setting viewing group layers values may override viewing group values. This also applies to viewing group layers that contain the same viewing groups, for example "Chart text".
viewingGroups{JSON_object}The catalogue viewing group values.
colorPalettestringThe color palette value.
displayModestringThe display mode value.

Enumeration: S52AreaSymbolizationType

ENC area symbolization type. This is used to specify whether areas should be symbolized with plain or traditional symbols.

PropertyValueDescription
Plain0Use plain symbols.
Symbolized1Use traditional symbols.

Enumeration: S52ColorScheme

ENC Color Schemes.

PropertyValueDescription
Day0Day.
Dusk1Dusk.
Night2Night.

Enumeration: S52DepthDisplayUnits

ENC Depth Display Units.

PropertyValueDescription
Meters0Meters.
Feet1Feet.
Fathoms2Fathoms.

CIMS52DisplaySettings

Represents S-52 display settings.

CIMENCDisplaySettings

PropertyTypeDescription

CIMS52DisplaySettings

PropertyTypeDescription
marinerSettingsCIMS52MarinerSettingsThe S-52 display properties for the layer.
textGroupVisibilitySettingsCIMS52TextGroupVisibilitySettingsThe S-52 text group properties for the layer.
viewingGroupSettingsCIMS52ViewingGroupSettingsThe S-52 view group properties for the layer.

CIMS52MarinerSettings

Represents S-52 mariner settings object for controlling the drawing of ENC layers.

CIMS52MarinerSettings

PropertyTypeDescription
areaSymbolizationTypeenumeration S52AreaSymbolizationTypeThe area symbolization type. This controls the line symbol style for area boundaries.
colorSchemeenumeration S52ColorSchemeThe color scheme.
showDataQualitybooleanA value indicating whether to display data quality (M_QUAL) for S-57 features.
deepContourdoubleThe deep water contour depth in meters. This must be greater than or equal to the safety contour value. When four(rather than two) depth shades are used, this controls the boundary between safe and deep areas.
showDisplayBasebooleanA value indicating whether the S-52 "displaybase" display category is enabled.
showOtherDisplaybooleanA value indicating whether the S-52 "other" display category is enabled.
showStandardDisplaybooleanA value indicating whether the S-52 "standard" display category is enabled.
depthDisplayUnitsenumeration S52DepthDisplayUnitsThe depth units (meters/feet/fathoms) for display.
showNOBJNMbooleanA value indicating whether to display the national name attribute on S-57 features. This is text group 31 per IHO S-52 Annex A.
honorSCAMINbooleanA value indicating whether the 'SCAMIN' (scale min) S-57 feature attribute will be used. If disabled, all ENC features will be rendered regardless of scale.
showIsolatedDangersbooleanA value indicating whether to display isolated dangers in shallow water. This is viewing group 24020, 24050 per IHO 2-52 Annex A.
labelContoursbooleanA value indicating whether to display the depth contour labels, including safety contour labels. This is viewing group 33021, 33022 per IHO S-52 Annex A.
labelSafetyContoursbooleanA value indicating whether to display the safety contour labels.
showLowAccuracybooleanA value indicating whether to use low accuracy symbols (CATZOC). This is viewing group 31010 per IHO S-52 Annex A. When low accuracy is set to false, low accuracy data will be visually indistinguishable from other data.
pointSymbolizationTypeenumeration S52PointSymbolizationTypeThe S-52 point feature symbolization type (simplified/paperchart). Paperchart symbolization is based on traditional paper charts. Simplified symbols are more compact and visible.
safetyContourdoubleThe depth of the safety contour in meters.
shallowContourdoubleThe depth of the shallow contour in meters. This must be less than or equal to the safety contour value. When four(rather than two) depth shades are used, this value controls the separation between shallow and unsafe areas.
showShallowDepthPatternbooleanA value indicating whether the shallow depth pattern will be symbolized.
showTwoDepthShadesbooleanA value indicating whether two or four depth shades will be used; two is the default.

Enumeration: S52PointSymbolizationType

ENC point symbolization options. This is used to specify whether point features should be symbolized with simplified or paperchart symbols.

PropertyValueDescription
PaperChart0Paper chart symbols which are based on traditional paper charts.
Simplified1Simplified symbols which are more compact and visible.

CIMS52TextGroupVisibilitySettings

Represents S-52 text group settings.

CIMS52TextGroupVisibilitySettings

PropertyTypeDescription
showBerthNumberbooleanA value indicating whether the "berth number" text group should be visible. Per IHO S-52 Annex A, controls text group 29, which includes OBJNAM from BERTHS and ACHBRT.
showCurrentVelocitybooleanA value indicating whether the "current velocity" text group should be visible. Per IHO S-52 Annex A, controls text group 30, which includes CURVEL.
showGeographicNamesbooleanA value indicating whether the "geographic names" text group should be visible. Per IHO S-52 Annex A, controls text group 26, which includes OBJNAM from ACHARE, BRIDGE, BUAARE, BUISGL, DOCARE, FAIRWY, LNDARE, LNDMARK, LNDRGN, SEAARE, TIDEWY, and PILBOP.
showHeightOfIsletOrLandFeaturebooleanA value indicating whether the "height of islet or land feature" text group should be visible. Per IHO S-52 Annex A, controls text group 28, which includes HEIGHT of LNDARE.
showImportantTextbooleanA value indicating whether the "important text" text group should be visible. Per IHO S-52 Annex A, controls text groups 10 and 11.
showLightDescriptionbooleanA value indicating whether the "light descriptions" text group should be visible. Per IHO S-52 Annex A, controls text group 23.
showMagneticVariationAndSweptDepthbooleanA value indicating whether the "magnetic variation and swept depth" text group should be visible. Per IHO S-52 Annex A, controls text group 27, which includes MAGVAR, VALMAG, SWPARE, and DRVAL1.
showNamesForPositionReportingbooleanA value indicating whether the "names for position reporting" text group should be visible. Per IHO S-52 Annex A, controls text group 21.
showNatureOfSeabedbooleanA value indicating whether the "nature of seabed" text group should be visible. Per IHO S-52 Annex A, controls text group 25, which includes SBDARE and NATSUR.
showNoteOnChartDatabooleanA value indicating whether the "note on chart data" text group should be visible. Per IHO S-52 Annex A, controls text group 24.

CIMS52ViewingGroupSettings

Represents S-52 viewing group properties object.

CIMS52ViewingGroupSettings

PropertyTypeDescription
showAllIsolatedDangersboolean// Viewing Group settings a value indicating whether the "all isolated dangers" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 13, which includes viewing groups 34050 and 34051.
showArchipelagicSeaLanesbooleanA value indicating whether the "archipelagic sea lanes" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 9, which includes viewing group 26260.
showBoundariesAndLimitsbooleanA value indicating whether the "boundaries and limits" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 4, which includes viewing groups 23030, 26050, 26220, 26240, and 26250.
showBuoysBeaconsAidsToNavigationbooleanA value indicating whether the "buoys, beacons, aids to navigation" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 3, which includes viewing groups 21020, 22200 ? 22240, 27000, 27010, 27011, 27020, 27025, 27040, 27050, 27070, 27080, 27200, 27210, 27230, 27030, and 27060.
showBuoysBeaconsStructuresbooleanA value indicating whether the "buoys, beacons, structures" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 3.1, which includes viewing groups 21010, 21020, 22200 - 22240, 27000-27050, 27080, 27200 ? 27230, 27030, and 27060.
showChartScaleBoundariesbooleanA value indicating whether the "chart scale boundaries" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 6, which includes viewing group 21030.
showDepthContoursbooleanA value indicating whether the "depth contours" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 15, which includes viewing group 33020.
showDryingLinebooleanA value indicating whether the "drying line" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 2, which includes viewing group 22010.
showLightsbooleanA value indicating whether the "lights" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 3.2, which includes viewing group 27070.
showMagneticVariationbooleanA value indicating whether the "magnetic variation" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 14, which includes viewing group 31080.
showOtherMiscellaneousbooleanA value indicating whether the "other miscellaneous" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 18, which includes viewing group 30000-39999.
showProhibitedAndRestrictedAreasbooleanA value indicating whether the "prohibited and restricted areas" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 5, which includes viewing groups 2600, 26010, and 26040.
showSeabedbooleanA value indicating whether the "seabed" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 16, which includes viewing groups 34010, 34020, and 33040.
showShipsRoutingSystemsAndFerryRoutesbooleanA value indicating whether the "ships' routing systems and ferry routes" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 8, which includes viewing groups 25010-25060.
showSpotSoundingsbooleanA value indicating whether the "spot soundings" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 11, which includes viewing group 33010.
showStandardMiscellaneousbooleanA value indicating whether the "standard miscellaneous" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 10 under the "standard display" viewing group, which includes all objects not covered by viewing groups 20000-29999.
showSubmarineCablesAndPipelinesbooleanA value indicating whether the "submarine cables and pipelines" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 12, which includes viewing groups 34030 and 34070.
showTidalbooleanA value indicating whether the "tidal" viewing group is enabled. Per IHO S-52 Annex A, controls viewing group layer 17, which includes viewing groups 33050 and 33060.

CIMSqlQueryDataConnection

Represents a SQL query data connection.

CIMDataConnection

PropertyTypeDescription

CIMStandardDataConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.
datasetstringThe dataset name.
datasetTypeenumeration esriDatasetTypeThe dataset type.

CIMSqlQueryDataConnection

PropertyTypeDescription
sqlQuerystringThe SQL query.
sridstringThe SRID of the spatial reference.
spatialReferenceSpatialReferenceThe spatial reference.
OIDFieldsstringThe OID fields.
geometryTypeenumeration esriGeometryTypeThe geometry type.
extentEnvelopeThe extent.
queryFieldsFields
spatialStorageTypelongThe spatial storage type.
sridTypelongThe SRID type. Only used for query layers based on Oracle Spatial (SDO) storage. This property is managed by the system as an optimization.
spatialIndexDimensionlongThe spatial index dimension. Only used for query layers based on Oracle Spatial (SDO) storage. This property is managed by the system as an optimization.
isTableBasedbooleanA value indicating whether the query is "table based" (retrieves all the columns from the table and has no where clause or postfix clause). This property is used as an optimization and is typically set by the system.
materializedViewPropertiesCIMMaterializedViewPropertiesThe properties relevant to materialized view-based query layers.
mappedOIDFieldLengthenumeration MappedOIDFieldTypeA value indicating whether the auto generated Esri OID field will be 32-bit or 64-bit.

CIMStandaloneTable

Represents a standalone table.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMDisplayTableDefinition

PropertyTypeDescription
definitionExpressionstringThe definition expression that can subset the rows in the layer or table.
definitionExpressionNamestringThe name of the active definition expression.
definitionFilterChoices[CIMDefinitionFilter]The definition filter choices.
displayFieldstringThe name of the attribute field that will be used as a label that represents each row in the layer or table. The display field must be able to be represented as a string (string or numeric).
editablebooleanA value indicating whether or not the layer or table can be edited.
relates[CIMRelateInfoBase]The relates.
fieldDescriptions[CIMFieldDescription]The field descriptions. Field descriptions for fields may only be written if values are overridden from defaults.
timeFieldsCIMTimeTableDefinitionThe time fields.
timeDefinitionCIMTimeDataDefinitionThe time definition.
timeDisplayDefinitionCIMTimeDisplayDefinitionThe time display definition.
timeDimensionFieldsCIMTimeDimensionDefinitionThe time definition fields.
rangeDefinitions[CIMRangeDefinition]The range definitions.
activeRangeNamestringThe active range name.
selectRelatedDatabooleanA value indicating whether related data should be selected when creating a new selection.
bindVariables[CIMBindVariable]The bind variables.
subtypeValuelongThe subtype value that should be used in the feature layer definition. This property is honored only when feature layer is a member of SubtypeLayer.
useSubtypeValuebooleanA value indicating whether or not the SubtypeValue should be used.
displayExpressionInfoCIMExpressionInfoThe expression information used for coming up with a string that represents a row or a feature. This property takes precedence over .
selectionSetURIstringThe URI of the selection set for the layer or table.
floorAwareTablePropertiesCIMFloorAwareTablePropertiesFloor-aware properties for the layer or table used in floor filtering.
routeIDFieldNamestringThe route identifier field of a route feature class. This property will only be set for route feature classes, namely line and polyline feature classes that are m-aware.
databaseRelates[CIMDatabaseRelateInfo]Overrides for database relationships as relationship info. By default this property is null. This will contain relationship info elements for those database relationships that have overrides.
formInfoCIMFormInfoThe form information for the layer or table.

CIMStandaloneTableDefinition

PropertyTypeDescription
dataConnectionDataConnectionThe data connection for the table.
descriptionstringThe description.
autoGenerateRowTemplatesbooleanA value indicating whether to automatically generate row templates from the renderer.
rowTemplates[CIMEditingTemplate]The row templates.
serviceTableIDlongIdentifier that will be used to identify the layer in server.
showPopupsbooleanA value indicating whether or not to show pop-ups.
popupInfoCIMPopupInfoThe pop-up info.
charts[CIMChart]The table's charts.
pageDefinitionCIMPageDefinitionThe page definition which allows for using current map series page to filter rows.
customProperties[CIMStringMap]The custom properties of the standalone table. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapTableIDstringAn identifier that will be used to identify the standalone table in a web map. This value is present if the standalone table originated in a web map and facilitates matching the standalone table back to its origin when updating the web map.
searchablebooleanA value indicating whether or not this table should be included in the search. This property is honored only by tables that support search.
useVisibilityTimeExtentbooleanA value indicating whether or not to use the visibility time extent. When true the map time must overlap the visibility time extent for the table to be visible.
visibilityTimeExtentTimeExtentThe visibility time extent.

CIMStandardDataConnection

Represents a standard data connection, the most common data connection type.

CIMDataConnection

PropertyTypeDescription

CIMServiceDataConnectionProperties

PropertyTypeDescription
customParameters[CIMStringMap]Vendor specific parameters.

CIMStandardDataConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.
datasetstringThe dataset name.
datasetTypeenumeration esriDatasetTypeThe dataset type.

Enumeration: StandardDeviationMultiplier

Standard deviation multiplier to define min and max data values from the mean for binning levels.

PropertyValueDescription
None0No multiplier, use full data range.
OneFourth1Use one fourth of the standard deviation to define data range.
OneThird2Use one third of the standard deviation to define data range.
OneHalf3Use one half of the standard deviation to define data range.
One4Use one standard deviation to define data range.
Two5Use two standard deviations to define data range.
Custom6Allow users to define custom data range.

CIMStreamServiceDataConnection

Represents a stream service data connection.

CIMDataConnection

PropertyTypeDescription

CIMStandardDataConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.
datasetstringThe dataset name.
datasetTypeenumeration esriDatasetTypeThe dataset type.

CIMStreamServiceDataConnection

PropertyTypeDescription
featureExpirationMethodenumeration FeatureExpirationMethodFeature expiration method used at dataset level.
maximumFeatureCountlong longThe maximum number of features that are held in memory before features are discarded.
maximumFeatureAgelong longThe maximum age for each feature before the feature is discarded.

CIMSubtypeGroupLayer

Represents a subtype group layer that works with feature classes enabled with subtypes. A subtype layer is a group layer that contains feature layers, each of which represents a subtype in a feature class.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMFeatureLayerDefinition

PropertyTypeDescription
autoGenerateFeatureTemplatesbooleanA value indicating whether to automatically generate feature templates from the renderer. When this value is set to true, appropriate templates will be added to whenever the renderer is changed.
extrusionCIMFeatureExtrusionThe feature extrusion.
featureElevationExpressionstringThe feature elevation expression.
featureTableCIMFeatureTableThe feature table.
featureTemplates[CIMEditingTemplate]The feature templates.
htmlPopupEnabledbooleanA value indicating whether HTML pop-ups are enabled.
htmlPopupFormatCIMHtmlPopupFormatThe HTML pop-ups format.
isFlattenedbooleanA value indicating whether the layer is rasterized and draped against the surface in 3D scenes.
selectablebooleanA value indicating whether the layer is selectable.
selectionColorColorThe selection color. For polygons, this is used as the outline color.
polygonSelectionFillColorColorThe selection fill color. Only used for polygons.
selectionSymbolCIMSymbolReferenceThe selection symbol.
useSelectionSymbolbooleanA value indicating whether to use the selection symbol.
pageDefinitionCIMPageDefinitionThe page definition which allows for using current map series page to filter features.
featureCacheTypeenumeration FeatureCacheTypeThe feature cache type.
enableDisplayFiltersbooleanA value indicating whether the current set of display filters are honored during drawing.
displayFilters[CIMDisplayFilter]The current set of scale based display filters.
displayFiltersTypeenumeration DisplayFilterTypeDisplayFiltersType value.
displayFilterNamestringThe name of the active display filter.
displayFilterChoices[CIMDisplayFilter]The current set of display filters.
featureElevationExpressionInfoCIMExpressionInfoThe expression for setting the feature elevation.
featureBlendingModeenumeration BlendingModeThe per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.
featureSortInfos[CIMFeatureSortInfo]The collection of field names and sort directions used to sort features during draw.
layerEffectsModeenumeration LayerEffectsModeThe layer effects mode.
featureEffectsCIMFeatureLayerEffectThe collection of layer effects that apply to subset of features.

CIMSubtypeGroupLayerDefinition

PropertyTypeDescription
subtypeLayers[string]The layer URI corresponding to each subtype value.

CIMSubtypeGroupTable

Represents a subtype group table that works with tables enabled with subtypes.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMStandaloneTableDefinition

PropertyTypeDescription
dataConnectionDataConnectionThe data connection for the table.
descriptionstringThe description.
autoGenerateRowTemplatesbooleanA value indicating whether to automatically generate row templates from the renderer.
rowTemplates[CIMEditingTemplate]The row templates.
serviceTableIDlongIdentifier that will be used to identify the layer in server.
showPopupsbooleanA value indicating whether or not to show pop-ups.
popupInfoCIMPopupInfoThe pop-up info.
charts[CIMChart]The table's charts.
pageDefinitionCIMPageDefinitionThe page definition which allows for using current map series page to filter rows.
customProperties[CIMStringMap]The custom properties of the standalone table. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapTableIDstringAn identifier that will be used to identify the standalone table in a web map. This value is present if the standalone table originated in a web map and facilitates matching the standalone table back to its origin when updating the web map.
searchablebooleanA value indicating whether or not this table should be included in the search. This property is honored only by tables that support search.
useVisibilityTimeExtentbooleanA value indicating whether or not to use the visibility time extent. When true the map time must overlap the visibility time extent for the table to be visible.
visibilityTimeExtentTimeExtentThe visibility time extent.

CIMDisplayTableDefinition

PropertyTypeDescription
definitionExpressionstringThe definition expression that can subset the rows in the layer or table.
definitionExpressionNamestringThe name of the active definition expression.
definitionFilterChoices[CIMDefinitionFilter]The definition filter choices.
displayFieldstringThe name of the attribute field that will be used as a label that represents each row in the layer or table. The display field must be able to be represented as a string (string or numeric).
editablebooleanA value indicating whether or not the layer or table can be edited.
relates[CIMRelateInfoBase]The relates.
fieldDescriptions[CIMFieldDescription]The field descriptions. Field descriptions for fields may only be written if values are overridden from defaults.
timeFieldsCIMTimeTableDefinitionThe time fields.
timeDefinitionCIMTimeDataDefinitionThe time definition.
timeDisplayDefinitionCIMTimeDisplayDefinitionThe time display definition.
timeDimensionFieldsCIMTimeDimensionDefinitionThe time definition fields.
rangeDefinitions[CIMRangeDefinition]The range definitions.
activeRangeNamestringThe active range name.
selectRelatedDatabooleanA value indicating whether related data should be selected when creating a new selection.
bindVariables[CIMBindVariable]The bind variables.
subtypeValuelongThe subtype value that should be used in the feature layer definition. This property is honored only when feature layer is a member of SubtypeLayer.
useSubtypeValuebooleanA value indicating whether or not the SubtypeValue should be used.
displayExpressionInfoCIMExpressionInfoThe expression information used for coming up with a string that represents a row or a feature. This property takes precedence over .
selectionSetURIstringThe URI of the selection set for the layer or table.
floorAwareTablePropertiesCIMFloorAwareTablePropertiesFloor-aware properties for the layer or table used in floor filtering.
routeIDFieldNamestringThe route identifier field of a route feature class. This property will only be set for route feature classes, namely line and polyline feature classes that are m-aware.
databaseRelates[CIMDatabaseRelateInfo]Overrides for database relationships as relationship info. By default this property is null. This will contain relationship info elements for those database relationships that have overrides.
formInfoCIMFormInfoThe form information for the layer or table.

CIMStandaloneTableContainer

PropertyTypeDescription
standaloneTables[string]The standalone tables as an array of table repository paths.

CIMSubtypeGroupTableDefinition

PropertyTypeDescription
expandedbooleanA value indicating whether this group table is expanded in the contents pane.

CIMSuppressActivity

Represents suppress activity.

CIMActivity

PropertyTypeDescription

CIMSuppressActivity

PropertyTypeDescription

CIMSymbolIdentifier

Represents a symbol identifier.

CIMSymbolIdentifier

PropertyTypeDescription
IDlongThe ID which identifies the symbol in the collection.
namestringThe name of the symbol in the symbol collection.
symbolSymbolThe symbol.

CIMSymbolLayerMasking

Represents symbol layer masking.

CIMSymbolLayerMasking

PropertyTypeDescription
symbolLayers[CIMSymbolLayerIdentifier]The symbol layer identifiers.

Enumeration: SymbolSubstitutionType

Symbol substitution types.

PropertyValueDescription
None0No symbol substitution.
Color1Substitute color.
IndividualSubordinate2Substitute individual symbols in the collection with overrides taking precedence to symbols.
IndividualDominant3Substitute individual symbols in the collection with the symbol taking precedence to overrides.

CIMTableQueryNameDataConnection

Represents a table query name data connection.

CIMDataConnection

PropertyTypeDescription

CIMStandardDataConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.
datasetstringThe dataset name.
datasetTypeenumeration esriDatasetTypeThe dataset type.

CIMTableQueryNameDataConnection

PropertyTypeDescription
subFieldsstringThe subfields.
tablesstringThe tables.
whereClausestringThe where clause.
primaryKeyFieldsstringThe primary key fields.
copyLocallybooleanA value indicating whether or not to copy data locally.
shapeTypeenumeration esriGeometryTypeThe shape type.
featureTypeenumeration esriFeatureTypeThe feature type.
extentEnvelopeThe extent.
shapeFieldNamestringThe shape field name.

CIMTemporalDataConnection

Represents a temporal data connection.

CIMDataConnection

PropertyTypeDescription

CIMStandardDataConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.
datasetstringThe dataset name.
datasetTypeenumeration esriDatasetTypeThe dataset type.

CIMTemporalDataConnection

PropertyTypeDescription
timeFieldLocaleIDlongThe time field locale ID.
timeFieldAmFormatstringThe custom string representation of the AM symbol.
timeFieldPmFormatstringThe custom string representation of the PM symbol.
cachingModeenumeration TemporalFeatureClassCachingModeThe caching mode.
startTimeFieldstringThe start time field.
endTimeFieldstringThe end time field.
timeValueFormatstringThe time value format.
trackIDFieldstringThe track ID field.

Enumeration: TemporalFeatureClassCachingMode

Temporal feature class caching modes.

PropertyValueDescription
All0All.
None1None.

Enumeration: TemporalFeatureClassPurgeRule

Temporal feature class purge rules.

PropertyValueDescription
KeepLatestPerTrack0Keep latest per track.
PurgeOldest1Purge oldest.

CIMTimeDataDefinition

Represents a time data definition.

CIMTimeDataDefinition

PropertyTypeDescription
useTimebooleanA value indicating whether or not to use time for animation purposes.
timeReferenceTimeReferenceThe time reference.
customTimeExtentTimeExtentThe custom time extent.
hasLiveDatabooleanA value indicating whether or not this dataset has live data.
timeExtentCanChangebooleanA value indicating whether the data regularly changes, so the extent needs recalculated.
applyTimeReferenceToAllFieldsbooleanA value indicating whether the time reference applies to all date fields in the layer or only the fields driving time-awareness.

CIMTimeDimensionDefinition

Represents a time dimension definition.

CIMTimeDimensionDefinition

PropertyTypeDescription
timeDimensionNamestringThe time dimension name.
timeDimensionFormatstringThe time dimension format.

CIMTimeDisplayDefinition

Represents a time display definition.

CIMTimeDisplayDefinition

PropertyTypeDescription
cumulativebooleanA value indicating whether time is cumulative.
timeIntervaldoubleThe time interval.
timeIntervalUnitsenumeration esriTimeUnitsThe time interval units.
timeOffsetdoubleThe time offset.
timeOffsetUnitsenumeration esriTimeUnitsThe time offset units.
uniqueTimes[double]A cached set of unique OLE date values.

CIMTimeTableDefinition

Represents a time table definition.

CIMTimeTableDefinition

PropertyTypeDescription
startTimeFieldstringThe start time field.
endTimeFieldstringThe end time field.
timeValueFormatstringThe time value format.
trackIDFieldstringThe track ID field.

CIMTrackingServerDataConnection

Represents a tracking server data connection.

CIMDataConnection

PropertyTypeDescription

CIMStandardDataConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.
datasetstringThe dataset name.
datasetTypeenumeration esriDatasetTypeThe dataset type.

CIMTrackingServerDataConnection

PropertyTypeDescription
autoPurgebooleanA value indicating whether to automatically purge data.
purgeThresholdlongThe purge threshold.
purgePercentagedoubleThe percentage of the maximum allowed number of records to delete when the purge occurs.
keepPerTracklongThe minimum number of features to keep per track.
purgeRuleenumeration TemporalFeatureClassPurgeRuleThe purge rule.

CIMTrajectoryLayer

Represents a trajectory layer corresponding to a trajectory dataset.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMTrajectoryLayerDefinition

PropertyTypeDescription
footprintLayerstringThe path of the footprint feature layer.
pointLayerstringThe path of the point feature layer.
trajectoryDatasetConnectionDataConnectionThe data connection of the trajectory dataset.

Enumeration: TrajectorySubLayerType

Types of trajectory sublayers.

PropertyValueDescription
Footprint0Footprint sublayer.
Point1Point sublayer.

CIMVectorTileDataConnection

Represents a VectorTile layer data connection.

CIMDataConnection

PropertyTypeDescription

CIMServiceDataConnectionProperties

PropertyTypeDescription
customParameters[CIMStringMap]Vendor specific parameters.

CIMVectorTileDataConnection

PropertyTypeDescription
URIstringThe URI of the VectorTile files or resources.
resourcesURIstringThe URI of the binary reference containing the external resources.

CIMVectorTileLayer

Represents a VectorTile layer. A VectorTileServiceLayer provides rich cartographic content in a fast and efficient vector tile format. It may have multiple styles and if so users can choose which style to use to display the layer's vector geometries. Logically a VectorTileServiceLayer is more like a basemap layer in that it is typically composed of several distinct data sources (e.g. roads, cities, hydrology, buildings) that can provide context and background but in a way that is typically more performant than raster tile layers.

CIMDefinition

PropertyTypeDescription
namestringThe name.
URIstringThe URI of the definition. Typically set by the system and used as an identifier.
sourceURIstringThe source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTimeTimeInstantThe time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURIstringThe metadata URI.
useSourceMetadatabooleanA value indicating whether the CIM definition accesses metadata from its data source (the default behavior), or if it has its own metadata stored in the project.
sourcePortalUrlstringThe source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

PropertyTypeDescription
attributionstringThe attribution text that appears on a map that draws this layer.
descriptionstringThe description.
layerElevationCIMLayerElevationSurfaceThe layer elevation.
expandedbooleanA value indicating whether this layer is expanded in the contents pane.
layer3DPropertiesCIM3DLayerPropertiesThe 3D layer properties.
layerMasks[string]The URIs of the layers used as masks.
layerTypeenumeration MapLayerTypeThe map layer type.
maxScaledoubleThe maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScaledoubleThe minimum scale for layer draw (set as the denominator of the scale's representative fraction).
layerScaleVisibilityOptionsCIMLayerScaleVisibilityOptionsThe layer's scale visibility options.
showLegendsbooleanA value indicating whether or not to show legends.
transparencydoubleThe transparency of the layer as a percentage.
visibilitybooleanA value indicating whether or not this layer is visible.
displayCacheTypeenumeration DisplayCacheTypeThe display cache type.
maxDisplayCacheAgedoubleThe maximum display cache age.
layerTemplateCIMLayerTemplateThe layer template.
popupInfoCIMPopupInfoThe pop-up info.
showPopupsbooleanA value indicating whether or not to show pop-ups.
serviceLayerIDlongIdentifier that will be used to identify the layer in server.
charts[CIMChart]Identifier the layer's charts.
searchablebooleanA value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRatedoubleThe amount of time to wait between refreshing the layer.
refreshRateUnitenumeration esriTimeUnitsThe units for the amount of time to wait between refreshing the layer.
showMapTipsbooleanA value indicating whether or not the value of the display field or expression is shown when hovering over a layer in the view.
customProperties[CIMStringMap]The custom properties of the layer. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
webMapLayerIDstringAn identifier that will be used to identify the layer in a web map. This value is present if the layer originated in a web map and facilitates matching the layer back to its origin when updating the web map.
blendingModeenumeration BlendingModeThe blending mode for the layer.
allowDrapingOnIntegratedMeshbooleanA value indicating whether layer can be draped on integrated mesh.
rasterizeOnExportbooleanA value indicating whether layer should be rasterized when exporting.
useVisibilityTimeExtentbooleanA value indicating whether or not to use a fixed time extent for layer visibility. When true, the map time must overlap this extent for the layer to be visible.
visibilityTimeExtentTimeExtentThe fixed time extent for layer visibility.
enableLayerEffectsbooleanA value indicating whether to enable any type of effects on the layer.
layerEffects[CIMLayerEffect]The layer effects for the layer. This property will contain either a list of all scale-dependent layer effects, or a single layer effect.

CIMVectorTileLayerDefinition

PropertyTypeDescription
dataConnectionCIMVectorTileDataConnectionThe data connection to the VectorTile resource.
currentStylestringThe current style the vector tile layer features should be rendered with.
associatedFeatureLayerURIstringThe URI for a feature layer (feature service-based or portal item-based) that provides pop-up support for the vector tile layer.

CIMWorkspaceConnection

Represents a workspace connection.

CIMDataConnection

PropertyTypeDescription

CIMWorkspaceConnection

PropertyTypeDescription
workspaceConnectionStringstringThe workspace connection string.
workspaceFactoryenumeration WorkspaceFactoryThe workspace factory.
customWorkspaceFactoryCLSIDstringThe classID of the custom workspace factory.

Enumeration: WorkspaceFactory

Workspace factory types.

PropertyValueDescription
SDE0Enterprise geodatabase.
FileGDB1File geodatabase.
Raster2Raster.
Shapefile3Shapefile.
OLEDB4OLEDB.
Access5Microsoft Access.
DelimitedTextFile6Delimited text file.
Custom7Custom.
Sql8SQL query layer.
Tin9TIN.
TrackingServer10Tracking server.
NetCDF11NetCDF.
LASDataset12LAS dataset.
SQLite13SQLite.
FeatureService14Feature service.
ArcInfo15Arc/INFO Coverage.
Cad16CAD.
Excel17Microsoft Excel.
WFS18Web feature service.
StreamService19Stream service
BIMFile20BIM file.
InMemoryDB21In memory database.
NoSQL22NoSQL.
BigDataConnection23Big Data connection.
KnowledgeGraph24Knowledge Graph connection.
NITF25NITF connection.
VPF26VPF.
Parquet27Parquet.
FileKnowledgeGraph28File Knowledge Graph

CIMXYEventDataConnection

Represents an XY event data connection.

CIMDataConnection

PropertyTypeDescription

CIMXYEventDataConnection

PropertyTypeDescription
XFieldNamestringThe X field name.
YFieldNamestringThe Y field name.
ZFieldNamestringThe Z field name.
spatialReferenceSpatialReferenceThe spatial reference.
XYEventTableDataConnectionDataConnectionThe data connection to the table events are created from.