Skip to content

Latest commit

 

History

History
2854 lines (1819 loc) · 130 KB

CIMVectorLayers.md

File metadata and controls

2854 lines (1819 loc) · 130 KB

CIMAggregateField

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

CIMFieldDescription

Property Type Description
alias string The field alias.
fieldName string The field name.
highlight boolean A value indicating whether the field is highlighted.
numberFormat NumberFormat The number format.
readOnly boolean A value indicating whether the field is read only.
visible boolean A value indicating whether the field is visible.
valueAsRatio boolean A value indicating whether the field value is a ratio (used only by geoprocessing).
searchable boolean A value indicating whether the values from this field should be included in the search.
searchMode enumeration DataSearchMode Search mode to use when searching for values in this field.

CIMAggregateField

Property Type Description
aggregatedFieldName string The field name on which the aggregation was done.
statisticType enumeration esriDataStatType The type of statistic used to aggregate data.

CIMAggregateVisualization

Describes the appearance of aggregated features.

CIMAggregateVisualization

Property Type Description
renderer Renderer The renderer used by the aggregated features.
labelClass CIMLabelClass The label class used by the aggregated features.
showLabels boolean A value indicating whether or not to show labels for the aggregated features.

CIMAnnotationLayer

Represents an annotation layer used to draw annotation feature classes.

CIMDefinition

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

Property Type Description
attribution string The attribution text that appears on a map that draws this layer.
description string The description.
layerElevation CIMLayerElevationSurface The layer elevation.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
layer3DProperties CIM3DLayerProperties The 3D layer properties.
layerMasks [string] The layer masks.
layerType enumeration MapLayerType The map layer type.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
showLegends boolean A value indicating whether or not to show legends.
transparency double The transparency of the layer.
visibility boolean A value indicating whether or not this layer is visible.
displayCacheType enumeration DisplayCacheType The display cache type.
maxDisplayCacheAge double The maximum display cache age.
layerTemplate CIMLayerTemplate The layer template.
popupInfo CIMPopupInfo The pop-up info.
showPopups boolean A value indicating whether or not to show pop-ups.
serviceLayerID long Identifier that will be used to identify the layer in server.
charts [CIMChart] Identifier the layer's charts.
searchable boolean A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRate double The amount of time to wait between refreshing the layer.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the layer.
showMapTips boolean A value indicating whether or not the display value 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.
webMapLayerID string An 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.
blendingMode enumeration BlendingMode The blending mode for the layer.
allowDrapingOnIntegratedMesh boolean A value indicating whether layer can be draped on integrated mesh.

CIMFeatureLayerDefinition

Property Type Description
autoGenerateFeatureTemplates boolean A value indicating whether to automatically generate feature templates from the renderer.
extrusion CIMFeatureExtrusion The feature extrusion.
featureElevationExpression string The feature elevation expression.
featureHyperlinks [CIMFeatureHyperlink] The feature hyperlinks.
featureTable CIMFeatureTable The feature table.
featureTemplates [CIMEditingTemplate] The feature templates.
hotlinkField string The field containing hotlink URLs.
htmlPopupEnabled boolean A value indicating whether HTML pop-ups are enabled.
htmlPopupFormat CIMHtmlPopupFormat The HTML pop-ups format.
isFlattened boolean A value indicating whether the layer is flattened.
selectable boolean A value indicating whether the layer is selectable.
selectionColor Color The selection color. For polygons, this is used as the outline color.
polygonSelectionFillColor Color The selection fill color. Only used for polygons.
selectionSymbol CIMSymbolReference The selection symbol.
useSelectionSymbol boolean A value indicating whether to use the selection symbol.
pageDefinition CIMPageDefinition The page definition which allows for using current map series page to filter features.
featureCacheType enumeration FeatureCacheType The feature cache type.
enableDisplayFilters boolean A value indicating whether the current set of display filters are honored during drawing.
displayFilters [CIMDisplayFilter] The current set of scale based display filters.
displayFiltersType enumeration DisplayFilterType DisplayFiltersType value.
displayFilterName string The active display filter.
displayFilterChoices [CIMDisplayFilter] The current set of display filters.
featureElevationExpressionInfo CIMExpressionInfo The expression for setting the feature elevation.
featureBlendingMode enumeration BlendingMode The per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.

CIMAnnotationLayerDefinition

Property Type Description
barrierWeight enumeration BarrierWeight The weight of features in this layer when considered as barriers to labeling.
drawGeometry boolean A value indicating whether the geometry of the text graphics should be drawn.
drawUnplacedAnnotation boolean A value indicating whether unplaced annotation should be drawn.
drawGeometryLineSymbol CIMSymbolReference The line symbol used to draw text graphic line geometries when the DrawGeometry option is true.
drawGeometryPointSymbol CIMSymbolReference The point symbol used to draw text graphic line geometries when the DrawGeometry option is true.
unplacedAnnotationColor Color The color that unplaced text graphics will be drawn with when Unplaced Annotation is drawn.
symbolSubstitutionType enumeration SymbolSubstitutionType The type of symbol substitution this layer uses.
massColorSubstitute Color The mass color substitute. When using the SymbolSubstitutionColor substitution type this is the color that all text graphics will be overridden with.
inlineColor Color The 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

Property Type Description
description string The description.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
name string The name.
showLegends boolean A value indicating whether or not to show legends.
subLayerID string The sublayer ID.
visibility boolean A value indicating whether or not this layer is visible.
serviceLayerID long Identifier that will be used to identify the layer in server.

CIMAnnotationSubLayer

Property Type Description

Enumeration: AttachmentDisplayType

Attachment display types.

Property Value Description
PreviewFirst 0 Preview first.
PreviewAll 1 Preview all.
List 2 List.

CIMAttachmentsMediaInfo

Represents attachment media info.

CIMMediaInfo

Property Type Description
row long The row.
column long The column.
refreshRate double The amount of time in RefreshRateUnit to wait between refreshing the media info.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the media.
rowSpan long The row span.
columnSpan long The column span.

CIMAttachmentsMediaInfo

Property Type Description
caption string The caption.
title string The title.
contentType string The content MIME type. Example: (image/png, image/jpeg, audio/mp3).
displayType enumeration AttachmentDisplayType The display type.

CIMAttributeCondition

Represents an attribute condition.

CIMCondition

Property Type Description

CIMAttributeCondition

Property Type Description
whereClause string The where clause.

CIMBarChartMediaInfo

Represents bar chart media info.

CIMMediaInfo

Property Type Description
row long The row.
column long The column.
refreshRate double The amount of time in RefreshRateUnit to wait between refreshing the media info.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the media.
rowSpan long The row span.
columnSpan long The column span.

CIMChartMediaInfo

Property Type Description
fields [string] The fields.
normalizeField string The normalization field.
caption string The caption.
title string The title.

CIMBarChartMediaInfo

Property Type Description

Enumeration: BarrierWeight

Barrier weights.

Property Value Description
None 0 No weight.
Low 1 Low weight.
Medium 2 Medium weight.
High 3 High weight.

Enumeration: BindVariableType

Bind variable types.

Property Value Description
String 0 String variable type.
Integer 1 Integer variable type.
Double 2 Double variable type.
Date 3 Date variable type.
Geometry 4 Geometry variable type.

CIMBinningFeatureReduction

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

CIMFeatureReduction

Property Type Description
enabled boolean A value indicating whether feature reduction is enabled in the feature layer.

CIMAggregationFeatureReduction

Property Type Description
fields [CIMAggregateField] The fields that should be shown with the aggregated features.

CIMBinningFeatureReduction

Property Type Description
thresholdType enumeration BinsToPointsThresholdType The threshold at which points are shown.
maximumScale double The maximum scale to use when .
featureCount long The number of features to use when .
minimumBinSize double The minimum size (in points) to maintain as the bins are drawn at different scales.
visualization CIMBinningVisualization The visualization used by the bins.
spatialReference SpatialReference The 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.
fixedLevel long The bin level at which bins will be drawn. If -1, the bin level will be automatically chosen based on the minimum bin size.
binType enumeration esriFeatureBinType The 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.

