Skip to content

Latest commit

 

History

History
1475 lines (883 loc) · 62.1 KB

CIMMap.md

File metadata and controls

1475 lines (883 loc) · 62.1 KB
Raw

CIMAltitudeParams

Represents altitude parameters.

CIMAltitudeParams

Property Type Description
altitudeValue double The altitude value.
mode enumeration AltitudeMode The altitude mode.

CIMAnimationScreenGraphic

Represents a graphic and list of keyframes indicating properties that can be changed during the animation.

CIMAnimationScreenGraphic

Property Type Description
graphic Graphic The graphic to be displayed.
alias string An identifier for the user.
keyframes [CIMAnimationScreenGraphicKeyframe] The graphic properties keyframes.

CIMAnimationScreenGraphicGroup

Represents an animation screen graphic group container.

CIMAnimationScreenGraphic

Property Type Description
graphic Graphic The graphic to be displayed.
alias string An identifier for the user.
keyframes [CIMAnimationScreenGraphicKeyframe] The graphic properties keyframes.

CIMAnimationScreenGraphicGroup

Property Type Description
children [CIMAnimationScreenGraphic] The children.

CIMAnimationScreenGraphicKeyframe

Properties defining the graphic at a single point in time for the animation.

CIMAnimationScreenGraphicKeyframe

Property Type Description
trackTime double The time in seconds relative to the beginning of the track.
anchorX double The horizontal placement percent of the graphic anchor position on the viewer (0 is left edge, 1 is right edge).
anchorY double The vertical placement percent of the graphic anchor position on the viewer (0 is top edge, 1 is bottom edge).
transparency double The transparency of the graphic.
scale double The size multiplier for the graphic.
elementWidth double The pixel width for the graphic. It applies only to the animation screen graphic that contains a polygon graphic.
elementHeight double The pixel height for the graphic. It applies only to the animation screen graphic that contains a polygon graphic.
rotation double The angle of rotation (in degrees) for the graphic. It applies only to the animation screen graphic that contains a polygon graphic.

CIMBookmark

Represents a spatial bookmark.

CIMBookmark

Property Type Description
name string The bookmark name.
groupName string The bookmark group name.
thumbnailImagePath string The thumbnail image path.
camera CIMViewCamera The camera.
location Envelope The location.
timeExtent TimeExtent The time extent.
timeRelation enumeration esriTimeRelation The time relation.
rangeExtent CIMLayerRange The range extent. Can be used across multiple maps that share the same range name. RangeExtent.LayerURI is not used.
layerRangeExtents [CIMLayerRange] The layer range extents. Each layer range applies to a single map.
description string The bookmark description.
videoURI string The URI to the standalone video.
videoElapsedTime double The video elapsed time in seconds.

CIMBorderlandsEffect

Represents a surface effect for reshading the surface with a borderlands effect in 3D views.

CIMSurfaceEffect

Property Type Description

CIMBorderlandsEffect

Property Type Description

Enumeration: ClipDistanceMode

Specifies the clipping mode used for the map.

Property Value Description
Automatic 0 Calculate clip distance automatically.
Manual 1 Use the specified clip distance.

Enumeration: ClippingMode

Specifies the clipping mode used for the map.

Property Value Description
None 0 No clipping applied.
MapExtent 1 Clip to the custom extent defined for the map.
CustomShape 2 Clip to a custom shape.
MapSeries 3 Clip to the shape defined by a map series.

Enumeration: ComparisonOperator

Query builder comparison operator between fields.

Property Value Description
IsEqual 1 Is Equal to comparison operator.
NotEqual 2 Does not equal to comparison operator.
LessThanOrEqualTo 3 Less than or equal to comparison operator.
LessThan 4 Less than comparison operator.
GreaterThanOrEqualTo 5 Greater than or equal to comparison operator.
GreaterThan 6 Greater than comparison operator.

CIMContouringEffect

Represents a surface effect for adding contour lines to surfaces in 3D views.

CIMSurfaceEffect

Property Type Description

CIMContouringEffect

Property Type Description
distance double Maximum distance for which the effect should be active measured in meters.
useRealWorldSizeThickness boolean A value indicating whether thickness should be measured in meters when true or measured in points when false.
thickness double The thickness of the contour lines measured in meters or points depending on the value of UseRealWorldSizeThickness.

Enumeration: CullDirection

Represents the direction for clipping.

Property Value Description
Inward 0 Clip the inside or forward.
Outward 1 Clip the outside or backwards.
Camera 2 Clip from the side that is closest to the camera.

CIMCutAndFillEADefinition

Represents a slice box exploratory analysis definition.

CIMExploratoryAnalysisDefinition

Property Type Description
ID long The id.

CIMCutAndFillEADefinition

Property Type Description
cutFillPlane Polygon The polygon indicating the area to cut the ground above and fill the ground below. Should be a level plane for best results.

CIMDatumTransform

Represents a datum transform.

CIMDatumTransform

Property Type Description
forward boolean A value indicating whether or not this is a forward transformation.
geoTransformation GeoTransformation The transformation.

CIMEditingElevation

Defines the properties needed to specify new Z values when creating or modifying features.

CIMEditingElevation

