Skip to content

Latest commit

 

History

History
432 lines (294 loc) · 23.8 KB

CIMNetworkLayers.md

File metadata and controls

432 lines (294 loc) · 23.8 KB
Raw

CIMInMemoryDatasetDataConnection

Represents an in-memory dataset data connection.

CIMDataConnection

Property Type Description

CIMInMemoryDatasetDataConnection

Property Type Description
dataset string The dataset name.

CIMInMemoryWorkspaceDataConnection

Represents an in-memory workspace data connection.

CIMDataConnection

Property Type Description

CIMInMemoryWorkspaceDataConnection

Property Type Description
binaryReferencePath string The path to the binary reference containing the serialized workspace.

CIMNALayer

Represents a network analysis 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 to 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.

CIMStandaloneTableContainer

Property Type Description
standaloneTables [string] The standalone tables as an array of table repository paths.

CIMGroupLayerDefinition

Property Type Description
layers [string] The layer URIs of the layers in the group layer.
symbolLayerDrawing CIMSymbolLayerDrawing The symbol layer drawing definition.

CIMNALayerDefinition

Property Type Description
NAWorkspace DataConnection Data connection for the NA workspace.
networkDataset DataConnection Data connection for the network dataset.
solver NASolverDefinition The NA solver.
locator NALocatorDefinition The locator.
agents NAAgentDefinition The agents.

CIMNetworkDatasetElementCompositeRenderer

Represents a network dataset element composite renderer.

CIMNetworkDatasetRenderer

Property Type Description
label string The renderer label.
visible boolean A value indicating whether or not the renderer is visible.

CIMNetworkDatasetElementCompositeRenderer

Property Type Description
edgeLineRenderer CIMNetworkDatasetSimpleRenderer Edge line renderer.
edgePointRenderer CIMNetworkDatasetSimpleRenderer Edge point renderer.
junctionPointRenderer CIMNetworkDatasetSimpleRenderer Junction point renderer.
turnLineRenderer CIMNetworkDatasetSimpleRenderer Turn line renderer.

CIMNetworkDatasetLayer

Represents a network dataset 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 to 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.

CIMNetworkDatasetLayerDefinition

Property Type Description
dataConnection DataConnection Data connection to the network dataset.
dirtyAreaRenderer CIMNetworkDatasetSimpleRenderer The dirty area renderer.
displayNetworkAttribute string The display network attribute.
edgeRenderer CIMNetworkDatasetSimpleRenderer The edge renderer.
junctionRenderer CIMNetworkDatasetSimpleRenderer The junction renderer.
missingElementRenderer CIMNetworkDatasetElementCompositeRenderer The missing element renderer.
networkSourceDisplayFilters [CIMNetworkSourceDisplayFilter] The network source display filters.
oneWayRenderer CIMNetworkDatasetElementCompositeRenderer The one-way renderer.
restrictionNetworkAttributes [string] The restriction network attributes.
restrictionRenderer CIMNetworkDatasetElementCompositeRenderer The restriction renderer.
systemJunctionRenderer CIMNetworkDatasetSimpleRenderer The system junction renderer.
trafficNetworkAttribute string The traffic network attribute.
trafficRenderer CIMNetworkDatasetTrafficRenderer The traffic renderer.
traversableRenderer CIMNetworkDatasetElementCompositeRenderer The traversable renderer.
turnRenderer CIMNetworkDatasetSimpleRenderer The turn renderer.

CIMNetworkDatasetSimpleRenderer

Represents a network dataset simple renderer.

CIMNetworkDatasetRenderer

Property Type Description
label string The renderer label.
visible boolean A value indicating whether or not the renderer is visible.

CIMNetworkDatasetSimpleRenderer

Property Type Description
description string The renderer description.
symbol CIMSymbolReference The symbol.

CIMNetworkDatasetTrafficRenderer

Represents a network dataset traffic renderer.

CIMNetworkDatasetRenderer

Property Type Description
label string The renderer label.
visible boolean A value indicating whether or not the renderer is visible.

CIMNetworkDatasetTrafficRenderer

Property Type Description
breaks [CIMClassBreak] The renderer class breaks.
defaultDescription string The default description.
defaultLabel string The default label.
defaultSymbol CIMSymbolReference The default symbol.
showLiveTrafficOnly boolean A value indicating whether or not to show only live traffic.
useDefaultSymbol boolean A value indicating whether or not to use the default symbol.

CIMNetworkDatasetFastTrafficRenderer

Property Type Description
drawLineWidthByHierarchyLevelIndex boolean A value indicating whether of not to draw line width by hierarchy level index.
exteriorLineWidthIncrement double The exterior line width increment.
interiorLineWidthsByHierarchyLevelIndex [double] The interior line widths by hierarchy level index.
lineCasingsColor Color The line casings color.
scaleFilters [double] The scale filters.
useDerivedLineCasingsColor boolean A value indicating whether of not to use a derived line casing color.
useLineCasings boolean A value indicating whether of not to use line casings.
useScaleFilters boolean A value indicating whether of not to use scale filters.

CIMNetworkSourceDisplayFilter

Represents a network source display filter.

CIMNetworkSourceDisplayFilter

Property Type Description
networkSource string The network source.
visible boolean A value indicating whether the filter is visible.
definitionExpression string The definition expression.

CIMTraceNetworkLayer

Represents a trace network 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 to 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.

CIMTraceNetworkLayerDefinition

Property Type Description
dataConnection DataConnection The data connection.
pointErrorLayer string The path to the point error layer.
lineErrorLayer string The path to the line error layer.
systemJunctionsLayer string The path to the junction layer.
dirtyAreaLayer string The path to the dirty area layer.
connectivityAssociationSymbol CIMSymbolReference The symbol used to draw the connectivity associations of the trace network.

CIMUtilityNetworkLayer

Represents a utility network 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 to 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.

CIMUtilityNetworkLayerDefinition

Property Type Description
dataConnection DataConnection The data connection.
pointErrorLayer string The path to the point error layer.
lineErrorLayer string The path to the line error layer.
polygonErrorLayer string The path to the polygon error layer.
dirtyAreaLayer string The path to the dirty area layer.
connectivityAssociationSymbol CIMSymbolReference The symbol used to draw the connectivity associations of the utility network.
structuralAttachmentAssociationSymbol CIMSymbolReference The symbol used to draw the structural attachment associations of the utility network.
containerAssociationSymbol CIMSymbolReference The symbol used to draw the container associations of the utility network.