CIMBinningVisualization

Describes the appearance and application behavior of polygon aggregation bins.

CIMAggregateVisualization

Property Type Description
renderer Renderer The renderer used by the aggregated features.
labelClass CIMLabelClass The label class used by the aggregated features.
showLabels boolean A value indicating whether or not to show labels for the aggregated features.

CIMBinningVisualization

Property Type Description

Enumeration: BinsToPointsThresholdType

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

Property Value Description
MaxScale 0 Points will be shown when the map is zoomed in beyond the largest scale of the bin levels.
FeatureCount 1 Points 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

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

Property Type Description
attribution string The attribution text that appears on a map that draws this layer.
description string The description.
layerElevation CIMLayerElevationSurface The layer elevation.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
layer3DProperties CIM3DLayerProperties The 3D layer properties.
layerMasks [string] The layer masks.
layerType enumeration MapLayerType The map layer type.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
showLegends boolean A value indicating whether or not to show legends.
transparency double The transparency of the layer.
visibility boolean A value indicating whether or not this layer is visible.
displayCacheType enumeration DisplayCacheType The display cache type.
maxDisplayCacheAge double The maximum display cache age.
layerTemplate CIMLayerTemplate The layer template.
popupInfo CIMPopupInfo The pop-up info.
showPopups boolean A value indicating whether or not to show pop-ups.
serviceLayerID long Identifier that will be used to identify the layer in server.
charts [CIMChart] Identifier the layer's charts.
searchable boolean A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRate double The amount of time to wait between refreshing the layer.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the layer.
showMapTips boolean A value indicating whether or not the display value 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.
webMapLayerID string An 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.
blendingMode enumeration BlendingMode The blending mode for the layer.
allowDrapingOnIntegratedMesh boolean A value indicating whether layer can be draped on integrated mesh.

CIMBuildingDisciplineLayerDefinition

Property Type Description
disciplineType enumeration DisciplineType The discipline type of this layer.
categoryLayers [string] The category layers for this discipline in the project.

CIMBuildingLayer

Represents a building composite layer.

CIMDefinition

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

Property Type Description
attribution string The attribution text that appears on a map that draws this layer.
description string The description.
layerElevation CIMLayerElevationSurface The layer elevation.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
layer3DProperties CIM3DLayerProperties The 3D layer properties.
layerMasks [string] The layer masks.
layerType enumeration MapLayerType The map layer type.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
showLegends boolean A value indicating whether or not to show legends.
transparency double The transparency of the layer.
visibility boolean A value indicating whether or not this layer is visible.
displayCacheType enumeration DisplayCacheType The display cache type.
maxDisplayCacheAge double The maximum display cache age.
layerTemplate CIMLayerTemplate The layer template.
popupInfo CIMPopupInfo The pop-up info.
showPopups boolean A value indicating whether or not to show pop-ups.
serviceLayerID long Identifier that will be used to identify the layer in server.
charts [CIMChart] Identifier the layer's charts.
searchable boolean A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRate double The amount of time to wait between refreshing the layer.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the layer.
showMapTips boolean A value indicating whether or not the display value 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.
webMapLayerID string An 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.
blendingMode enumeration BlendingMode The blending mode for the layer.
allowDrapingOnIntegratedMesh boolean A value indicating whether layer can be draped on integrated mesh.

CIMObject3DRenderingFilters

Property Type Description
filters [CIMObject3DRenderingFilter] The 3D object rendering filters.
activeFilterID string The ID of the filter currently used for rendering.

CIMBuildingLayerDefinition

Property Type Description
buildingDisciplineLayers [string] The building discipline composite layers in the project.
exteriorLayer string The exterior shell feature layer in the project.
buildingID string The building ID to filter by building.
dataConnection DataConnection The data connection to the workspace.
summaryStatisticsURI string The URI to the summary statistics.

CIMClusteringFeatureReduction

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

CIMFeatureReduction

Property Type Description
enabled boolean A value indicating whether feature reduction is enabled in the feature layer.

CIMAggregationFeatureReduction

Property Type Description
fields [CIMAggregateField] The fields that should be shown with the aggregated features.

CIMClusteringFeatureReduction

Property Type Description
maximumScale double The maximum scale. Beyond this scale, unclustered points will be shown.
clusterRadius double The radius within which points are clustered. Units are points.
visualization AggregateVisualization The visualization used by the clusters.

CIMColumnChartMediaInfo

Represents column chart media info.

CIMMediaInfo

Property Type Description
row long The row.
column long The column.
refreshRate double The amount of time in RefreshRateUnit to wait between refreshing the media info.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the media.
rowSpan long The row span.
columnSpan long The column span.

CIMChartMediaInfo

Property Type Description
fields [string] The fields.
normalizeField string The normalization field.
caption string The caption.
title string The title.

CIMColumnChartMediaInfo

Property Type Description

Enumeration: DataSearchMode

Field search modes.

Property Value Description
Contains 0 Search for values that contain the search text.
Exact 1 Search for values that are the exact match with the search text.

CIMDimensionLayer

Represents an dimension layer used to draw dimension feature classes.

CIMDefinition

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

Property Type Description
attribution string The attribution text that appears on a map that draws this layer.
description string The description.
layerElevation CIMLayerElevationSurface The layer elevation.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
layer3DProperties CIM3DLayerProperties The 3D layer properties.
layerMasks [string] The layer masks.
layerType enumeration MapLayerType The map layer type.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
showLegends boolean A value indicating whether or not to show legends.
transparency double The transparency of the layer.
visibility boolean A value indicating whether or not this layer is visible.
displayCacheType enumeration DisplayCacheType The display cache type.
maxDisplayCacheAge double The maximum display cache age.
layerTemplate CIMLayerTemplate The layer template.
popupInfo CIMPopupInfo The pop-up info.
showPopups boolean A value indicating whether or not to show pop-ups.
serviceLayerID long Identifier that will be used to identify the layer in server.
charts [CIMChart] Identifier the layer's charts.
searchable boolean A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRate double The amount of time to wait between refreshing the layer.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the layer.
showMapTips boolean A value indicating whether or not the display value 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.
webMapLayerID string An 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.
blendingMode enumeration BlendingMode The blending mode for the layer.
allowDrapingOnIntegratedMesh boolean A value indicating whether layer can be draped on integrated mesh.

CIMFeatureLayerDefinition

Property Type Description
autoGenerateFeatureTemplates boolean A value indicating whether to automatically generate feature templates from the renderer.
extrusion CIMFeatureExtrusion The feature extrusion.
featureElevationExpression string The feature elevation expression.
featureHyperlinks [CIMFeatureHyperlink] The feature hyperlinks.
featureTable CIMFeatureTable The feature table.
featureTemplates [CIMEditingTemplate] The feature templates.
hotlinkField string The field containing hotlink URLs.
htmlPopupEnabled boolean A value indicating whether HTML pop-ups are enabled.
htmlPopupFormat CIMHtmlPopupFormat The HTML pop-ups format.
isFlattened boolean A value indicating whether the layer is flattened.
selectable boolean A value indicating whether the layer is selectable.
selectionColor Color The selection color. For polygons, this is used as the outline color.
polygonSelectionFillColor Color The selection fill color. Only used for polygons.
selectionSymbol CIMSymbolReference The selection symbol.
useSelectionSymbol boolean A value indicating whether to use the selection symbol.
pageDefinition CIMPageDefinition The page definition which allows for using current map series page to filter features.
featureCacheType enumeration FeatureCacheType The feature cache type.
enableDisplayFilters boolean A value indicating whether the current set of display filters are honored during drawing.
displayFilters [CIMDisplayFilter] The current set of scale based display filters.
displayFiltersType enumeration DisplayFilterType DisplayFiltersType value.
displayFilterName string The active display filter.
displayFilterChoices [CIMDisplayFilter] The current set of display filters.
featureElevationExpressionInfo CIMExpressionInfo The expression for setting the feature elevation.
featureBlendingMode enumeration BlendingMode The per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.