Property Type Description
captureMode enumeration EditingElevationCaptureMode The elevation capture mode.
constantValue double The the value used when CaptureMode is Constant.
surfaceID string The GUID of the map elevation surface to be used when CaptureMode is Surface.
constantValueUnit LinearUnit The Unit used when CaptureMode is Constant.

Enumeration: EditingElevationCaptureMode

Defines the capture mode used to specify new Z values when creating or modifying features.

Property Value Description
Off 0 No Elevation capturing mode is currently being used.
Constant 1 A constant value is used to populate all Z coordinates when an edit is performed.
Surface 2 A map elevation surface is used to populate all Z coordinates when an edit is performed.

CIMEditingTemplateCollection

Represents a collection of editing templates.

CIMEditingTemplateCollectionItem

Property Type Description
name string The name of this item.

CIMEditingTemplateCollection

Property Type Description
contents [CIMEditingTemplateCollectionItem] The array of items stored within this collection.
expanded boolean A value indicating whether this collection is expanded in the user interface.

CIMEditingTemplateReference

Represents a reference to an editing template.

CIMEditingTemplateCollectionItem

Property Type Description
name string The name of this item.

CIMEditingTemplateReference

Property Type Description
layerURI string The layer URI where this template is located.
templateName string The name of the template being referenced.

CIMElevationSource

Represents an elevation source.

CIMElevationSource

Property Type Description
dataConnection DataConnection The data connection.
verticalUnit Unit The vertical unit.
visibility boolean A value indicating whether the elevation source is visible.
name string The name of the elevation source.
metadataURI string The metadata URI of the elevation source.
elevationSourceID string The elevation source ID.

CIMFacilityLayerProperties

Defines the URI and required field properties for the Indoors Facility layer required for floor filtering operations.

CIMFacilityLayerProperties

Property Type Description
layerURI string The URI for the Indoors Facility layer in the map CIM.
subLayerID long The sublayer ID when the Facility layer is a sublayer within a dynamic map service layer.
siteIDField string The name of the field containing the site id (a foreign key back to the Site feature class).
facilityIDField string The name of the field containing the facility id.
nameField string The name of the field containing the facility name.

CIMFieldMapping

Represents a field mapping that maps fields from source layer or table to target layer or table.

CIMFieldMapping

Property Type Description
sourceURI string The URI of the source layer or table.
targetURI string The URI of the target layer or table.
mappingExpressionInfo CIMExpressionInfo The expression for mapping from source layer or table to target layer or table.

CIMFloorAwareMapProperties

Defines the properties needed to identify the Indoors layers and some required fields for each layer which are used for floor filtering operations, as well as properties for the map's floor filter.

CIMFloorAwareMapProperties

Property Type Description
siteLayerProperties CIMSiteLayerProperties The properties for the Indoors Sites layer in the map.
facilityLayerProperties CIMFacilityLayerProperties The properties for the Indoors Facilities layer in the map.
levelLayerProperties CIMLevelLayerProperties The properties for the Indoors Levels layer in the map.
defaultFloorFilterSettings CIMFloorFilterSettings The default properties for the map's floor filter control. Used as default when creating new map views.

CIMFloorFilterSettings

Represents floor filter settings.

CIMFloorFilterSettings

Property Type Description
selectedSiteID string The site ID for the selected site, which is used when filtering layers by SITE_ID (optional).
selectedFacilityID string The facility ID for the selected facility, which is used when filtering layers by FACILITY_ID.
selectedLevelID string The level ID for the selected level, which is used when filtering layers by LEVEL_ID or the layer's configured floor-aware properties.
enabled boolean A value indicating whether or not the floor filter is enabled and filtering the displayed content according to the floor filter selections.
minimized boolean A value indicating whether the floor filter has been minimized to show only the levels list or if it is showing the full set of breadcrumbs.
longNames boolean A value indicating whether the levels lists are showing the long names from the NAME field or showing the short names from the NAME_SHORT field.
pinnedLevels boolean A value indicating whether the levels portion of the floor filter have been pinned to show the levels lists or the floor filter includes the levels as a breadcrumb dropdown.
siteFacilityIDs [string] The array of facility ids belonging to the selected site (only if just site has been selected).
siteLevelIDs [string] The array of level ids belonging to the selected site (only if just site has been selected).

CIMGroundToGridCorrection

Defines the properties needed to perform a COGO ground to grid correction when adding new features.

CIMGroundToGridCorrection

Property Type Description
enabled boolean A value indicating whether ground to grid corrections are currently in operation for the map.
useDirection boolean A value indicating whether the direction angle will be used in the ground to grid correction.
useScale boolean A value indicating whether the distance scale will be used in the ground to grid correction.
direction double The direction angle (in degrees) that will be used in ground to grid calculations.
scaleType enumeration GroundToGridScaleType The type of scale that will be used in ground to grid calculations.
constantScaleFactor double The constant scale factor used in ground to grid calculations, only when .

Enumeration: GroundToGridScaleType

Defines modes for specifying Scale for ground to grid corrections.

Property Value Description
ConstantFactor 0 A constant scale factor will be used to specify scale for ground to grid corrections.
ComputeUsingElevation 1 The scale will be computed using the current Editing ElevationCapturing mode.

CIMIlluminationProperties

Represents illumination properties.

CIMIlluminationProperties

Property Type Description
ambientLight double The ambient light value.
sunPositionX double The sun position X.
sunPositionY double The sun position Y.
sunPositionZ double The sun position Z.
showAtmosphericEffects boolean A value indicating whether or not to show atmospheric effects.
showShadows3D boolean A value indicating whether or not to show shadows in 3D.
dateTime TimeInstant The time instant.
illuminationSource enumeration IlluminationSource The illumination source.
sunAzimuth double The sun azimuth.
sunAltitude double The sun altitude.
showStars boolean A value indicating whether to show the stars and the atmospheric halo for a global scene.
enableAmbientOcclusion boolean A value indicating whether to enable ambient occlusion for a scene or map.
enableEyeDomeLighting boolean A value indicating whether to enable eye-dome lighting for a scene or map.

Enumeration: IlluminationSource

Illumination source types.

Property Value Description
NoonAtCameraPosition 0 Noon at the camera position.
DateTime 1 Set for a specific date and time.
AbsoluteSunPosition 2 An absolute sun position.
MapTime 3 Synchronized with the current map time.

Enumeration: JoinOperator

Query builder Boolean operator types.

Property Value Description
And 1 And Boolean operator.
Or 2 Or Boolean operator.
None 3 No Boolean operator used. Used for the first item in a collection of Comparisons.

CIMKeyframeAnalysis

Represents an exploratory analysis keyframe.

CIMKeyframeAnalysis

Property Type Description
analysis ExploratoryAnalysisDefinition The exploratory analysis definition.
transition enumeration AnimationTransition The method of transition for the exploratory analysis item.

CIMKeyframeCamera

Represents a camera keyframe.

CIMKeyframeCamera

Property Type Description
camera CIMViewCamera The camera for the keyframe.
headingTransition enumeration AnimationTransition The method of transition for the heading of the camera.
pitchTransition enumeration AnimationTransition The method of transition for the pitch of the camera.
rollTransition enumeration AnimationTransition The method of transition for the roll of the camera.
scaleTransition enumeration AnimationTransition The method of transition for the scale of the camera.
XTransition enumeration AnimationTransition The method of transition for the x of the camera.
YTransition enumeration AnimationTransition The method of transition for the y of the camera.
ZTransition enumeration AnimationTransition The method of transition for the z of the camera.
transitionScale double The value of adjustable transitions. The value must be between 0.0 and 1.0. Smaller values will result in a tighter / smaller curve than larger values.
cameraTransitionMode enumeration esriAnimationTransitionMode The transition mode determines whether the camera path follows a Geodesic or Cartesian interpolation.
lookAt Geometry A geometry for the camera to look at. When a geometry is set it overrides the camera's heading and pitch. Must be in the map's spatial reference.
adjustedCameraPath Multipoint The bezier control points between the previous camera position and the current camera position. Used to define the camera path for the AdjustableArc transition. When the value is null or empty, a default path is used. Must be in the map's spatial reference.
fieldOfView double The field of view angle. Only applies to scene views.
fieldOfViewTransition enumeration AnimationTransition The method of transition for the field of view of the camera.

CIMKeyframeElevationSource

Represents an elevation source keyframe.

CIMKeyframeElevationSource

Property Type Description
sourceID string The id for the elevation source.
visible boolean A value indicating whether the elevation source is visible.

CIMKeyframeLayer

Represents a layer keyframe.

CIMKeyframeLayer

Property Type Description
layerURI string The path to the layer.
transparency double The method of transition for the visibility of the layer.
transparencyTransition enumeration AnimationTransition The method of transition for the transparency of the layer.
visible boolean A value indicating whether the layer is visible.
swipeDirection enumeration SwipeDirection The direction to clip from an edge.
swipePercent double The amount of the visible area to clip.
verticalExaggeration double The vertical exaggeration.
ZOffset double The vertical exaggeration.

CIMKeyframeRange

Represents a range keyframe.

CIMKeyframeRange

Property Type Description
range CIMRange The value of the active range.
minTransition enumeration AnimationTransition The method of transition for the minimum value of the range.
maxTransition enumeration AnimationTransition The method of transition for the maximum value of the range.
isExclusion boolean A value indicating whether the range should be all values less than the minimum value and greater than the maximum value.
layerRangeExtents [CIMLayerRange] The layer range extents. Each layer range applies to a single map.
layerRangeTransition enumeration AnimationTransition The method of transition for the layer range extents.
activeRangeLayer string The layer with the active range. Specify a single layer or leave empty to indicate all layers that share the active range name.
activeRangeName string The active range name. Used to update which range is active.

CIMKeyframeSurface

Represents a surface keyframe.

CIMKeyframeSurface

Property Type Description
surfaceID string The id for the surface.
transition enumeration AnimationTransition The method of transition for the surface.
verticalExaggeration double The vertical exaggeration for the surface.
visible boolean A value indicating whether the surface is visible.
swipeDirection enumeration SwipeDirection The direction to clip from an edge.
swipePercent double The amount of the visible area to clip.
baseSources [CIMKeyframeElevationSource] The elevation sources.

CIMKeyframeTime

Represents a time keyframe.

CIMKeyframeTime

Property Type Description
time TimeExtent The value of the time extent.
timeRelation enumeration esriTimeRelation The time relation.
endTimeTransition enumeration AnimationTransition The method of transition for the end value of the time extent.
startTimeTransition enumeration AnimationTransition The method of transition for the start value of the time extent.