CIMDimensionLayerDefinition

Property Type Description
barrierWeight enumeration BarrierWeight The weight of features in this layer when considered as barriers to labeling.
snappable boolean A value indicating whether or not geometries are snappable.

Enumeration: DimensionMarkerFit

Dimension marker fit options.

Property Value Description
None 0 Do not fit markers with text.
Tolerance 1 Fit markers with text using the length of the dimension line.
Text 2 Fit markers when overlapping the text.

Enumeration: DimensionPartOptions

Dimension part options.

Property Value Description
Begin 0 Only display the beginning dimension part.
End 1 Only display the end dimension part.
None 2 Do not display any dimension parts.
Both 3 Display both dimension parts.

CIMDimensionShape

Represents a dimension shape as used by a dimension feature.

CIMDimensionShape

Property Type Description
beginDimensionPoint Point The begin dimension point.
endDimensionPoint Point The end dimension point.
dimensionLinePoint Point The point which describes the height of the dimension line.
textPoint Point The point for the text placement.
extensionLineAngle double The angle of the extension lines in radians.
textAngle double The angle of the text in radians.

CIMDimensionStyle

Represents an dimension style which defines dimension appearance.

CIMDimensionStyle

Property Type Description
align boolean A value indicating whether the text should be aligned with the dimension line.
baselineHeight double The height of the construction for creating baseline dimensions with this style.
beginMarkerSymbol CIMPointSymbol The symbol used for the begin arrow.
convertUnits boolean A value indicating whether the length of the dimension needs to be converted for display.
dimensionLineOption enumeration DimensionPartOptions The dimension line display of the style.
dimensionLineSymbol CIMLineSymbol The symbol used for the dimension line.
displayPrecision long The precision for the value displayed by the dimension text.
displayUnits Unit The units the length of the dimension text is displayed in.
drawLineOnFit boolean A value indicating whether a dimension line should be drawn between the extension lines for an inward dimension.
endMarkerSymbol CIMPointSymbol The symbol used for the end arrow.
expression string The text expression for the style.
expressionParserName string The text expression parser for the text expression for the style.
expressionTitle string The human readable text title that describes the dimension expression.
extendLineOnFit boolean A value indicating whether the dimension line will be extended to underline the text on inward dimensions.
extensionLineOffset double The length of the extension line offset.
extensionLineOption enumeration DimensionPartOptions The extension line display options of the style.
extensionLineOvershot double The length of the extension line overshot.
extensionLineSymbol CIMLineSymbol The symbol used for extension lines.
ID long The ID of the style.
markerFit enumeration DimensionMarkerFit The arrow fit policy of the style.
markerFitTolerance double The arrow fit tolerance of the style.
markerOption enumeration DimensionPartOptions The arrow display properties of the style.
name string The name of the style.
prefix string The prefix for the text expression for the style.
suffix string The suffix for the text expression for the style.
textFit enumeration DimensionTextFit The text fit policy for the style.
textOption enumeration DimensionTextOption The text display option for the style.
textSymbol CIMTextSymbol The text symbol used for the text.

Enumeration: DimensionTextFit

Dimension text fit options.

Property Value Description
None 0 Do not fit the text.
MoveBegin 1 Move the text outside the begin extension line.
MoveEnd 2 Move the text outside the end extension line.

Enumeration: DimensionTextOption

Dimension text options.

Property Value Description
Only 0 Only display the value of the dimension length.
Suffix 1 Display the value of the dimension length with a prefix and suffix.
Expression 2 Display a text string derived from a custom expression.
None 3 Do not display any text.

Enumeration: DimensionType

Dimension types supported by dimension features.

Property Value Description
Aligned 0 An aligned dimension that displays the distance between the measure points.
Linear 1 A linear dimension that displays the distance between the extension lines.

Enumeration: DisciplineType

Represents the discipline type of a building layer.

Property Value Description
Architectural 0 Architectural.
Electrical 1 Electrical.
Mechanical 2 Mechanical.
Piping 3 Piping.
Structural 4 Structural.

CIMDiscreteVariable

Represents a single bind variable.

CIMBindVariable

Property Type Description
variableName string The name of the variable. The name must be unique among all variables.
alias string The alias of the variable.
dataType enumeration BindVariableType The type of the variable.

CIMDiscreteVariable

Property Type Description
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.
allowMultiple boolean A 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

Property Type Description
name string The name of the display filter.
whereClause string The where clause that filters features for a given scale range.
minScale double The minimum scale for this display filter.
maxScale double The maximum scale for this display filter.

Enumeration: DisplayFilterType

DisplayFilterType.

Property Value Description
ByChoice 0 DisplayFilter independent of scale.
ByScale 1 Scale based DisplayFilter.

CIMEditingTemplateRelationship

Represents an editing template relationship.

CIMEditingTemplateRelationship

Property Type Description
tableURI string The table URI of the table the relationship corresponds to.
name string The name.
relationshipID long The relationship ID.

CIMEditingTemplateToolOptions

Represents editing template tool options.

CIMEditingTemplateToolOptions

Property Type Description
toolProgID string The tool ProgID.
options {JSON_object} The options for the specified creation tool.

Enumeration: FeatureCacheType

Feature cache type options.

Property Value Description
None 0 No cache.
Session 1 Cache is maintained in session.

CIMFeatureDatasetDataConnection

Represents a feature dataset data connection.

CIMDataConnection

Property Type Description

CIMFeatureDatasetDataConnection

Property Type Description
featureDataset string Feature dataset.

CIMStandardDataConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.
dataset string The dataset name.
datasetType enumeration esriDatasetType The dataset type.

CIMServiceDataConnectionProperties

Property Type Description
customParameters [CIMStringMap] Vendor specific parameters.

Enumeration: FeatureExpirationMethod

Stream service feature expiration method.

Property Value Description
MaximumFeatureCount 0 The oldest features will expire after a threshold number of features has been reached.
MaximumFeatureAge 1 Features will expire after the specified time since the beginning of their lifetime.

CIMFeatureExtrusion

Represents feature extrusion.

CIMFeatureExtrusion

Property Type Description
extrusionType enumeration ExtrusionType The extrusion type.
extrusionExpression string The extrusion expression.
extrusionUnit LinearUnit The feature layer's extrusion unit.
extrusionExpressionInfo CIMExpressionInfo The ExpressionInfo that contains Arcade expression that returns a numeric value.

CIMFeatureHyperlink

Represents feature hyperlink.

CIMFeatureHyperlink

Property Type Description
featureID long The feature ID.
link string The link URL.

CIMFeatureLayer

Represents feature layer used to draw 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

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

Property Type Description
attribution string The attribution text that appears on a map that draws this layer.
description string The description.
layerElevation CIMLayerElevationSurface The layer elevation.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
layer3DProperties CIM3DLayerProperties The 3D layer properties.
layerMasks [string] The layer masks.
layerType enumeration MapLayerType The map layer type.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
showLegends boolean A value indicating whether or not to show legends.
transparency double The transparency of the layer.
visibility boolean A value indicating whether or not this layer is visible.
displayCacheType enumeration DisplayCacheType The display cache type.
maxDisplayCacheAge double The maximum display cache age.
layerTemplate CIMLayerTemplate The layer template.
popupInfo CIMPopupInfo The pop-up info.
showPopups boolean A value indicating whether or not to show pop-ups.
serviceLayerID long Identifier that will be used to identify the layer in server.
charts [CIMChart] Identifier the layer's charts.
searchable boolean A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRate double The amount of time to wait between refreshing the layer.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the layer.
showMapTips boolean A value indicating whether or not the display value 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.
webMapLayerID string An 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.
blendingMode enumeration BlendingMode The blending mode for the layer.
allowDrapingOnIntegratedMesh boolean A value indicating whether layer can be draped on integrated mesh.