CIMKeyframeVoxelLayer

Represents a voxel layer keyframe.

CIMKeyframeLayer

Property Type Description
layerURI string The path to the layer.
transparency double The method of transition for the visibility of the layer.
transparencyTransition enumeration AnimationTransition The method of transition for the transparency of the layer.
visible boolean A value indicating whether the layer is visible.
swipeDirection enumeration SwipeDirection The direction to clip from an edge.
swipePercent double The amount of the visible area to clip.
verticalExaggeration double The vertical exaggeration.
ZOffset double The vertical exaggeration.

CIMKeyframeVoxelLayer

Property Type Description
variableName string The name of the current symbolizer variable.
showSurface boolean A value indicating whether the surface is shown instead of the volume.
dataFilterMax double The maximum data value.
dataFilterMin double The minimum data value.
isosurfaces [CIMIsosurface] The voxel surfaces.
sections [CIMKeyframeVoxelPlane] The dynamic cross section planes.
lockedSections [CIMKeyframeVoxelPlane] The static cross section planes.
slices [CIMKeyframeVoxelPlane] The slice planes.

CIMKeyframeVoxelPlane

Represents a voxel plane keyframe.

CIMKeyframeVoxelPlane

Property Type Description
visible boolean A value indicating whether the plane is visible.
position double The position of the plane relative to the edge of the voxel.
orientation double The orientation of the plane around the z axis.
tilt double The tilt of the plane.

CIMLevelLayerProperties

Defines the URI and required field properties for the Indoors Level layer required for floor filtering operations.

CIMLevelLayerProperties

Property Type Description
layerURI string The URI for the Indoors Level layer in the map CIM.
subLayerID long The sublayer ID when the Level layer is a sublayer within a dynamic map service layer.
facilityIDField string The name of the field containing the facility id (a foreign key back to the Facility feature class).
levelIDField string The name of the field containing the level id.
shortNameField string The name of the field containing the level "short" name.
longNameField string The name of the field containing the level "long" name.
levelNumberField string The name of the field containing the level number.
verticalOrderField string The name of the field containing the vertical order for the level.

CIMLineOfSightEADefinition

Represents a line of sight exploratory analysis definition.

CIMExploratoryAnalysisDefinition

Property Type Description
ID long The id.

CIMLineOfSightEADefinition

Property Type Description
observer Point The observer position.
targets Multipoint The target positions.
maximumDistance double The maximum distance to be analyzed.
minimumDistance double The minimum distance to be analyzed.

CIMLocator

Represents properties of locator for the map.

CIMLocator

Property Type Description
locatorType enumeration LocatorType The type of locator for the LocatorURI specified.
name string The name of the locator.
locatorURI string Locator source URI. It can either be a local path, URL or a layer URI from this map. e.g. file://<folder_path>, http://<url>, CIMPATH=<cim_layer_UR>.
suggestionsEnabled boolean A value indicating whether or not to suggestions should enabled if the locator supports suggestions.
enabled boolean A value indicating whether or not to this locator is enabled.
suggestionsSupported boolean A value indicating whether the locator supports suggestions.

Enumeration: LocatorType

Type of locators.

Property Value Description
Locator 0 Locator is based on local locator file or URL.
Layer 1 LocatorURI is based on a Layer in the map
Table 2 LocatorURI is based on a Table in the map

CIMMap

Represents a map or scene. A map is a container of geographic information. There are different kinds of geographic information within a map: imagery, terrain, and different kinds of vector data. The information in a map is organized into layers. A map contains an ordered list of layers, and draws each layer on top of its preceding layers. In 3D layers may be drawn in Z order and not layer order. A map has a single spatial reference system. Each of its layers can be stored natively in different spatial reference systems. If a layer has a different spatial reference system than a map it is displayed in, the map reprojects the data to its spatial reference system before drawing it. A map can dynamically place labels for its features. It finds optimal label locations for each map extent to maximize typographic clarity and to avoid overlaps.

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.

CIMMap

Property Type Description
defaultCamera CIMViewCamera The default camera.
illumination CIMIlluminationProperties The illumination properties.
layers [string] The layers as an array of layer repository paths.
stereoProperties CIMMapStereoProperties The stereo properties.
defaultViewingMode enumeration MapViewingMode The default viewing mode.
mapType enumeration MapType The map type.
rangeSliderSettings CIMSliderSettings The range slider settings.
timeSliderSettings CIMSliderSettings The time slider settings.
animationViewTracks [CIMViewTrack] The collection of view tracks in the animation.
animationActiveTrackName string The name of the currently active animation track.
locators [CIMLocator] The locators as an ordered array.
validationRules [CIMValidationRule] The validation rules used for validating the layer's features.
mapContexts [string] An array string values used to provide a hint for the intended context for the map.
standaloneVideos [string] The standalone videos as an array of video repository paths.
customProperties [CIMStringMap] The custom properties of the map. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
linkCharts [string] The link charts as an array of link chart repository paths.
timelines [string] The timelines as an array of timeline repository paths.
knowledgeGraphLinkChartProperties CIMKnowledgeGraphLinkChartProperties The Knowledge Graph Link Chart properties of this map. This property is only applicable if the MapType is LinkChart.

CIMStandaloneTableContainer

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

CIMMapDefinition

Property Type Description
backgroundColor Color The background color.
bookmarks [CIMBookmark] The bookmarks.
clipToFullExtent boolean A value indicating whether or not to clip to full extent.
attribution string The attribution text that will appear on the map when it is drawn.
customFullExtent Polygon The custom full extent as a polygon.
datumTransforms [CIMDatumTransform] The set of geographic transformations used by the map for spatial references that do not have vertical coordinate system.
defaultExtent Envelope The extent shown when you open new views of the map. The application automatically updates this property whenever you save a project with an active map view.
defaultScale double The scale used when you open new views of the map. When set, the application automatically applies this property after DefaultExtent to ensure the view is at the correct scale.
defaultGlobeTransparency double The transparency of the spheroid's combined terrain mesh and draped content.
defaultRotation double The default rotation.
description string The long description of the map.
elevationSurfaces [CIMMapElevationSurface] The elevation surfaces.
generalPlacementProperties GeneralPlacementProperties The general label placement properties for dynamic labels in the map.
scaleLevels [double] The scale levels of the map.
snappingProperties CIMSnappingProperties The snapping properties of the map.
spatialReference SpatialReference The map's spatial reference.
surfaceColor Color The color of the default spheroid.
timeDisplay CIMMapTimeDisplay The time display properties.
enableNavigationBelowGround boolean A value indicating whether or to enable navigation below the ground.
referenceScale double The map reference scale.
enableWraparound boolean A value indicating whether or to enable wraparound when the coordinate system supports it.
includeMaximumInScaleRanges boolean A value indicating whether or not to draw up to and including the maximum scale in scale ranges.
colorModel enumeration ColorModel The color model for a map.
scales [CIMScale] An array of CIMScale objects, describing the full list of named scales for the map.
snapToScales boolean A value indicating whether to snap only to the map's list of named scales when zooming.
scaleFormat CIMScaleFormat The scale format describing the formatting of the scale value.
scaleDisplayFormat enumeration ScaleDisplayFormat The display mode for the map's Scales in the user interface.
HVDatumTransforms ArrayOfCompositeHVDatumTransformation The set of geographic transformations used by the map for spatial references with vertical coordinate system.
useServiceLayerIDs boolean A value indicating whether to allow the use of unique numeric IDs on layers that will be used when publishing services.
groundToGridCorrection CIMGroundToGridCorrection The Ground To Grid Correction properties.
clippingMode enumeration ClippingMode The clipping mode for a map.
customClippingShapeURI string The URI of the custom clipping shape used when the clipping mode is set to CustomShape.
layersExcludedFromClipping [string] The layers to be excluded from clipping. The layers are defined as an array of layer repository paths.
surfacesExcludedFromClipping [string] The surfaces to be excluded from clipping. The surfaces are defined as an array of surface IDs.
clippingAreaBorderSymbol CIMSymbolReference The border symbol used for displaying the clipping area.
nearPlaneClipDistanceMode enumeration ClipDistanceMode The near plane clipping mode for a scene. This property applies to only local and global viewing modes.
nearPlaneClipDistance double The near plane clip distance in meters for a scene. This property applies to only local and global viewing modes.
editingElevation CIMEditingElevation The editing elevation mode.
editingTemplateCollection CIMEditingTemplateCollection The collection of editing templates for a map.
fieldMappings [CIMFieldMapping] The collection of field mappings for a map.
RGBColorProfile string The name of the RGB color profile for a map.
CMYKColorProfile string The name of the CMYK color profile for a map.
simulateOverprint boolean A value indicating whether to simulate overprint for a map.
floorAwareMapProperties CIMFloorAwareMapProperties The floor-aware properties of the map.

CIMMapElevationSurface

Represents a map elevation surface.

CIMMapElevationSurface

Property Type Description
baseSources [CIMElevationSource] The elevation sources.
elevationMode enumeration ElevationMode The elevation mode.
name string The elevation name.
verticalExaggeration double The vertical exaggeration.
mapElevationID string The map elevation ID.
color Color The surface color.
enableSurfaceShading boolean A value indicating whether this elevation surface has shadows.
surfaceTINShadingMode enumeration SurfaceTINShadingMode The elevation surface shading mode for TIN elevation sources.
visibility boolean A value indicating whether the elevation surface is visible.
metadataURI string The elevation metadata URI.
offset double The vertical exaggeration.
expanded boolean A value indicating whether the elevation surface is expanded in the contents pane.
useSurfaceEffect boolean A value indicating whether the current surface effect should be applied in 3D views.
surfaceEffect SurfaceEffect The surface effect definition for the elevation surface.

CIMMapStereoProperties

Represents map stereo properties.

CIMMapStereoProperties

Property Type Description
leftImage DataConnection The left image of the stereo pair.
rightImage DataConnection The right image of the stereo pair.
sourceType enumeration StereoSourceType The stereo source type.
stereoModelCollection DataConnection The data connection to the source stereo model collection.
leftImageID long long The OID of the left image of the current stereo model in a collection.
rightImageID long long The OID of the right image of the current stereo model in a collection.
leftImageColorizer CIMRasterColorizer The colorizer for the left image.
rightImageColorizer CIMRasterColorizer The colorizer for the right image.
adjustColorizersInSync boolean A value indicating whether adjustments to either colorizer should be synced to the other.
isInverted boolean A value indicating whether the left and right images of the stereo model should be swapped.
stereoModelDisplayMode enumeration StereoModelDisplayMode The stereo model display mode.
orientation enumeration StereoOrientation The stereo model display orientation.