CIMFeatureLayerDefinition

Property Type Description
autoGenerateFeatureTemplates boolean A value indicating whether to automatically generate feature templates from the renderer.
extrusion CIMFeatureExtrusion The feature extrusion.
featureElevationExpression string The feature elevation expression.
featureHyperlinks [CIMFeatureHyperlink] The feature hyperlinks.
featureTable CIMFeatureTable The feature table.
featureTemplates [CIMEditingTemplate] The feature templates.
hotlinkField string The field containing hotlink URLs.
htmlPopupEnabled boolean A value indicating whether HTML pop-ups are enabled.
htmlPopupFormat CIMHtmlPopupFormat The HTML pop-ups format.
isFlattened boolean A value indicating whether the layer is flattened.
selectable boolean A value indicating whether the layer is selectable.
selectionColor Color The selection color. For polygons, this is used as the outline color.
polygonSelectionFillColor Color The selection fill color. Only used for polygons.
selectionSymbol CIMSymbolReference The selection symbol.
useSelectionSymbol boolean A value indicating whether to use the selection symbol.
pageDefinition CIMPageDefinition The page definition which allows for using current map series page to filter features.
featureCacheType enumeration FeatureCacheType The feature cache type.
enableDisplayFilters boolean A value indicating whether the current set of display filters are honored during drawing.
displayFilters [CIMDisplayFilter] The current set of scale based display filters.
displayFiltersType enumeration DisplayFilterType DisplayFiltersType value.
displayFilterName string The active display filter.
displayFilterChoices [CIMDisplayFilter] The current set of display filters.
featureElevationExpressionInfo CIMExpressionInfo The expression for setting the feature elevation.
featureBlendingMode enumeration BlendingMode The per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.

CIMGeoFeatureLayerDefinition

Property Type Description
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.
labelVisibility boolean A 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.
mostCurrentRenderer Renderer The renderer used for the most current features when displaying tracks. Deprecated at 2.2, ignored in previous versions.
renderer Renderer The primary symbol renderer.
scaleSymbols boolean A value indicating whether to scale the symbols in this layer based on the map's reference scale.
snappable boolean A value indicating whether this layer participates in snapping in the editor.
symbolLayerDrawing CIMSymbolLayerDrawing The symbol layer drawing properties.
trackLinesRenderer Renderer The track renderer when displaying tracks.
previousObservationsRenderer Renderer The previous observations renderer.
previousObservationsCount long The previous observation count.
useRealWorldSymbolSizes boolean A value indicating whether to use real world symbols sizes (meters) vs. points.
showPreviousObservations boolean A value indicating whether previous observations are being drawn.
featureReduction FeatureReduction The feature reduction technique in use by this layer.
showTracks boolean A value indicating whether track lines are being drawn.

CIMFeatureTable

Represents a feature table.

CIMDisplayTableDefinition

Property Type Description
definitionExpression string The definition expression that can subset the rows in the virtual table.
definitionExpressionName string The Name of definition expression.
definitionFilterChoices [CIMDefinitionFilter] The definition filter choices.
displayField string The name of the attribute field that will be used as a label that represents each row in the table. The display field must be able to be represented as a string (string or numeric).
editable boolean A value indicating whether or not the 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.
timeFields CIMTimeTableDefinition The time fields.
timeDefinition CIMTimeDataDefinition The time definition.
timeDisplayDefinition CIMTimeDisplayDefinition The time display definition.
timeDimensionFields CIMTimeDimensionDefinition The time definition fields.
rangeDefinitions [CIMRangeDefinition] The range definitions.
activeRangeName string The active range name.
selectRelatedData boolean A value indicating whether related data should be selected when creating a new selection.
bindVariables [CIMBindVariable] The bind variables.
subtypeValue long The subtype value that should be used in the feature layer definition. This property is honored only when feature layer is a member of SubtypeLayer.
useSubtypeValue boolean A value indicating whether or not the SubtypeValue should be used.
displayExpressionInfo CIMExpressionInfo The expression information used for coming up with a string that represents a row or a feature.
selectionSetURI string The URI of the selection set for the table.
floorAwareTableProperties CIMFloorAwareTableProperties Floor-aware properties for the layer/table used in floor filtering.
routeIDFieldName string The 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.

CIMFeatureTableDefinition

Property Type Description
dataConnection DataConnection The data connection.
studyArea Area An area that can be used to subset the rows in the virtual table.
studyAreaSpatialRel enumeration esriSpatialRelEnum The study area spatial relationship.
searchOrder enumeration esriSearchOrder The search order option.
isLicensedDataSource boolean A value indicating whether the data source is licensed.
definitionSetURI string The DefinitionSet for the table.

CIMFeatureTemplate

Represents a feature template.

CIMEditingTemplate

Property Type Description
description string The description.
name string The name.
tags string The tags.
toolProgID string The tool ProgID.
toolFilter [string] The tool filter.
toolOptions [CIMEditingTemplateToolOptions] The per-tool options.

CIMBasicFeatureTemplate

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

CIMFeatureTemplate

Property Type Description

CIMFieldDescription

Represents a field description.

CIMFieldDescription

Property Type Description
alias string The field alias.
fieldName string The field name.
highlight boolean A value indicating whether the field is highlighted.
numberFormat NumberFormat The number format.
readOnly boolean A value indicating whether the field is read only.
visible boolean A value indicating whether the field is visible.
valueAsRatio boolean A value indicating whether the field value is a ratio (used only by geoprocessing).
searchable boolean A value indicating whether the values from this field should be included in the search.
searchMode enumeration DataSearchMode Search mode to use when searching for values in this field.

CIMFloorAwareTableProperties

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

CIMFloorAwareTableProperties

Property Type Description
floorFilterRank enumeration FloorFilterRank Rank or "level" at which the layer/table participates in filtering for Indoors or floor-aware layers/tables.
floorField string The name of the field that carries the floor value used for floor filtering.

Enumeration: FloorFilterRank

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

Property Value Description
None 0 Does not participate in floor filtering.
Site 1 Layer is an Indoors Site layer and will be filtered according to the selected site.
Facility 2 Layer is an Indoors Facility layer and will be filtered according to the selected facility or facilities within the selected site.
Level 3 Layer 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

Property Type Description
folderConnectionString string The folder connection string.
alias string The connection alias.

CIMGeometryLocationCondition

Represents geometry location condition.

CIMCondition

Property Type Description

CIMLocationCondition

Property Type Description
conditionType enumeration LocationConditionType The location condition type.

CIMGeometryLocationCondition

Property Type Description
geometries GeometryArray The geometries.

CIMGroupEditingTemplate

Represents a group editing template.

CIMEditingTemplate

Property Type Description
description string The description.
name string The name.
tags string The tags.
toolProgID string The tool ProgID.
toolFilter [string] The tool filter.
toolOptions [CIMEditingTemplateToolOptions] The per-tool options.

CIMGroupEditingTemplate

Property Type Description
baseName string The base name.
basePart CIMGroupEditingTemplatePart The base part.
parts [CIMGroupEditingTemplatePart] The parts.
createUtilityNetworkAssociations boolean A 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

Property Type Description
layerURI string The URI of the layer this template is defined for.
name string The name.
transformationID string The transformation ID.
options {JSON_object} The options.

CIMHighlightActivity

Represents a highlight activity.

CIMActivity

Property Type Description

CIMHighlightActivity

Property Type Description
highlightSymbol CIMSymbolReference The highlight symbol.

CIMHtmlPopupFormat

Represents an HTML pop-up format.

CIMHtmlPopupFormat

Property Type Description
htmlRedirectField string The redirect field.
htmlRedirectFieldPrefix string The redirect field prefix.
htmlRedirectFieldSuffix string The redirect field suffix.
htmlXSLStyleSheet string The XSL style sheet.
htmlHideFieldNameColumn boolean A value indicating whether of not to hide the field name column.
htmlUseCodedDomainValues boolean A value indicating whether of not to use coded domain values.
htmlPresentationStyle enumeration HtmlPopupStyle The presentation style.