CIMMapTimeDisplay

Represents map time display.

CIMMapTimeDisplay

Property Type Description
currentTimeExtent TimeExtent The current time extent.
defaultTimeInterval double The default time interval.
defaultTimeIntervalUnits enumeration esriTimeUnits The default time interval units.
defaultTimeWindow double The default time window.
fullTimeExtent TimeExtent The full time extent.
timeReference TimeReference The time reference.
timeValue TimeValue The time value.
hasLiveData boolean A value indicating whether or not this map has live data.
timeRelation enumeration esriTimeRelation The time relation.
uniqueTimes [double] A cached set of unique OLE date values. Expected to be in the CIMMapTimeDisplay's TimeReference.

Enumeration: MapType

Types of maps.

Property Value Description
Map 0 A 2D map.
Scene 1 A scene.
Basemap 2 A basemap.
NetworkDiagram 3 A network diagram.
ContainmentMap 4 A containment map.
LinkChart 5 A link chart.

CIMScale

Represents a 2D scale or 3D Distance.

CIMScale

Property Type Description
value double The numeric value representing the 2D scale or 3D distance.
alias string The string value for the alias name of the Scale.

Enumeration: ScaleDisplayFormat

Scale display formats.

Property Value Description
Value 0 Show just the Scale value.
Alias 1 Show just the Scale alias name.
ValueAndAlias 2 Show the Scale value, and then the Scale alias name.
AliasAndValue 3 Show the Scale alias name, and then the Scale value.

CIMScaleFormat

Represents the scale formatting options.

CIMScaleFormat

Property Type Description
formatType enumeration ScaleFormatType The format used to display scale, i.e., 1:20000 or 1 inch equals 5 miles.
separator string The character(s) used to separate '1' from the scale in an absolute scale, e.g ':' in 1:20000.
reverseOrder boolean A value indicating whether to reverse the standard order. e.g. [1:1000] becomes [1000:1] and [1 in=10 mi] becomes [10 mi=1 in].
decimalPlacesThreshold double The number the scale has to be less than or equal to display decimal places.
decimalPlaces long The number decimal places.
showThousandSeparator boolean A value indicating whether to show the thousands separator, e.g., 1:20,000.
pageUnits LinearUnit The page units used to display a scale,e.g, the 'inch' in 1 inch=5 miles.
pageUnitValue double The number preceding the page units in a scale, i.e., the '1' in 1 inch=5 miles.
equalsSign string The text used for 'equals', e.g, '=' in 1 inch=5 miles.
mapUnits LinearUnit The map units used to display a scale, e.g, the 'miles' in 1 inch=5 miles.
capitalizeUnits boolean A value indicating whether to capitalize the units in the scale string.
abbreviateUnits boolean A value indicating whether to abbreviate the units in the scale string.

Enumeration: ScaleFormatType

Scale format types.

Property Value Description
Absolute 0 Display absolute format, e.g. 1:20000.
Imperial 1 Display imperial format, e.g. 1 in = 1 mi.

CIMSiteLayerProperties

Defines the URI and required field properties for the Indoors Site layer required for floor filtering operations.

CIMSiteLayerProperties

Property Type Description
layerURI string The URI for the Indoors Site layer in the map CIM.
subLayerID long The sublayer ID when the Site layer is a sublayer within a dynamic map service layer.
siteIDField string The name of the field containing the site id.
nameField string The name of the field containing the site name.

CIMSliceBoxEADefinition

Represents a slice box exploratory analysis definition.

CIMExploratoryAnalysisDefinition

Property Type Description
ID long The id.

CIMSliceBoxEADefinition

Property Type Description
centerPoint Point The center position.
heading double The heading in degrees from North. 0 is North, 90 is West, 180 is South, -90 is East, etc.
height double The height.
width double The width.
depth double The depth.
cullDirection enumeration CullDirection The depth.

CIMSliceCylinderEADefinition

Represents a slice cylinder exploratory analysis definition.

CIMExploratoryAnalysisDefinition

Property Type Description
ID long The id.

CIMSliceCylinderEADefinition

Property Type Description
centerPoint Point The observer position.
heading double The heading in degrees from North. 0 is North, 90 is West, 180 is South, -90 is East, etc.
pitch double The pitch in degrees from horizontal. 0 is horizontal, 90 is looking directly up and -90 is looking directly down.
height double The height.
width double The width.
cullDirection enumeration CullDirection The direction that is clipped.

CIMSlicePlaneEADefinition

Represents a slice plane exploratory analysis definition.

CIMExploratoryAnalysisDefinition

Property Type Description
ID long The id.

CIMSlicePlaneEADefinition

Property Type Description
centerPoint Point The observer position.
heading double The heading in degrees from North. 0 is North, 90 is West, 180 is South, -90 is East, etc.
pitch double The pitch in degrees from horizontal. 0 is horizontal, 90 is looking directly up and -90 is looking directly down.
height double The height.
width double The width.
cullDirection enumeration CullDirection The direction that is clipped.

CIMSliceSphereEADefinition