Enumeration: HtmlPopupStyle

HTML pop-up styles.

Property Value Description
TwoColumnTable 0 A two column table.
RedirectedHTML 1 Redirected HTML.
XSLStyleSheet 2 An XSL style sheet.

CIMImageMediaInfo

Represents image media info.

CIMMediaInfo

Property Type Description
row long The row.
column long The column.
refreshRate double The amount of time in RefreshRateUnit to wait between refreshing the media info.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the media.
rowSpan long The row span.
columnSpan long The column span.

CIMImageMediaInfo

Property Type Description
sourceURL string The source URL.
linkURL string The link URL.
caption string The caption.
title string The title.

CIMLayerAction

Represents a layer action.

CIMLayerAction

Property Type Description
name string The name.
activities [CIMActivity] Activities.
conditions [CIMCondition] Conditions.

CIMLayerRange

Represents a layer range.

CIMLayerRange

Property Type Description
layerURI string The URI of the layer this range is defined for.
rangeName string The range name.
currentRange CIMRange The current range.
isExclusion boolean A value indicating whether or not this is an exclusion range.

CIMLineChartMediaInfo

Represents line chart media info.

CIMMediaInfo

Property Type Description
row long The row.
column long The column.
refreshRate double The amount of time in RefreshRateUnit to wait between refreshing the media info.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the media.
rowSpan long The row span.
columnSpan long The column span.

CIMChartMediaInfo

Property Type Description
fields [string] The fields.
normalizeField string The normalization field.
caption string The caption.
title string The title.

CIMLineChartMediaInfo

Property Type Description

Enumeration: LocationConditionType

Location condition types.

Property Value Description
In 0 In.
Depart 1 Depart.
Out 2 Out.
Arrive 3 Arrive.
Cross 4 Cross.
Crossover 5 Crossover.

CIMMaterializedViewProperties

Properties relevant to query layers based on materialized views.

CIMMaterializedViewProperties

Property Type Description
materializedViewQuery string The original definition of the materialized view.
materializedViewExpiration long The number of days after creating a materialized view that it is set to expire.

CIMMultipatchFeatureTemplate

Represents a multipatch feature template.

CIMEditingTemplate

Property Type Description
description string The description.
name string The name.
tags string The tags.
toolProgID string The tool ProgID.
toolFilter [string] The tool filter.
toolOptions [CIMEditingTemplateToolOptions] The per-tool options.

CIMBasicFeatureTemplate

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

CIMMultipatchFeatureTemplate

Property Type Description
galleryMode boolean A value indicating whether or not this is gallery mode.
models [CIMMultipatchFeatureTemplateModel] The models.

CIMMultipatchFeatureTemplateModel

Represents a multipatch feature template model.

CIMMultipatchTemplateModel

Property Type Description
isActive boolean A value indicating whether or not this is active.
modelURI string The model URI.
modelSourceURI string The model source URI.
thumbnailURI string The thumbnail URI.
camera CIMViewCamera The camera.

CIMNetCDFRasterDataConnection

Represents a NetCDF raster data connection.

CIMDataConnection

Property Type Description

CIMStandardDataConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.
dataset string The dataset name.
datasetType enumeration esriDatasetType The dataset type.

CIMNetCDFRasterDataConnection

Property Type Description
bandDimension string The band dimension.
extent Envelope The extent.
invertRows boolean A 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.
variable string The variable.
verticalDimension string The vertical dimension.
verticalDimensionUnit string The vertical dimension unit.
XDimension string The X dimension.
YDimension string The Y dimension.

CIMNetCDFStandardDataConnection

Represents a NetCDF standard data connection.

CIMDataConnection

Property Type Description

CIMStandardDataConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.
dataset string The dataset name.
datasetType enumeration esriDatasetType The dataset type.

CIMNetCDFStandardDataConnection

Property Type Description
variableList [string] The variable list.
rowDimensionList [string] The row dimension list.
XDimension string The X dimension.
YDimension string The Y dimension.
ZDimension string The Z dimension.
MDimension string The M dimension.
selectedDimensions [string] The selected dimensions.
selectedDimensionIndexes [long] The selected dimension indexes.
selectedDimensionValues [[any]] The selected dimension values.
shapeFieldName string The shape field name.
verticalDimension string The vertical dimension.
verticalDimensionUnit string The vertical dimension unit.
selectedVolume string The selected volume in a multi-volume dataset.

CIMPageDefinition

Represents page definition.

CIMPageDefinition

Property Type Description
pageFieldName string The 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.
excludePages boolean A value indicating whether to exclude pages. Specify false to show features that match or true to show features that don't match.

CIMParcelFabricLayer

Represents a parcel fabric layer.

CIMDefinition

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

Property Type Description
attribution string The attribution text that appears on a map that draws this layer.
description string The description.
layerElevation CIMLayerElevationSurface The layer elevation.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
layer3DProperties CIM3DLayerProperties The 3D layer properties.
layerMasks [string] The layer masks.
layerType enumeration MapLayerType The map layer type.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
showLegends boolean A value indicating whether or not to show legends.
transparency double The transparency of the layer.
visibility boolean A value indicating whether or not this layer is visible.
displayCacheType enumeration DisplayCacheType The display cache type.
maxDisplayCacheAge double The maximum display cache age.
layerTemplate CIMLayerTemplate The layer template.
popupInfo CIMPopupInfo The pop-up info.
showPopups boolean A value indicating whether or not to show pop-ups.
serviceLayerID long Identifier that will be used to identify the layer in server.
charts [CIMChart] Identifier the layer's charts.
searchable boolean A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRate double The amount of time to wait between refreshing the layer.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the layer.
showMapTips boolean A value indicating whether or not the display value 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.
webMapLayerID string An 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.
blendingMode enumeration BlendingMode The blending mode for the layer.
allowDrapingOnIntegratedMesh boolean A value indicating whether layer can be draped on integrated mesh.

CIMParcelFabricLayerDefinition

Property Type Description
accuracyTable string The path of the accuracy table.
allLayers [string] The paths of the layers in the parcel fabric layer.
adjustmentsTable string The path of the adjustments table.
cadastralFabricConnection DataConnection The data connection to the fabric.
controlPointLayer string The path of the control point layer.
controlPointSelectionSymbol CIMSymbolReference The control point selection symbol.
jobsTable string The path to the jobs table.
lineLayer string The path to the line layer.
linePointLayer string The path to the line point layer.
lockedParcelSelectionSymbol CIMSymbolReference The locked parcel selection symbol.
parcelLayer string The path to the parcel layer.
plansTable string The path to the plans table.
pointLayer string The path to the point layer.
unlockedParcelSelectionSymbol CIMSymbolReference The unlocked parcel selection symbol.

CIMParcelLayer

Represents a parcel fabric layer.

CIMDefinition

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

Property Type Description
attribution string The attribution text that appears on a map that draws this layer.
description string The description.
layerElevation CIMLayerElevationSurface The layer elevation.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
layer3DProperties CIM3DLayerProperties The 3D layer properties.
layerMasks [string] The layer masks.
layerType enumeration MapLayerType The map layer type.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
showLegends boolean A value indicating whether or not to show legends.
transparency double The transparency of the layer.
visibility boolean A value indicating whether or not this layer is visible.
displayCacheType enumeration DisplayCacheType The display cache type.
maxDisplayCacheAge double The maximum display cache age.
layerTemplate CIMLayerTemplate The layer template.
popupInfo CIMPopupInfo The pop-up info.
showPopups boolean A value indicating whether or not to show pop-ups.
serviceLayerID long Identifier that will be used to identify the layer in server.
charts [CIMChart] Identifier the layer's charts.
searchable boolean A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRate double The amount of time to wait between refreshing the layer.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the layer.
showMapTips boolean A value indicating whether or not the display value 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.
webMapLayerID string An 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.
blendingMode enumeration BlendingMode The blending mode for the layer.
allowDrapingOnIntegratedMesh boolean A value indicating whether layer can be draped on integrated mesh.

CIMParcelLayerDefinition

Property Type Description
recordsLayer string The 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.
dirtyAreaLayer string The path to the parcel dirty area layer. A dirty area is an area that has been modified and needs to be validated against the topology rules and parcel rules. Validation may yield error features (points, lines, polygons).
pointErrorLayer string The path to the parcel point error layer.
lineErrorLayer string The path to the parcel line error layer.
polygonErrorLayer string The path to the parcel polygon error layer.
parcelConnection DataConnection The 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.

CIMPieChartMediaInfo

Represents pie chart media info.

CIMMediaInfo

Property Type Description
row long The row.
column long The column.
refreshRate double The amount of time in RefreshRateUnit to wait between refreshing the media info.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the media.
rowSpan long The row span.
columnSpan long The column span.

CIMChartMediaInfo

Property Type Description
fields [string] The fields.
normalizeField string The normalization field.
caption string The caption.
title string The title.

CIMPieChartMediaInfo

Property Type Description

CIMPopupFieldDescription

Represents a pop-up field description.

CIMPopupFieldDescription

Property Type Description
alias string The field alias.
fieldName string The field name.
numberFormat NumberFormat The number format.

CIMPopupInfo

Represents pop-up info.

CIMPopupInfo

Property Type Description
title string The title.
expressionInfos [CIMExpressionInfo] Arcade expressions that are referenced as fields in one or more elements in MediaInfos.
mediaInfos [CIMMediaInfo] The media infos.
relatedRecordSortOrder [CIMStringMap] The field name and the sort order by which the related records will be ordered. The items are defined by the related field name (Format: RelationshipName\FieldName) as the Keys and the sort order (Enum: Asc, Desc) as the Values.
gridLayout CIMPopupLayout The grid layout for the media infos.
fieldDescriptions [CIMPopupFieldDescription] The pop-up field descriptions.

CIMPopupLayout

Represents a grid layout for pop-up media infos.

CIMPopupLayout

Property Type Description
columnWidths [double] The array of column width values in percentage of the table width (0-100). The sum of the array of width percentage values should be equal to 100.
borderWidth double The border width in points.
borderColor Color The border color.

CIMRange

Represents a range.

CIMRange

Property Type Description
min double The minimum.
max double The maximum.

CIMRangeDefinition

Represents a range definition.

CIMRangeDefinition

Property Type Description
name string The name.
fieldName string The field name.
currentRange CIMRange The current range.
customFullExtent CIMRange The custom full extent.
isExclusion boolean A value indicating whether or not range is exclusion.
aliasExpressionInfo CIMExpressionInfo ExpressionInfo that contains the Arcade expression that returns a string representing range alias value.

CIMRangeVariable

Represents a range variable.

CIMBindVariable

Property Type Description
variableName string The name of the variable. The name must be unique among all variables.
alias string The alias of the variable.
dataType enumeration BindVariableType The type of the variable.

CIMRangeVariable

Property Type Description
fieldExpression string The field for which the value range will be specified.
optional boolean A value indicating whether this variable is optional. If not, default values must be provided.
defaultMin any The default minimum value.
defaultMax any The default maximum value.
tableName string The name of the table to which the field in FieldExpression belongs.
valueIfMissing boolean A value indicating whether the resulting expression should take if the variable is optional and no value is passed.

CIMRasterTable

Represents a raster table.

CIMDisplayTableDefinition

Property Type Description
definitionExpression string The definition expression that can subset the rows in the virtual table.
definitionExpressionName string The Name of definition expression.
definitionFilterChoices [CIMDefinitionFilter] The definition filter choices.
displayField string The name of the attribute field that will be used as a label that represents each row in the table. The display field must be able to be represented as a string (string or numeric).
editable boolean A value indicating whether or not the 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.
timeFields CIMTimeTableDefinition The time fields.
timeDefinition CIMTimeDataDefinition The time definition.
timeDisplayDefinition CIMTimeDisplayDefinition The time display definition.
timeDimensionFields CIMTimeDimensionDefinition The time definition fields.
rangeDefinitions [CIMRangeDefinition] The range definitions.
activeRangeName string The active range name.
selectRelatedData boolean A value indicating whether related data should be selected when creating a new selection.
bindVariables [CIMBindVariable] The bind variables.
subtypeValue long The subtype value that should be used in the feature layer definition. This property is honored only when feature layer is a member of SubtypeLayer.
useSubtypeValue boolean A value indicating whether or not the SubtypeValue should be used.
displayExpressionInfo CIMExpressionInfo The expression information used for coming up with a string that represents a row or a feature.
selectionSetURI string The URI of the selection set for the table.
floorAwareTableProperties CIMFloorAwareTableProperties Floor-aware properties for the layer/table used in floor filtering.
routeIDFieldName string The 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.

CIMRasterTableDefinition

Property Type Description
joins DataConnection The joins as a data connection.

CIMRelQueryTableDataConnection

Represents a RelQuery table data connection.

CIMDataConnection

Property Type Description

CIMRelQueryTableDataConnection

Property Type Description
sourceTable DataConnection The source table data connection.
destinationTable DataConnection The destination table.
primaryKey string The primary key.
foreignKey string The foreign key.
name string The name.
cardinality enumeration esriRelCardinality The join cardinality.
joinType enumeration esriJoinType The join type.
joinForward boolean A value indicating whether or not this is a forward join.

CIMRelateInfo

Represents relate info.

CIMRelateInfo

Property Type Description
dataConnection DataConnection The relate data connection.
foreignKey string The foreign key.
primaryKey string The primary key.
cardinality enumeration esriRelCardinality The relate cardinality.
name string The name.

CIMRouteEventDataConnection

Represents a route event data connection.

CIMDataConnection

Property Type Description

CIMRouteEventDataConnection

Property Type Description
routeFeatureClass DataConnection The data connection for the route feature class.
routeIDFieldName string The route identifier field of the route feature class.
routeWhereClause string The where clause that limits the routes that events can be located on.
routeMeasureUnit Unit The route measure units.
eventMeasureUnit Unit The units of the event measure(s).
eventRouteIDFieldName string The route identifier field name.
isLineEvent boolean A value indicating whether or not this is a line event.
lateralOffsetFieldName string The lateral offset field name.
MDirectionOffsetting boolean A value indicating whether the offset should based on the M direction or the digitized direction.
errorFieldName string The error field name.
addErrorField boolean A value indicating whether an error field should be added to the field set.
fromMeasureFieldName string The from measure field name.
toMeasureFieldName string The to measure field name.
addAngleField boolean A value indicating whether an angle field should be added to the field set.
angleFieldName string The angle field name.
asPointFeature boolean A value indicating whether the point event shape should be output as a multipoint or a point.
complementAngle boolean A value indicating whether 180 degrees should be added to the angle field value.
normalAngle boolean A value indicating whether the angle field should be the normal or the tangent angles.
eventTable DataConnection The data connection for the route events.

CIMSqlQueryDataConnection

Represents a SQL query data connection.

CIMDataConnection

Property Type Description

CIMStandardDataConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.
dataset string The dataset name.
datasetType enumeration esriDatasetType The dataset type.

CIMSqlQueryDataConnection

Property Type Description
sqlQuery string The SQL query.
srid string The SRID of the spatial reference.
spatialReference SpatialReference The spatial reference.
OIDFields string The OID fields.
geometryType enumeration esriGeometryType The geometry type.
extent Envelope The extent.
queryFields Fields
spatialStorageType long The spatial storage type.
sridType long The SRID type. Only used for query layers based on Oracle Spatial (SDO) storage. This property is managed by the system as an optimization.
spatialIndexDimension long The spatial index dimension. Only used for query layers based on Oracle Spatial (SDO) storage. This property is managed by the system as an optimization.
isTableBased boolean A 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.
materializedViewProperties CIMMaterializedViewProperties The properties relevant to materialized view-based query layers.