Represents a slice sphere exploratory analysis definition.

CIMExploratoryAnalysisDefinition

Property Type Description
ID long The id.

CIMSliceSphereEADefinition

Property Type Description
centerPoint Point The observer position.
radius double The analysis distance from the center position.
cullDirection enumeration CullDirection The direction that is clipped.

Enumeration: SliderExtentType

Slider extent types.

Property Value Description
AllLayers 0 All layers.
VisibleLayers 1 Visible layers.
SingleLayer 2 A single layer.
CustomRange 3 A custom range.

Enumeration: SliderInteractionMode

Slider interaction modes.

Property Value Description
Slider 0 Present the values on a slider as a range
Picker 1 Present the values individually

CIMSliderSettings

Represents slider settings.

CIMSliderSettings

Property Type Description
sliderExtent CIMRange The extent shown on the slider.
sliderExtentLocked boolean A value indicating whether the slider extent will not change due to scrolling or using the mouse wheel.
startValueLocked boolean A value indicating whether the slider's start thumb will not accept mouse events.
endValueLocked boolean A value indicating whether the slider's end thumb will not accept mouse events.
flipVertically boolean A value indicating whether the slider is flipped vertically to put larger values at the bottom and smaller values at the top.
useWindowValue boolean A value indicating whether the distance between the start and end thumbs will remain constant.
windowValue double The value of the window on the slider.
windowUnit string The unit of the window on the slider (for time it could be days, weeks, months, etc.).
stepUsesWindow boolean A value indicating whether the step interval value will stay in sync with the sliders value window when possible.
stepIntervalValue double The specific distance to move the thumbs by when stepping or playing.
stepIntervalUnit string The unit the interval value is in (for time it could by days, weeks, months, etc..)
stepCount double The number of steps to divide the slider extent into.
stepOption enumeration SliderStepType The chosen method of determining the step size.
stepLayerURI string The URI of the layer to get step information from.
playWaitSeconds double The amount of time to wait between steps.
playForward boolean A value indicating whether the play direction is forward.
playRepeats boolean A value indicating whether play continuously repeats until interrupted by user interaction.
playReverses boolean A value indicating whether play direction will reverse after playing to the end (if repeat is false play will move each direction once then stop).
fullExtentOption enumeration SliderExtentType The option that determines the extent used by the full extent button.
fullExtentLayerURI string The URI of the layer used for the full extent with single layer full extent option.
fullExtentCustomRange CIMRange The custom full extent used with the custom range full extent option.
interactionMode enumeration SliderInteractionMode Slider interaction mode.
useTimeSnapping boolean A value indicating whether automatic snapping for the map's current time settings is enabled.
timeSnapMode enumeration TimeSnapMode The option that determines mode used for snapping the map's current time settings.
singleTimeSnapUnit string The time unit to snap to when in 'Single' time snapping mode.
aliasExpressionLayerURI string The string containing URI of the layer that contains the alias definition.
isMinimized boolean A value indicating whether to collapse the slider over the map view.
ignoreInactiveValues boolean A value indicating whether to ignore values not currently set to show on the slider.
liveMode boolean A value indicating whether the slider should continuously progress the slider to the current time.
liveModeOffsetDirection enumeration TimeOffsetDirection The direction to offset the time span relative to the current time.

Enumeration: SliderStepType

Slider step types.

Property Value Description
Interval 0 Interval.
Count 1 Count.
Feature 2 Feature.

Enumeration: SnapRequestType

Snap request types.

Property Value Description
SnapRequestType_None 0 No snapping.
SnapRequestType_GeometricSnapping 1 Geometric snapping.
SnapRequestType_VisualSnapping 2 Visual snapping.
SnapRequestType_GeometricAndVisualSnapping 3 Geometric and visual snapping.

Enumeration: SnapTipDisplayPart

Snap tip display parts. Defines displayable parts of a snap tip. CIMSnappingProperties.SnapTipDisplayParts consists of the desired snap part bits OR-ed together.

Property Value Description
SnapTipDisplayNone 0 Don't display a snap tip.
SnapTipDisplayLayer 1 Display the layer name in a snap tip.
SnapTipDisplayType 2 Display the snap type in a snap tip.

Enumeration: SnapXYToleranceUnit

Snap XY tolerance units.

Property Value Description
SnapXYToleranceUnitPixel 0 Pixels.
SnapXYToleranceUnitMap 1 Map units.

CIMSnappingProperties

Represents snapping properties.

CIMSnappingProperties

Property Type Description
XYTolerance double The XY tolerance.
XYToleranceUnit enumeration SnapXYToleranceUnit The XY tolerance unit.
ZTolerance double The Z tolerance.
ZToleranceEnabled boolean A value indicating whether Z tolerance is enabled. When enabled, the value is used to evaluate Z snapping. When disabled, the is considered to be infinite. The value is considered to be false (disabled) in 3D views.
snapToSketchEnabled boolean A value indicating whether snapping to the sketch is enabled.
snapRequestType enumeration SnapRequestType The snap request type.
geometricFeedbackColor Color Geometric feedback color.
visualFeedbackColor Color The visual feedback color.
showSnapTip boolean A value indicating whether the snap tip is visible. Deprecated at 2.9, use SnapTipDisplayParts instead.
isZSnappingEnabled boolean A value indicating whether Z snapping is enabled. When enabled, snapping to a feature Z value may occur if the feature is within the Z tolerance from the current cursor Z value. The Z tolerance is specified by is true. Otherwise, the Z tolerance is infinite. Z snapping is always enabled for Stereo and 3D views.
snapTipDisplayParts long A value indicating whether the snap tip is fully or partially visible. The int value consists of zero or more enum bit values that are OR-ed together.