CIMStandaloneTable

Represents a standalone table.

CIMDefinition

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMDisplayTableDefinition

Property Type Description
definitionExpression string The definition expression that can subset the rows in the virtual table.
definitionExpressionName string The Name of definition expression.
definitionFilterChoices [CIMDefinitionFilter] The definition filter choices.
displayField string The name of the attribute field that will be used as a label that represents each row in the table. The display field must be able to be represented as a string (string or numeric).
editable boolean A value indicating whether or not the 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.
timeFields CIMTimeTableDefinition The time fields.
timeDefinition CIMTimeDataDefinition The time definition.
timeDisplayDefinition CIMTimeDisplayDefinition The time display definition.
timeDimensionFields CIMTimeDimensionDefinition The time definition fields.
rangeDefinitions [CIMRangeDefinition] The range definitions.
activeRangeName string The active range name.
selectRelatedData boolean A value indicating whether related data should be selected when creating a new selection.
bindVariables [CIMBindVariable] The bind variables.
subtypeValue long The subtype value that should be used in the feature layer definition. This property is honored only when feature layer is a member of SubtypeLayer.
useSubtypeValue boolean A value indicating whether or not the SubtypeValue should be used.
displayExpressionInfo CIMExpressionInfo The expression information used for coming up with a string that represents a row or a feature.
selectionSetURI string The URI of the selection set for the table.
floorAwareTableProperties CIMFloorAwareTableProperties Floor-aware properties for the layer/table used in floor filtering.
routeIDFieldName string The 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.

CIMStandaloneTableDefinition

Property Type Description
dataConnection DataConnection The data connection for the table.
description string The description.
autoGenerateRowTemplates boolean A value indicating whether to automatically generate row templates from the renderer.
rowTemplates [CIMEditingTemplate] The row templates.
serviceTableID long Identifier that will be used to identify the layer in server.
showPopups boolean A value indicating whether or not to show pop-ups.
popupInfo CIMPopupInfo The pop-up info.
charts [CIMChart] The table's charts.
pageDefinition CIMPageDefinition The 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.
webMapTableID string An 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.
searchable boolean A value indicating whether or not this table should be included in the search. This property is honored only by tables that support search.

CIMStandardDataConnection

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

CIMDataConnection

Property Type Description

CIMServiceDataConnectionProperties

Property Type Description
customParameters [CIMStringMap] Vendor specific parameters.

CIMStandardDataConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.
dataset string The dataset name.
datasetType enumeration esriDatasetType The dataset type.

CIMStreamServiceDataConnection

Represents a stream service data connection.

CIMDataConnection

Property Type Description

CIMStandardDataConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.
dataset string The dataset name.
datasetType enumeration esriDatasetType The dataset type.

CIMStreamServiceDataConnection

Property Type Description
featureExpirationMethod enumeration FeatureExpirationMethod Feature expiration method used at dataset level.
maximumFeatureCount long long The maximum number of features that are held in memory before features are discarded.
maximumFeatureAge long long The 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

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

Property Type Description
attribution string The attribution text that appears on a map that draws this layer.
description string The description.
layerElevation CIMLayerElevationSurface The layer elevation.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
layer3DProperties CIM3DLayerProperties The 3D layer properties.
layerMasks [string] The layer masks.
layerType enumeration MapLayerType The map layer type.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
showLegends boolean A value indicating whether or not to show legends.
transparency double The transparency of the layer.
visibility boolean A value indicating whether or not this layer is visible.
displayCacheType enumeration DisplayCacheType The display cache type.
maxDisplayCacheAge double The maximum display cache age.
layerTemplate CIMLayerTemplate The layer template.
popupInfo CIMPopupInfo The pop-up info.
showPopups boolean A value indicating whether or not to show pop-ups.
serviceLayerID long Identifier that will be used to identify the layer in server.
charts [CIMChart] Identifier the layer's charts.
searchable boolean A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRate double The amount of time to wait between refreshing the layer.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the layer.
showMapTips boolean A value indicating whether or not the display value 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.
webMapLayerID string An 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.
blendingMode enumeration BlendingMode The blending mode for the layer.
allowDrapingOnIntegratedMesh boolean A value indicating whether layer can be draped on integrated mesh.

CIMFeatureLayerDefinition

Property Type Description
autoGenerateFeatureTemplates boolean A value indicating whether to automatically generate feature templates from the renderer.
extrusion CIMFeatureExtrusion The feature extrusion.
featureElevationExpression string The feature elevation expression.
featureHyperlinks [CIMFeatureHyperlink] The feature hyperlinks.
featureTable CIMFeatureTable The feature table.
featureTemplates [CIMEditingTemplate] The feature templates.
hotlinkField string The field containing hotlink URLs.
htmlPopupEnabled boolean A value indicating whether HTML pop-ups are enabled.
htmlPopupFormat CIMHtmlPopupFormat The HTML pop-ups format.
isFlattened boolean A value indicating whether the layer is flattened.
selectable boolean A value indicating whether the layer is selectable.
selectionColor Color The selection color. For polygons, this is used as the outline color.
polygonSelectionFillColor Color The selection fill color. Only used for polygons.
selectionSymbol CIMSymbolReference The selection symbol.
useSelectionSymbol boolean A value indicating whether to use the selection symbol.
pageDefinition CIMPageDefinition The page definition which allows for using current map series page to filter features.
featureCacheType enumeration FeatureCacheType The feature cache type.
enableDisplayFilters boolean A value indicating whether the current set of display filters are honored during drawing.
displayFilters [CIMDisplayFilter] The current set of scale based display filters.
displayFiltersType enumeration DisplayFilterType DisplayFiltersType value.
displayFilterName string The active display filter.
displayFilterChoices [CIMDisplayFilter] The current set of display filters.
featureElevationExpressionInfo CIMExpressionInfo The expression for setting the feature elevation.
featureBlendingMode enumeration BlendingMode The per-feature blending mode which allows features in a layer to blend against other features in the same layer that have already drawn.

CIMSubtypeGroupLayerDefinition

Property Type Description
subtypeLayers [string] The layer URI corresponding to each subtype value.

CIMSuppressActivity

Represents suppress activity.

CIMActivity

Property Type Description

CIMSuppressActivity

Property Type Description

CIMSymbolIdentifier

Represents a symbol identifier.

CIMSymbolIdentifier

Property Type Description
ID long The ID which identifies the symbol in the collection.
name string The name of the symbol in the symbol collection.
symbol Symbol The symbol.

CIMSymbolLayerMasking

Represents symbol layer masking.

CIMSymbolLayerMasking

Property Type Description
symbolLayers [CIMSymbolLayerIdentifier] The symbol layer identifiers.

Enumeration: SymbolSubstitutionType

Symbol substitution types.

Property Value Description
None 0 No symbol substitution.
Color 1 Substitute color.
IndividualSubordinate 2 Substitute individual symbols in the collection with overrides taking precedence to symbols.
IndividualDominant 3 Substitute individual symbols in the collection with the symbol taking precedence to overrides.

CIMTableMediaInfo

Represents table media info.

CIMMediaInfo

Property Type Description
row long The row.
column long The column.
refreshRate double The amount of time in RefreshRateUnit to wait between refreshing the media info.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the media.
rowSpan long The row span.
columnSpan long The column span.

CIMTableMediaInfo

Property Type Description
fields [string] The fields.
useLayerFields boolean A value indicating whether or not the table is generated using the layer's visible fields.
caption string The caption.
title string The title.

CIMTableQueryNameDataConnection

Represents a table query name data connection.

CIMDataConnection

Property Type Description

CIMStandardDataConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.
dataset string The dataset name.
datasetType enumeration esriDatasetType The dataset type.

CIMTableQueryNameDataConnection

Property Type Description
subFields string The subfields.
tables string The tables.
whereClause string The where clause.
primaryKeyFields string The primary key fields.
copyLocally boolean A value indicating whether or not to copy data locally.
shapeType enumeration esriGeometryType The shape type.
featureType enumeration esriFeatureType The feature type.
extent Envelope The extent.
shapeFieldName string The shape field name.

CIMTemporalDataConnection

Represents a temporal data connection.

CIMDataConnection

Property Type Description

CIMStandardDataConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.
dataset string The dataset name.
datasetType enumeration esriDatasetType The dataset type.

CIMTemporalDataConnection

Property Type Description
timeFieldLocaleID long The time field locale ID.
timeFieldAmFormat string The custom string representation of the AM symbol.
timeFieldPmFormat string The custom string representation of the PM symbol.
cachingMode enumeration TemporalFeatureClassCachingMode The caching mode.
startTimeField string The start time field.
endTimeField string The end time field.
timeValueFormat string The time value format.
trackIDField string The track ID field.

Enumeration: TemporalFeatureClassCachingMode

Temporal feature class caching modes.

Property Value Description
All 0 All.
None 1 None.

Enumeration: TemporalFeatureClassPurgeRule

Temporal feature class purge rules.

Property Value Description
KeepLatestPerTrack 0 Keep latest per track.
PurgeOldest 1 Purge oldest.

CIMTextMediaInfo

Represents text media info.

CIMMediaInfo

Property Type Description
row long The row.
column long The column.
refreshRate double The amount of time in RefreshRateUnit to wait between refreshing the media info.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the media.
rowSpan long The row span.
columnSpan long The column span.

CIMTextMediaInfo

Property Type Description
text string The text.

CIMTimeDataDefinition

Represents a time data definition.

CIMTimeDataDefinition

Property Type Description
useTime boolean A value indicating whether or not to use time for animation purposes.
timeReference TimeReference The time reference.
customTimeExtent TimeExtent The custom time extent.
hasLiveData boolean A value indicating whether or not this dataset has live data.
timeExtentCanChange boolean A value indicating whether the data regularly changes, so the extent needs recalculated.

CIMTimeDimensionDefinition

Represents a time dimension definition.

CIMTimeDimensionDefinition

Property Type Description
timeDimensionName string The time dimension name.
timeDimensionFormat string The time dimension format.

CIMTimeDisplayDefinition

Represents a time display definition.

CIMTimeDisplayDefinition

Property Type Description
cumulative boolean A value indicating whether time is cumulative.
timeInterval double The time interval.
timeIntervalUnits enumeration esriTimeUnits The time interval units.
timeOffset double The time offset.
timeOffsetUnits enumeration esriTimeUnits The time offset units.
uniqueTimes [double] A cached set of unique OLE date values.

CIMTimeTableDefinition

Represents a time table definition.

CIMTimeTableDefinition

Property Type Description
startTimeField string The start time field.
endTimeField string The end time field.
timeValueFormat string The time value format.
trackIDField string The track ID field.

CIMTrackingServerDataConnection

Represents a tracking server data connection.

CIMDataConnection

Property Type Description

CIMStandardDataConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.
dataset string The dataset name.
datasetType enumeration esriDatasetType The dataset type.

CIMTrackingServerDataConnection

Property Type Description
autoPurge boolean A value indicating whether to automatically purge data.
purgeThreshold long The purge threshold.
purgePercentage double The percentage of the maximum allowed number of records to delete when the purge occurs.
keepPerTrack long The minimum number of features to keep per track.
purgeRule enumeration TemporalFeatureClassPurgeRule The purge rule.

CIMVectorTileDataConnection

Represents a VectorTile layer data connection.

CIMDataConnection

Property Type Description

CIMServiceDataConnectionProperties

Property Type Description
customParameters [CIMStringMap] Vendor specific parameters.

CIMVectorTileDataConnection

Property Type Description
URI string The URI of the VectorTile files or resources.
resourcesURI string The URI of 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

Property Type Description
name string The name.
URI string The URI of the definition. Typically set by the system and used as an identifier.
sourceURI string The source URI of the item. Set if sourced from an external item such as an item on a portal.
sourceModifiedTime TimeInstant The time the source was last modified, as of the last sync. Used to detect when another sync is needed.
metadataURI string The metadata URI.
useSourceMetadata boolean A 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.
sourcePortalUrl string The source portal URI of the item. Set if sourced from an external item such as an item on a portal.

CIMLayerDefinition

Property Type Description
attribution string The attribution text that appears on a map that draws this layer.
description string The description.
layerElevation CIMLayerElevationSurface The layer elevation.
expanded boolean A value indicating whether this layer is expanded in the contents pane.
layer3DProperties CIM3DLayerProperties The 3D layer properties.
layerMasks [string] The layer masks.
layerType enumeration MapLayerType The map layer type.
maxScale double The maximum scale for layer draw (set as the denominator of the scale's representative fraction).
minScale double The minimum scale for layer draw (set as the denominator of the scale's representative fraction).
showLegends boolean A value indicating whether or not to show legends.
transparency double The transparency of the layer.
visibility boolean A value indicating whether or not this layer is visible.
displayCacheType enumeration DisplayCacheType The display cache type.
maxDisplayCacheAge double The maximum display cache age.
layerTemplate CIMLayerTemplate The layer template.
popupInfo CIMPopupInfo The pop-up info.
showPopups boolean A value indicating whether or not to show pop-ups.
serviceLayerID long Identifier that will be used to identify the layer in server.
charts [CIMChart] Identifier the layer's charts.
searchable boolean A value indicating whether or not this layer should be included in the search. This property is honored only by layers that support search.
refreshRate double The amount of time to wait between refreshing the layer.
refreshRateUnit enumeration esriTimeUnits The units for the amount of time to wait between refreshing the layer.
showMapTips boolean A value indicating whether or not the display value 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.
webMapLayerID string An 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.
blendingMode enumeration BlendingMode The blending mode for the layer.
allowDrapingOnIntegratedMesh boolean A value indicating whether layer can be draped on integrated mesh.

CIMVectorTileLayerDefinition

Property Type Description
dataConnection CIMVectorTileDataConnection The data connection to the VectorTile resource.
currentStyle string The current style the vector tile layer features should be rendered with.
associatedFeatureLayerURI string The URI for a feature service or portal item that provides pop-up support for the layer.

CIMWorkspaceConnection

Represents a workspace connection.

CIMDataConnection

Property Type Description

CIMWorkspaceConnection

Property Type Description
workspaceConnectionString string The workspace connection string.
workspaceFactory enumeration WorkspaceFactory The workspace factory.
customWorkspaceFactoryCLSID string The classID of the custom workspace factory.

Enumeration: WorkspaceFactory

Workspace factory types.

Property Value Description
SDE 0 Enterprise geodatabase.
FileGDB 1 File geodatabase.
Raster 2 Raster.
Shapefile 3 Shapefile.
OLEDB 4 OLEDB.
Access 5 Microsoft Access.
DelimitedTextFile 6 Delimited text file.
Custom 7 Custom.
Sql 8 SQL query layer.
Tin 9 TIN.
TrackingServer 10 Tracking server.
NetCDF 11 NetCDF.
LASDataset 12 LAS dataset.
SqlLite 13 SQLite.
FeatureService 14 Feature service.
ArcInfo 15 Arc/INFO Coverage.
Cad 16 CAD.
Excel 17 Microsoft Excel.
WFS 18 Web feature service.
StreamService 19 Stream service
BIMFile 20 BIM file.
InMemoryDB 21 In memory database.
NoSQL 22 NoSQL.
BigDataConnection 23 Big Data connection.
KnowledgeGraph 24 Knowledge Graph connection.
NITF 25 NITF connection.

CIMXYEventDataConnection

Represents an XY event data connection.

CIMDataConnection

Property Type Description

CIMXYEventDataConnection

Property Type Description
XFieldName string The X field name.
YFieldName string The Y field name.
ZFieldName string The Z field name.
spatialReference SpatialReference The spatial reference.
XYEventTableDataConnection DataConnection The data connection to the table events are created from.