Enumeration: StereoModelDisplayMode

Stereo model display modes.

Property Value Description
Default 0 Display both the left and right images of the stereo model.
OnlyLeftImage 1 Display only the left image of the stereo model.
OnlyRightImage 2 Display only the right image of the stereo model.
None 3 Turn off stereo model.

Enumeration: StereoOrientation

Stereo model orientation.

Property Value Description
UpOrRight 0 North pointing to up (for east-west or west-east images) or to right (for north-south or south-north images) in stereo view.
UpOrLeft 1 North pointing to up (for east-west or west-east images) or to left (for north-south or south-north images) in stereo view..
DownOrRight 2 North pointing to down (for east-west or west-east images) or to right (for north-south or south-north images) in stereo view..
DownOrLeft 3 North pointing to down (for east-west or west-east images) or to left (for north-south or south-north images) in stereo view..

Enumeration: StereoSourceType

Stereo source types.

Property Value Description
StereoModel 0 Stereo source is a single stereo model (image pair).
StereoModelCollection 1 Stereo source is a collection of stereo models (image pairs).

Enumeration: SurfaceTINShadingMode

Surface TIN shading modes.

Property Value Description
Smooth 0 Smooth shading.
Flat 1 Flat shading.

Enumeration: SwipeDirection

Represents the direction from an edge of the view used to clip a layer.

Property Value Description
None 0 None
Top 1 Top
Bottom 2 Bottom
Left 3 Left
Right 4 Right

Enumeration: TimeOffsetDirection

Time offset direction.

Property Value Description
Past 0 Past.
Future 1 Future.
PastAndFuture 2 Past and future.

Enumeration: TimeSnapMode

Mode used for snapping the map's current time settings.

Property Value Description
Automatic 0 Snap to an automatically-calculated time unit, based on the map's full time extent and view window size
Single 1 Snap to a user-specified time unit, such as "Minute" or "Year"
Interval 2 Snap to the time-interval value that has been defined for the Range Slider

CIMViewCamera

Represents a view camera.

CIMViewCamera

Property Type Description
heading double The heading.
pitch double The pitch.
roll double The roll.
scale double The scale.
x double X.
y double Y.
z double Z.
viewportHeight double The height of the viewport in meters. Viewport height and width are used for consistent camera positioning in isometric 3D views, eye separation in 3D stereo views and defines the focal distance in perspective views.
viewportWidth double The width of the viewport in meters. Viewport height and width are used for consistent camera positioning in isometric 3D views, eye separation in 3D stereo views and defines the focal distance in perspective views.

CIMViewDomeEADefinition

Represents a view dome exploratory analysis definition.

CIMExploratoryAnalysisDefinition

Property Type Description
ID long The id.

CIMViewDomeEADefinition

Property Type Description
observer Point The observer position.
maximumDistance double The maximum distance to be analyzed.
minimumDistance double The maximum distance to be analyzed.

CIMViewKeyframe

Represents a view keyframe.

CIMViewKeyframe

Property Type Description
trackTime double The value of time in seconds that the keyframe exists in the track.
camera CIMKeyframeCamera The camera keyframe.
layers [CIMKeyframeLayer] The collection of layer keyframes.
range CIMKeyframeRange The range keyframe.
time CIMKeyframeTime The time keyframe.
surfaces [CIMKeyframeSurface] The collection of surface keyframes.
exploratoryAnalysis [CIMKeyframeAnalysis] The collection of exploratory analysis.

CIMViewTrack

Represents a animation view track.

CIMViewTrack

Property Type Description
name string The name of the track.
keyframes [CIMViewKeyframe] The collection of view keyframes.
screenGraphics [CIMAnimationScreenGraphic] The list of graphic overlays used in the animation.
referenceResolutionWidth long The desired pixel width the animation was made to export at.
referenceResolutionHeight long The desired pixel height the animation was made to export at.
exportType string The export MIME type. Supported formats: video/mp4, video/avi, image/gif, image/jpeg, or image/png.
frameRate double The number of frames per second.
dataRateFactor double The data rate factor. A higher data rate can give better quality, but produces a larger file.
startFrameTime double What time in the animation to start at for exporting.
endFrameTime double What time in the animation to end at for exporting.

CIMViewshedEADefinition

Represents a viewshed exploratory analysis definition.

CIMExploratoryAnalysisDefinition

Property Type Description
ID long The id.

CIMViewshedEADefinition

Property Type Description
observer Point The observer position.
heading double The heading in degrees from North. 0 is North, 90 is West, 180 is South, -90 is East, etc.
pitch double The pitch in degrees from horizontal. 0 is horizontal, 90 is looking directly up and -90 is looking directly down.
horizontalAngle double The horizontal viewing angle.
verticalAngle double The vertical viewing angle.
maximumDistance double The maximum distance to be analyzed.
minimumDistance double The minimum distance to be analyzed.