CIMLayout.md

May 13, 2026 ยท View on GitHub

Enumeration: Anchor

A list of anchor positions for an element on a page layout.

PropertyValueDescription
Unspecified0Unspecified.
TopLeftCorner1Top, left corner.
TopMidPoint2Top, middle location.
TopRightCorner3Top, right corner.
LeftMidPoint4Left, middle location.
CenterPoint5Center location.
RightMidPoint6Right, middle location.
BottomLeftCorner7Bottom, left corner.
BottomMidPoint8Bottom, middle location.
BottomRightCorner9Bottom, right corner.

Enumeration: AttachmentFilterType

Represents the attachment filter type. The filter attachment type determines which attachments from the feature are shown in the exported report.

PropertyValueDescription
None0Display all the attachments.
First1Display the first number of attachments according to sort order.
Last2Display the last number of attachments according to sort order.
Index3Display only the specified indexed attachment.

CIMAttachmentFrame

Represents an attachment graphic frame.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMAttachmentFrame

PropertyTypeDescription
maxImageslongMaximum number of image attachments to display. If -1, all images attachments will be available.
sortFieldNamestringField name to sort.
sortOrderenumeration FieldSortInfoSort order of image attachments.
imageFrameCIMGraphicFrameThe graphic symbology of each attachment image frame.
gridRowslongThe number of attachment image rows. If less than 0, the number of rows is automatically calculated.
gridColumnslongThe number of attachment image columns.
gridRowDirectionbooleanA value indicating whether the grid layout is in row major order.
imageHeightdoubleThe height of each attachment image.
imageWidthdoubleThe width of each attachment image.
startOnNewPagebooleanA value indicating whether the first attachment image should start on a new page.
imageRotationdoubleThe rotation of all attachment images. The value is in degrees counterclockwise.
imageRotationExpressionCIMExpressionInfoThe rotation of each attachment image using an expression. This value overrides the ImageRotation value.
whereClausestringThe where clause that queries the attachment table. The where clause is used before applying the filter type. For example, CONTENT_TYPE = 'image/jpeg'.
filterTypeenumeration AttachmentFilterTypeThe attachment filter type. The filter attachment type determines which attachments from the feature that are used in the exported report.
filterValuelongThe filter value. When using the First or Last attachment filter type, the value indicates the number of attachments to use in the grid configuration. When using the Index attachment filter type, the value indicates the index and is zero-based.
excludedCellsstringThe list of excluded grid cells. Cells that are excluded are left blank when the report is exported.

CIMAutoCamera

Represents the camera settings associated with a map frame on a page layout.

CIMAutoCamera

PropertyTypeDescription
cameraCIMViewCameraThe camera associated with the map frame.
autoCameraTypeenumeration AutoCameraTypeThe camera type.
extentEnvelopeThe extent for a map frame when using the fixed constraint.
intersectLayerPathstringThe layer being used to set the camera when using the map frame link constraint.
mapFrameLinkNamestringThe map frame name being used to set the camera when using the map frame link constraint.
margindoubleThe margin value for a map frame with a map frame link constraint.
marginTypeenumeration UnitTypeThe margin type for a map frame with a map frame link constraint.
marginUnitsUnitThe margin units for a map frame with a map frame link constraint.
sourceenumeration AutoCameraSourceThe extent constraint associated with the map frame.
syncRotationbooleanA value indicating whether the map frame should rotate when using a map frame link constraint.

Enumeration: AutoCameraSource

A list of the advanced map frame options that further controls the camera behavior.

PropertyValueDescription
None0Use navigation tools to set the extent.
Fixed1The extent specified will not change.
MapFrameLink2Base the extent on another map frame.
MapSeriesLink3Base the extent on the extent of the index feature.

Enumeration: AutoCameraType

A list of the options available when using a fixed constraint.

PropertyValueDescription
Center0Show the map at the specified center point.
Scale1Show the map at the specified scale.
CenterAndScale2Show the map at the specified center point and scale.
Extent3Show the map at a specified extent.

CIMAviationArrow

Represents an individual arrow in CIMAviationNorthArrow.

CIMAviationArrow

PropertyTypeDescription
lineIndicatorTextSymbolCIMSymbolReferenceThe indicator text symbol for the arrow.
lineSymbolCIMSymbolReferenceThe line symbol for the arrow.
defaultPointSymbolCIMSymbolReferenceThe default point symbol for the arrow.
positivePointSymbolCIMSymbolReferenceThe positive point symbol for the arrow.
negativePointSymbolCIMSymbolReferenceThe negative point symbol for the arrow.
enableArrowbooleanA value indicating whether the arrow is enabled.
enableLineIndicatorbooleanA value indicating whether the arrow's line indicator is enabled.
arrowLengthdoubleThe line length for the arrow, internally units will always be of type points.
lineIndicatorTextstringThe text for the line indicator text symbol.

CIMAviationNorthArrow

Represents a aviation north arrow which displays declination of true, grid and magnetic north.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMNorthArrow

PropertyTypeDescription
referenceLocationPointThe reference location for a north arrow.
calibrationAngledoubleThe calibration angle for a north arrow.

CIMAviationNorthArrow

PropertyTypeDescription
dateTimeInstantThe date used when calculating declination using world magnetic model.
declinationSpatialReferenceSpatialReferenceThe spatial reference used for calculating declination, typically a UTM zone.
GMAngleCIMDeclinationThe Grid Magnetic declination.
gridConvergenceCIMDeclinationThe Grid Convergence declination.
trueNorthArrowCIMAviationArrowThe true north arrow for aviation north arrow.
magneticNorthArrowCIMAviationArrowThe magnetic north arrow for the aviation north arrow.
gridNorthArrowCIMAviationArrowThe grid north arrow for the aviation north arrow.
variationCIMAviationVariationThe variation for the aviation north arrow.
rateOfChangeTextSymbolCIMSymbolReferenceThe rate of change text symbol for the north arrow.
displayVariationDatebooleanA value indicating whether to display the variation date.
displayRateOfChangebooleanA value indicating whether to display the rate of change text.
autoUpdatebooleanA value indicating whether the north arrow auto updates.
rateOfChangeTextstringThe rate of change text displayed.

CIMAviationVariation

Represents the properties for the variation text which is displayed in aviation north arrow.

CIMAviationVariation

PropertyTypeDescription
variationTextSymbolCIMSymbolReferenceThe text symbol used for variation text in aviation north arrow.
alignVariationToLinebooleanA value indicating whether to align text to line or display on side.
variationTextOnLeftbooleanA value indicating whether the variation text will be displayed on the left side of aviation north arrow, if false will display on the right side.
showYearbooleanA value indicating whether to show the variation year in the variation text.
showYearInParenthesisbooleanA value indicating whether to show the variation year enclosed in parenthesis.
variationYearSeparatorstringThe string separator that goes between the variation text and the variation year.
magneticVariationIdentifierstringThe magnetic north identifier for the variation text.
gridVariationIdentifierstringThe grid north identifier for the variation text.

CIMAviationVerticalScaleBar

Represents an aviation-specific Vertical Scale Bar.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMAviationVerticalScaleBar

PropertyTypeDescription
verticalLineSymbolCIMSymbolReferenceThe line symbol for the vertical line of the scale bar.
feetScaleCIMAviationVerticalScalePropertiesThe feet scale properties for the vertical scale bar.
meterScaleCIMAviationVerticalScalePropertiesThe meters scale properties for the vertical scale bar.
divisionMarkHeightdoubleThe division marker's height.
divisionsBeforeZerobooleanA value indicating whether to show division symbols before zero.
feetOnRightbooleanA value indicating whether to show feet on the right, if false will show feet on the left and meters on the right.

CIMAviationVerticalScaleProperties

Represents a set of scale properties for aviation-specific Vertical Scale Bar, such as a feet scale or meter scale properties.

CIMAviationVerticalScaleProperties

PropertyTypeDescription
unitTextSymbolCIMSymbolReferenceThe text symbol used for the scale unit.
divisionMarkSymbolCIMSymbolReferenceThe line symbol for the divisions.
subdivisionMarkSymbolCIMSymbolReferenceThe line symbol for the subdivisions.
scaleTextSymbolCIMSymbolReferenceThe text symbol for the scale values.
scaleBarHeightdoubleThe height for the scale bar.
divisionLineLengthdoubleThe division line length for the scale bar. The units are in points.
subdivisionLineLengthdoubleThe subdivision line length for the scale bar. The units are in points.
scaleUnitTextstringThe string value for the scale unit text.
divisionslongThe division count for the scale.
subdivisionslongThe subdivision count for the scale.
visiblebooleanA value indicating whether to show this scale, if false no graphics will be shown.

CIMBookmarkMapSeries

Bookmark map series is a means to create a series of map pages based on saved bookmarks.

CIMMapSeries

PropertyTypeDescription
enabledbooleanA value indicating whether the map series is enabled on the layout.
mapFrameNamestringThe URI of the MapFrame to which MapSeries is linked.
startingPageNumberlongThe starting page number.
currentPageIDlong longThe current page Id.

CIMBookmarkMapSeries

PropertyTypeDescription
pages[CIMBookmarkMapSeriesPage]The pages.
scaleRoundingdoubleThe specified value to which the scale rounds.
extentOptionsenumeration ExtentFitTypeThe extent fitting options.
marginTypeenumeration UnitTypeThe type of margin.
marginUnitsLinearUnitThe units of the margin.
margindoubleThe value of the margin.

CIMBookmarkMapSeriesPage

A map series page based on a bookmark.

CIMBookmarkMapSeriesPage

PropertyTypeDescription
bookmarkNamestringThe bookmark.
mapURIstringThe map.
categorystringThe category. Category lets you organize your pages into groups.

CIMChartFrame

Layout element used to display a chart.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMChartFrame

PropertyTypeDescription
mapMemberURIstringThe layer or standalone table that defines the data to display.
chartNamestringThe chart to display.
isDynamicbooleanA value indicating whether the chart is dynamic.
useMapSeriesShapebooleanA value indicating whether the chart uses the map series shape.

Enumeration: ColumnDirection

A list of column layouts.

PropertyValueDescription
AcrossDown0Data is filled row by row from left to right.
DownAcross1Data is filled column by column from top to bottom.

CIMCondensedTabGridLine

Defines a condensed tab.

CIMGridLine

PropertyTypeDescription
namestringName of the grid line.
elementTypeenumeration GridElementTypeThe type of the graticule element.
gridLineOrientationenumeration GridLineOrientationThe orientation of the gridLine with reference to the coordinate system of the spatial reference. For graticules it is latitudes and longitudes. For grids it is eastings and northings.
symbolCIMSymbolReferenceSymbol of the grid line.
patternCIMGridPatternThe pattern of the grid lines.
fromTickCIMExteriorTickThe properties of the tick that is at the start of the grid line it represents.
toTickCIMExteriorTickThe properties of the tick that is at the end of the grid line it represents.
interiorTicks[CIMInteriorTick]The properties of the interior ticks for a grid line.
visibleIndices[long]The visibility of the corner labels to edges by index.

CIMTabGridLine

PropertyTypeDescription
alternatingSymbolsbooleanA value indicating whether symbols for the tab are alternating.
alternatingSymbolCIMSymbolReferenceThe alternating symbol.
heightdoubleThe height of the tab. The height in defined in page units.

CIMCondensedTabGridLine

PropertyTypeDescription
widthdoubleThe width of the tab. The width is in page units.
condensedTabenumeration CondensedTabTypeThe type of condensed tab.

Enumeration: CondensedTabType

Defines the type of condensed tab.

PropertyValueDescription
Round0Defines a rounded condensed tab.
Rectangle1Defines a rectangular condensed tab.
RoundedRectangle2Defines a rounded rectangle condensed tab.

CIMContiguousTabGridLine

Defines a contiguous tab for a referenced grid.

CIMGridLine

PropertyTypeDescription
namestringName of the grid line.
elementTypeenumeration GridElementTypeThe type of the graticule element.
gridLineOrientationenumeration GridLineOrientationThe orientation of the gridLine with reference to the coordinate system of the spatial reference. For graticules it is latitudes and longitudes. For grids it is eastings and northings.
symbolCIMSymbolReferenceSymbol of the grid line.
patternCIMGridPatternThe pattern of the grid lines.
fromTickCIMExteriorTickThe properties of the tick that is at the start of the grid line it represents.
toTickCIMExteriorTickThe properties of the tick that is at the end of the grid line it represents.
interiorTicks[CIMInteriorTick]The properties of the interior ticks for a grid line.
visibleIndices[long]The visibility of the corner labels to edges by index.

CIMTabGridLine

PropertyTypeDescription
alternatingSymbolsbooleanA value indicating whether symbols for the tab are alternating.
alternatingSymbolCIMSymbolReferenceThe alternating symbol.
heightdoubleThe height of the tab. The height in defined in page units.

CIMContiguousTabGridLine

PropertyTypeDescription
contiguousTabenumeration ContiguousTabTypeThe contiguous tab type.

Enumeration: ContiguousTabType

Represents a type of contiguous tabs.

PropertyValueDescription
Continuous0Represents a continuous tab.
Rounded1Represents a rounded tab.
Squared2Represents a squared tab.

CIMCruisingAltitudeDiagram

Represents a Cruising Altitude Diagram.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMCruisingAltitudeDiagram

PropertyTypeDescription
diagramTypeenumeration CruisingAltitudeDiagramTypeThe diagram type which should be created.
altitudeTextSymbolCIMSymbolReferenceThe text symbol used for the altitude values on the diagram.
bearingTextSymbolCIMSymbolReferenceThe text symbol used for the bearing values for each part of the diagram.
titleTextSymbolCIMSymbolReferenceThe text symbol used for the diagram title, which appears above the element.
bearingArrowLineSymbolCIMSymbolReferenceThe line symbol used for the arrow that leads from the starting bearing to the ending bearing for a part of the diagram.
lineSymbolCIMSymbolReferenceThe line symbol used for the outline of the circle sections on the diagram.
diameterUnitsLinearUnitThe page units used to determine the diameter of the cruising altitude diagram.
diagramDiameterdoubleThe diameter of the cruising altitude diagram in page units.
diagramTitlestringThe text for the diagram title.
verticalLeftTextstringThe text for the left side of the vertical diagram.
verticalRightTextstringThe text for the right side of the vertical diagram.
horizontalTopTextstringThe text for the top of the horizontal diagram.
horizontalBottomTextstringThe text for the bottom of the horizontal diagram.
quadrantalTopLeftTextstringThe text for the top left of the quadrantal diagram.
quadrantalTopRightTextstringThe text for the top right of the quadrantal diagram.
quadrantalBottomLeftTextstringThe text for the bottom left of the quadrantal diagram.
quadrantalBottomRightTextstringThe text for the bottom right of the quadrantal diagram.
autoResizeTextbooleanA value indicating whether to auto resize the text.

Enumeration: CruisingAltitudeDiagramType

A list of Cruising Altitude Diagram types.

PropertyValueDescription
Vertical1Vertical.
Horizontal2Horizontal.
Quadrantal3Quadrantal.

CIMCustomGrid

Represents a custom grid of the mapFrame.

CIMMapGrid

PropertyTypeDescription
namestringThe name of the Grid or Graticule.
isVisiblebooleanA value indicating whether the grid or graticule is visible.
neatlineSymbolCIMSymbolReferenceThe neat line symbol of the Grid or Graticule.
maxInteriorAngledoubleThe maximum value of the interior angle that determines the edge of the mapFrame polygon. The angle is defined in degrees.
edgeMinimumLengthdoubleThe minimum length of the edge of the mapFrame polygon in page units.
mapGridEdges[CIMMapGridEdge]The map grid edges.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMCustomGrid

PropertyTypeDescription
layerURIstringThe path to the layer used to define the grid lines.
gridLines[CIMGridLine]The gridLines of the custom grid. These are limited to ticks, labels, and tabs.
useMapClipShapebooleanA value indicating whether to use the clip shape of the map (if set) as the grid boundary.

CIMCustomGridLabelTemplate

Defines the label template for custom grids.

CIMGridLabelTemplate

PropertyTypeDescription

CIMCustomGridLabelTemplate

PropertyTypeDescription
labelExpressionInfoCIMExpressionInfoThe label expression. Either a simple field name or an Arcade expression.
edgeLabelAngles[double]The list of label angles to set the text symbol angle for each grid edge.
symbolCIMSymbolReferenceThe symbol of the label.

CIMDeclination

Represents the properties of a declination calculated using World Magnetic Model.

CIMDeclination

PropertyTypeDescription
directionenumeration DeclinationDirectionThe direction the declination is reckoned from.
degreeslongThe degrees of declination.
minuteslongThe minutes of declination.
milsdoubleThe mil radians of declination.

Enumeration: DeclinationDirection

Defines which direction declination will be calculated from.

PropertyValueDescription
West0Declination reckoned West (counterclockwise)
East1Declination reckoned East (clockwise)

CIMDoubleFillScaleBar

Represents a double filled alternating scale bar.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMScaleBar

PropertyTypeDescription
alignToZeroPointbooleanA value indicating whether the scale bar should align to zero.
barHeightdoubleThe scale bar height.
divisiondoubleThe division value.
divisionslongThe number of divisions.
divisionsBeforeZerolongThe number of divisions before zero.
fittingStrategyenumeration ScaleBarFittingStrategyThe fitting strategy.
labelFrequencyenumeration ScaleBarFrequencyThe label frequency.
labelGapdoubleThe label gap value.
labelPositionenumeration ScaleBarVerticalPositionThe label position.
labelSymbolCIMSymbolReferenceLabel symbol.
numberFormatNumberFormatThe number format.
subdivisionslongThe number of subdivisions.
unitLabelstringThe unit label.
unitLabelGapdoubleThe unit label gap. Units set in points.
unitLabelPositionenumeration ScaleBarLabelPositionThe unit label position.
unitLabelSymbolCIMSymbolReferenceThe unit label symbol.
unitsUnitThe units for the scale bar.
useFractionCharactersbooleanA value indicating whether fractional characters should be used.
zeroPointPointThe zero location for the scale bar.
computeAtCenterbooleanA value indicating whether to compute the scale at map center.
displayFirstOutsidebooleanA value indicating whether to display the first numeric value outside the bar.
displayLastOutsidebooleanA value indicating whether to display the last numeric value outside the bar.
barWidthdoubleThe width of the scale bar.

CIMScaleMarks

PropertyTypeDescription
divisionMarkHeightdoubleThe division mark height value.
divisionMarkSymbolCIMSymbolReferenceThe division mark line symbol.
markFrequencyenumeration ScaleBarFrequencyThe division mark frequency.
markPositionenumeration ScaleBarVerticalPositionThe division mark position.
subdivisionMarkHeightdoubleThe subdivision mark height.
subdivisionMarkSymbolCIMSymbolReferenceThe subdivision mark line symbol.
midpointMarkHeightdoubleThe midpoint mark height.
midpointMarkSymbolCIMSymbolReferenceThe midpoint mark line symbol.

CIMDoubleFillScaleBar

PropertyTypeDescription
fillSymbol1CIMSymbolReferenceThe first symbol of an alternating scale bar.
fillSymbol2CIMSymbolReferenceThe second symbol of an alternating scale bar.
styleenumeration DoubleFillScaleBarStyleThe style for the scale bar.

Enumeration: DoubleFillScaleBarStyle

A list of the styles available for a double file scale bar.

PropertyValueDescription
Hollow0Hollow fill.
Alternating1Alternating fill.
DoubleAlternating2Double alternating fill.

CIMDualScaleBar

Represents a dual scale bar on a page layout.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMScaleBar

PropertyTypeDescription
alignToZeroPointbooleanA value indicating whether the scale bar should align to zero.
barHeightdoubleThe scale bar height.
divisiondoubleThe division value.
divisionslongThe number of divisions.
divisionsBeforeZerolongThe number of divisions before zero.
fittingStrategyenumeration ScaleBarFittingStrategyThe fitting strategy.
labelFrequencyenumeration ScaleBarFrequencyThe label frequency.
labelGapdoubleThe label gap value.
labelPositionenumeration ScaleBarVerticalPositionThe label position.
labelSymbolCIMSymbolReferenceLabel symbol.
numberFormatNumberFormatThe number format.
subdivisionslongThe number of subdivisions.
unitLabelstringThe unit label.
unitLabelGapdoubleThe unit label gap. Units set in points.
unitLabelPositionenumeration ScaleBarLabelPositionThe unit label position.
unitLabelSymbolCIMSymbolReferenceThe unit label symbol.
unitsUnitThe units for the scale bar.
useFractionCharactersbooleanA value indicating whether fractional characters should be used.
zeroPointPointThe zero location for the scale bar.
computeAtCenterbooleanA value indicating whether to compute the scale at map center.
displayFirstOutsidebooleanA value indicating whether to display the first numeric value outside the bar.
displayLastOutsidebooleanA value indicating whether to display the last numeric value outside the bar.
barWidthdoubleThe width of the scale bar.

CIMScaleMarks

PropertyTypeDescription
divisionMarkHeightdoubleThe division mark height value.
divisionMarkSymbolCIMSymbolReferenceThe division mark line symbol.
markFrequencyenumeration ScaleBarFrequencyThe division mark frequency.
markPositionenumeration ScaleBarVerticalPositionThe division mark position.
subdivisionMarkHeightdoubleThe subdivision mark height.
subdivisionMarkSymbolCIMSymbolReferenceThe subdivision mark line symbol.
midpointMarkHeightdoubleThe midpoint mark height.
midpointMarkSymbolCIMSymbolReferenceThe midpoint mark line symbol.

CIMDualScaleBar

PropertyTypeDescription
upperScaleBarScaleBarThe upper scale bar of the dual scale bar.
lowerScaleBarScaleBarThe lower scale bar of the dual scale bar.
unitLabelVerticalGapdoubleThe unit label vertical gap. Units set in points.

Enumeration: EndPointPosition

Enumerates which end a component is visible.

PropertyValueDescription
None0No end point is selected
FromPoint1From point.
ToPoint2To point.

Enumeration: EndPointSelection

Represents the selection of endPoints.

PropertyValueDescription
First1Display the first label along each grid edge.
Interior2Display the interior labels along each grid edge.
FirstAndInterior3Display the first label and the interior labels along each grid edge.
Last4Display the last label along each grid edge.
FirstAndLast5Display the first and last label along each grid edge.
InteriorAndLast6Display the interior labels and the last label along each grid edge.
All7Display all the labels along each grid edge.

Enumeration: ExtentFitType

Extent fit types.

PropertyValueDescription
BestFit0Best fit.
ExtentCenter1Center the extent.
DataDriven2Data driven.

CIMExtentIndicator

Represents an extent indicator which is used to display the visible extent of other map frames in an associated map frame.

CIMExtentIndicator

PropertyTypeDescription
sourceMapFramestringThe source map frame's extent to be displayed.
symbolCIMSymbolReferenceThe area symbol used to represent the extent indicator.
leaderTypeenumeration LeaderTypeThe leader style used to connect the associated extents.
leaderSymbolCIMSymbolReferenceThe leader symbol used to connect the associated extents.
collapseSizedoubleThe minimum size of the extent indicator before symbolizing it as a point. Units in points.
pointSymbolCIMSymbolReferenceThe point symbol used to symbolize an extent indicator.
namestringThe name of the extent indicator.
isVisiblebooleanA value indicating whether the extent indicator is visible.
avoidLabelConflictbooleanA value indicating whether to avoid label conflict. Reserved for future implementation.
symbolizeExteriorbooleanA value indicating whether the area symbol should be applied outside the extent.
extentIndicatorTypeenumeration ExtentIndicatorTypeThe extent indicator type. Reserved for future implementation at this time.

Enumeration: ExtentIndicatorType

Future implementation.

PropertyValueDescription
Frame0Future implementation
Rectangle1Future implementation
IndexFeatureFromDDP2Future implementation

CIMExteriorTick

Class that represents an exterior tick for a grid.

CIMTick

PropertyTypeDescription
lengthdoubleThe length of the tick in page units.
offsetdoubleThe offset of the tick in page units.
isVisiblebooleanA value indicating whether the tick is visible.
symbolCIMSymbolReferenceThe symbol for the tick.
gridEndpointCIMGridEndpointThe end point for the tick.

CIMExteriorTick

PropertyTypeDescription
edgeAffinity[long]The collection of edges the ticks or the labels draw on. If the collection is empty, the drawing is made on the entire area of interest.
drawPerpendicularbooleanA value indicating whether to the draw the ticks perpendicular to the map grid edges.

Enumeration: FieldSortInfo

Represents the sort information for a field.

PropertyValueDescription
None0Field is not sorted.
Asc1The field is sorted by case insensitive ascending order.
AscCase2The field is sorted by case sensitive ascending order.
Desc4The field is sorted by case insensitive descending order.
DescCase8The field is sorted by case sensitive descending order.

Enumeration: FieldStatisticsFlag

Represents field statistics.

PropertyValueDescription
NoStatistics0No statistics calculated.
Count1The count of all field values.
Minimum2The maximum field value.
Maximum4The minimum field value.
Range8The difference between the maximum and minimum field values.
Sum16The sum of all field values.
Mean32The average of all field values.
Median64The middle value of all field values.
Mode128The most common value of all field values.
StandardDeviation256The standard deviation of the field values.

CIMGZDLabelGridLine

Represents a UTM Grid Zone Designator Label definition for a MapGrid.

CIMGridLine

PropertyTypeDescription
namestringName of the grid line.
elementTypeenumeration GridElementTypeThe type of the graticule element.
gridLineOrientationenumeration GridLineOrientationThe orientation of the gridLine with reference to the coordinate system of the spatial reference. For graticules it is latitudes and longitudes. For grids it is eastings and northings.
symbolCIMSymbolReferenceSymbol of the grid line.
patternCIMGridPatternThe pattern of the grid lines.
fromTickCIMExteriorTickThe properties of the tick that is at the start of the grid line it represents.
toTickCIMExteriorTickThe properties of the tick that is at the end of the grid line it represents.
interiorTicks[CIMInteriorTick]The properties of the interior ticks for a grid line.
visibleIndices[long]The visibility of the corner labels to edges by index.

CIMGZDLabelGridLine

PropertyTypeDescription
dynamicStringTemplatestringThe dynamic string used to represent the GZD label of the map grid.
verticalTopPositionCIMGridZoneLabelPositionThe vertical position of the GZD label at the top of each UTM grid zone.
verticalCenterPositionCIMGridZoneLabelPositionThe vertical position of the GZD label at the center of each UTM grid zone.
verticalBottomPositionCIMGridZoneLabelPositionThe vertical position of the GZD label at the bottom of each UTM grid zone.
horizontalLeftPositionCIMGridZoneLabelPositionThe horizontal position of the GZD label at the left of each UTM grid zone.
horizontalCenterPositionCIMGridZoneLabelPositionThe horizontal position of the GZD label at the center of each UTM grid zone.
horizontalRightPositionCIMGridZoneLabelPositionThe horizontal position of the GZD label at the right of each UTM grid zone.

CIMGlossaryTable

Represents a glossary table for map product surround elements.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMMapProductSurround

PropertyTypeDescription
autoUpdatebooleanA value indicating whether properties of the surround should update automatically based on changes in the map.
productSpecificationenumeration MapProductSpecTypeThe map product specification type of the surround.
drawToSpecificationbooleanA value indicating whether to draw the element to specification size or allow user to manually resize element.

CIMGlossaryTable

PropertyTypeDescription
fittingStrategyenumeration TableFrameFittingStrategyThe fitting strategy.
mapMemberURIstringThe URI to a Layer or Standalone table in the project.
fields[CIMTableFrameField]The fields displayed in the glossary table.
titlestringThe title of the element.
titleTextSymbolCIMSymbolReferenceThe text symbol for title text.
rightToLeftbooleanA value indicating whether right to left orientation should be applied.
minFontSizedoubleThe limit when reducing font sizes. Values are in points.
titleGapdoubleThe gap between title and column headings. Values are in points.
headingGapdoubleThe gap between column headings and rows. Values are in points.
rowGapdoubleThe gap between rows. Values are in points.
horizontalTextGapdoubleThe horizontal gap around field values. Values are in points.
verticalTextGapdoubleThe vertical gap around field values. Values are in points.
delimiterCharacterstringThe delimiter character that is displayed between columns.
delimiterTextSymbolCIMSymbolReferenceThe text symbol for the delimiter displayed between columns.

CIMGraphicElement

Represents the CIM representation of an element on a page layout.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMGraphicElement

PropertyTypeDescription
graphicGraphicThe CIMGraphic for an element on a page layout.

CIMGraticule

Represents a graticule for a map frame.

CIMMapGrid

PropertyTypeDescription
namestringThe name of the Grid or Graticule.
isVisiblebooleanA value indicating whether the grid or graticule is visible.
neatlineSymbolCIMSymbolReferenceThe neat line symbol of the Grid or Graticule.
maxInteriorAngledoubleThe maximum value of the interior angle that determines the edge of the mapFrame polygon. The angle is defined in degrees.
edgeMinimumLengthdoubleThe minimum length of the edge of the mapFrame polygon in page units.
mapGridEdges[CIMMapGridEdge]The map grid edges.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMGraticule

PropertyTypeDescription
customOriginPointThe custom origin of a graticule.
geographicCoordinateSystemGeographicCoordinateSystemThe spatial reference of a graticule.
gridLines[CIMGridLine]The collection of latitudes and longitudes for a graticule.
isAutoScaledbooleanA value indicating whether to automatically adjust the interval of the graticules based on scale of the map.
useMapClipShapebooleanA value indicating whether to use the clip shape of the map (if set) as the grid boundary.

Enumeration: GridElementType

The type of component of the grid.

PropertyValueDescription
Line0Represents lines.
Tick1Represents ticks.
Label2Represents labels.
Corner3Represents the corner label.
IntersectionPoint4Represents a grid component used to show intersection points on a map grid.

CIMGridEndpoint

Represents an end point of a component. For ex: The labels for ticks are defined using an endPoint object.

CIMGridEndpoint

PropertyTypeDescription
gridLabelTemplateGridLabelTemplateThe grid label template for each endpoint.
offsetdoubleThe offset of the labels.
positionlongThe position of the labels of the end points.
lineSelectionlongThe end point selection.
drawLabelsParallelbooleanA value indicating whether to draw the labels parallel to the map grid edges.
edgeVisibilityFilterenumeration EndPointSelectionA value indicating which labels to draw along the map grid edges.

Enumeration: GridLadderLabelPosition

Represents the position at which the ladder labels are drawn.

PropertyValueDescription
Half0Represents the ladder label at half the value of visible extent.
Third1Represents the ladder label at third of the value of visible extent.
Quarter2Represents the ladder label at quarter the value of visible extent.

CIMGridLine

Represents latitudes or longitudes for a graticule. Represents eastings or nothings for a grid.

CIMGridLine

PropertyTypeDescription
namestringName of the grid line.
elementTypeenumeration GridElementTypeThe type of the graticule element.
gridLineOrientationenumeration GridLineOrientationThe orientation of the gridLine with reference to the coordinate system of the spatial reference. For graticules it is latitudes and longitudes. For grids it is eastings and northings.
symbolCIMSymbolReferenceSymbol of the grid line.
patternCIMGridPatternThe pattern of the grid lines.
fromTickCIMExteriorTickThe properties of the tick that is at the start of the grid line it represents.
toTickCIMExteriorTickThe properties of the tick that is at the end of the grid line it represents.
interiorTicks[CIMInteriorTick]The properties of the interior ticks for a grid line.
visibleIndices[long]The visibility of the corner labels to edges by index.

Enumeration: GridLineOrientation

Represents the orientation of the grid line.

PropertyValueDescription
NorthSouth0North-South
EastWest1East-West

CIMGridPattern

Defines pattern for a component.

CIMGridPattern

PropertyTypeDescription
intervaldoubleThe interval of the component the pattern represents.
startdoubleThe start pattern of the component.
stopdoubleThe stop pattern of the component.
gapdoubleThe gap pattern of the component.

Enumeration: GridReferencePrecisionLevel

List of precision levels for Military Grid Reference System (MGRS).

PropertyValueDescription
GridZoneDesignator0Grid zone designator.
PrecisionLevel100km1Precision level 100 km.
PrecisionLevel10km2Precision level 10 km.
PrecisionLevel1km3Precision level 1 km.
PrecisionLevel100m4Precision level 100 m.
PrecisionLevel10m5Precision level 10 m.
PrecisionLevel1m6Precision level 1 m.
ICM7Custom MGRS precision for Image City Map(ICM).

CIMGridZoneLabelPosition

Represents the state of a label at a given position on a MapGrid.

CIMGridZoneLabelPosition

PropertyTypeDescription
visiblebooleanA value indicating whether the label at this position is visible.
offsetXdoubleThe offset in the X-Coordinate direction between the label and grid components.
offsetYdoubleThe offset in the Y-Coordinate direction between the label and grid components.

CIMGroupElement

Represents a collection of layout elements in a group element.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMGroupFooter

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMGroupFooter

PropertyTypeDescription
fieldstringThe grouping field for the section.
alignSubsectionToBottombooleanA value indicating whether to force the subsection to export at the bottom of the page.

CIMGroupHeader

Represents a group header section in a report.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMGroupHeader

PropertyTypeDescription
fieldstringThe grouping field for the section.
repeatOnEveryPagebooleanA value indicating whether the section should be displayed on every page.

CIMGuide

Represents a guide used to snap elements on a page layout.

CIMGuide

PropertyTypeDescription
positiondoubleThe position of the guide.
orientationenumeration OrientationThe horizontal or vertical orientation of the guide.

CIMHorizontalBarLegendItem

Represents a horizontal bar legend item.

CIMLegendItem

PropertyTypeDescription
namestringThe legend item name.
newColumnbooleanA value indicating whether a legend item should be placed in a new column.
layerNameSymbolCIMSymbolReferenceThe legend item symbol.
manualColumnlongThe manual column assignment for a legend item.
keepTogetherOptionenumeration LegendKeepTogetherOptionA value indicating whether the legend item or group should be kept together.
showLayerNamebooleanA value indicating whether the legend item layer name should be displayed.
showHeadingbooleanA value indicating whether the legend item heading should be displayed.
headingSymbolCIMSymbolReferenceThe legend item heading symbol.
showLabelsbooleanA value indicating whether the legend item labels should be displayed.
layerstringThe legend item layer's path.
showDescriptionbooleanA value indicating whether a legend item description should be displayed.
labelSymbolCIMSymbolReferenceThe legend item label symbol.
descriptionSymbolCIMSymbolReferenceThe legend item description symbol.
patchWidthdoubleThe legend item patch width. Units in points.
patchHeightdoubleThe legend item patch height. Units in points.
autoVisibilitybooleanA value indicating whether the legend item should be displayed if in the visible extent.
useMapSeriesShapebooleanA value indicating whether to use map series shape instead of map frame to find dynamic classes.
classIndentdoubleDistance from the class name to the edge of the legend.
headingIndentdoubleDistance from the heading to the edge of the legend.
layerNameIndentdoubleDistance of the layer name to the edge of the legend.
showGroupLayerNamebooleanA value indicating whether to show the containing group layer name above the item.
groupLayerNameSymbolCIMSymbolReferenceThe symbol used to display the group layer name.
scaleToPatchbooleanA value indicating whether to scale the symbol to the specified patch size.
showCountsbooleanA value indicating whether the legend should display count statistics.
countFormatNumberFormatThe feature count format.
countPrefixstringThe feature count prefix.
countSuffixstringThe feature count suffix.
isVisiblebooleanA value indicating whether the legend item is visible.
groupFilter[long]A value specifying which legend groups are displayed.

CIMLegendItemArrangement

PropertyTypeDescription
arrangementenumeration LegendItemArrangementThe Arrangement.

CIMHorizontalBarLegendItem

PropertyTypeDescription
angleAbovedoubleThe angle above. Reserved for future implementation.
angleBelowdoubleThe angle below. Reserved for future implementation.
patchAlignmentenumeration VerticalAlignmentA value that allows alignment of graduated symbols to be specified.

CIMLegendItemLeader

PropertyTypeDescription
lineSymbolCIMSymbolReferenceThe line symbol for a legend item leader.
lineLengthdoubleThe line length for a legend item leader.

CIMHorizontalLegendItem

Represents a horizontal legend item.

CIMLegendItem

PropertyTypeDescription
namestringThe legend item name.
newColumnbooleanA value indicating whether a legend item should be placed in a new column.
layerNameSymbolCIMSymbolReferenceThe legend item symbol.
manualColumnlongThe manual column assignment for a legend item.
keepTogetherOptionenumeration LegendKeepTogetherOptionA value indicating whether the legend item or group should be kept together.
showLayerNamebooleanA value indicating whether the legend item layer name should be displayed.
showHeadingbooleanA value indicating whether the legend item heading should be displayed.
headingSymbolCIMSymbolReferenceThe legend item heading symbol.
showLabelsbooleanA value indicating whether the legend item labels should be displayed.
layerstringThe legend item layer's path.
showDescriptionbooleanA value indicating whether a legend item description should be displayed.
labelSymbolCIMSymbolReferenceThe legend item label symbol.
descriptionSymbolCIMSymbolReferenceThe legend item description symbol.
patchWidthdoubleThe legend item patch width. Units in points.
patchHeightdoubleThe legend item patch height. Units in points.
autoVisibilitybooleanA value indicating whether the legend item should be displayed if in the visible extent.
useMapSeriesShapebooleanA value indicating whether to use map series shape instead of map frame to find dynamic classes.
classIndentdoubleDistance from the class name to the edge of the legend.
headingIndentdoubleDistance from the heading to the edge of the legend.
layerNameIndentdoubleDistance of the layer name to the edge of the legend.
showGroupLayerNamebooleanA value indicating whether to show the containing group layer name above the item.
groupLayerNameSymbolCIMSymbolReferenceThe symbol used to display the group layer name.
scaleToPatchbooleanA value indicating whether to scale the symbol to the specified patch size.
showCountsbooleanA value indicating whether the legend should display count statistics.
countFormatNumberFormatThe feature count format.
countPrefixstringThe feature count prefix.
countSuffixstringThe feature count suffix.
isVisiblebooleanA value indicating whether the legend item is visible.
groupFilter[long]A value specifying which legend groups are displayed.

CIMLegendItemArrangement

PropertyTypeDescription
arrangementenumeration LegendItemArrangementThe Arrangement.

CIMHorizontalLegendItem

PropertyTypeDescription

CIMInteriorTick

Class that represents an interior tick for a grid.

CIMTick

PropertyTypeDescription
lengthdoubleThe length of the tick in page units.
offsetdoubleThe offset of the tick in page units.
isVisiblebooleanA value indicating whether the tick is visible.
symbolCIMSymbolReferenceThe symbol for the tick.
gridEndpointCIMGridEndpointThe end point for the tick.

CIMInteriorTick

PropertyTypeDescription
patternCIMGridPatternThe pattern for the interior ticks.
indicateDirectionbooleanA value indicating whether the ticks show the direction away from the origin. If false, the ticks bisect the center of the grid line.

CIMLadderGridLine

Represents internal labels for a MapGrid.

CIMGridLine

PropertyTypeDescription
namestringName of the grid line.
elementTypeenumeration GridElementTypeThe type of the graticule element.
gridLineOrientationenumeration GridLineOrientationThe orientation of the gridLine with reference to the coordinate system of the spatial reference. For graticules it is latitudes and longitudes. For grids it is eastings and northings.
symbolCIMSymbolReferenceSymbol of the grid line.
patternCIMGridPatternThe pattern of the grid lines.
fromTickCIMExteriorTickThe properties of the tick that is at the start of the grid line it represents.
toTickCIMExteriorTickThe properties of the tick that is at the end of the grid line it represents.
interiorTicks[CIMInteriorTick]The properties of the interior ticks for a grid line.
visibleIndices[long]The visibility of the corner labels to edges by index.

CIMLadderGridLine

PropertyTypeDescription
dynamicStringTemplatestringThe dynamic string used to represent the ladder label of the map grid.
gapXdoubleThe gap in the X-Coordinate direction between the label extent and grid components.
gapYdoubleThe gap in the Y-Coordinate direction between the label extent and grid components.
positionenumeration GridLadderLabelPositionThe position of the ladder labels.

CIMLayerOverrideSet

Represents a layer property override set.

CIMLayerOverrideSet

PropertyTypeDescription
layerURIstringThe path to the associated map layer.
valuebooleanA value indicating whether this flag is set. It overrides some arbitrary property on the associated map layer.

CIMLayout

Represents a layout in a project. A layout is a collection of visual elements arranged on a logical sheet of paper. A layout in a GIS is typically used to display one or more maps at a particular extent and scale. The layout is used to compose a presentation of data, describe the maps, and/or tell a story of the map data. A layout defines a logical sheet of paper. It has a height and a width, and also a linear unit used to display positions on the page. It can have a snapping grid and a set of guides to help users arrange its elements. The layout contains an ordered list of elements. When the layout draws, it tells each element to draw, in order.

CIMDefinition

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

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMLayoutDefinition

PropertyTypeDescription
pageCIMPageThe CIMPage for the layout.
dateExportedTimeInstantThe date exported property for a layout.
datePrintedTimeInstantThe date printed property for a layout.
mapSeriesMapSeriesThe map series for a layout.
colorModelenumeration ColorModelThe color model for a layout.
RGBColorProfilestringThe name of the RGB color profile for a layout.
CMYKColorProfilestringThe name of the CMYK color profile for a layout.
simulateOverprintbooleanA value indicating whether to simulate overprint for a layout.
customProperties[CIMStringMap]The custom properties of the layout. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
defaultColorVisionDeficiencyModeenumeration ColorVisionDeficiencyTypeThe color vision deficiency mode that new views of this layout are opened with.

CIMLayoutView

Represents a layout view in the project.

CIMView

PropertyTypeDescription
viewableObjectPathstringThe path of the item in the view.
viewTypestringThe view type as a string.
instanceIDlongThe instance identifier of this view.

CIMLayoutView

PropertyTypeDescription
extentEnvelopeThe extent for the view.
defaultMapFrameNamestringThe default map for a view.
pauseDrawingbooleanA value indicating whether drawing is in the paused state for the view.
colorVisionDeficiencyModeenumeration ColorVisionDeficiencyTypeThe color vision deficiency mode of the view.

Enumeration: LeaderType

A list of leader types for extent indicators.

PropertyValueDescription
None0No leader line.
LineToNearestPoint1Shortest line
LineToMidpoint2Line to mid-point of the frame.
LineThroughCenters3Line from center to center of each extent.
CalloutToCenter4Callout to center.
CalloutToEdge5Callout to edge.
CalloutToEdges6Callout to edges.

CIMLegend

Represents a legend on a layout.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMLegend

PropertyTypeDescription
autoAddbooleanA value indicating whether items should automatically be added to the legend.
autoFontsbooleanA value indicating whether legend fonts should automatically be sized.
autoReorderbooleanA value indicating whether the items should automatically be ordered when added.
autoVisibilitybooleanA value indicating whether the items should display when not in the visible extent.
defaultPatchHeightdoubleAn items default patch height. Units in points.
defaultPatchWidthdoubleAn items default patch width. Units in points.
descriptionWidthdoubleThe description width threshold. Units in points.
groupGapdoubleThe gap between groups. Units in points.
headingGapdoubleThe heading gap. Units in points.
horizontalItemGapdoubleThe gap between horizontal items. Units in points.
patchGapdoubleThe gap between patches. Units in points.
items[CIMLegendItem]A collection of items in a layout.
labelWidthdoubleThe label width. Units in points.
minFontSizedoubleThe minimum font size. Units in points.
rightToLeftbooleanA value indicating whether right to left orientation should be applied.
scaleSymbolsbooleanA value indicating whether symbols should be scaled.
showTitlebooleanA value indicating whether the legend title should be displayed.
textGapdoubleThe gap between text. Units in points.
titlestringThe title for the legend.
titleGapdoubleThe title gap. Units in points.
titleSymbolCIMSymbolReferenceThe symbol for the title.
itemGapdoubleThe gap between items. Units in points,.
classGapdoubleThe gap between classes. Units in points.
layerNameGapdoubleThe layer name gap. Units in points.
featureCountPrefixstringThe feature count prefix. Deprecated in 1.4. Use count prefix in legend item instead.
featureCountSuffixstringThe feature count suffix. Deprecated in 1.4. Use count suffix in legend item instead.
fittingStrategyenumeration LegendFittingStrategyThe legends fitting strategy.
groupLayerNameGapdoubleThe gap following the group layer name.
columnslongThe number of legend columns when either of the following fitting strategies is in effect: SpecifyColumnsAndAdjustFrame or SpecifyColumnsAndAdjustSize.
makeColumnsSameWidthbooleanA value indicating whether to ensure all the columns are the same width.
defaultLegendItemLegendItemThe default legend item used as the basis for new legend item creation.
excludedLayers[string]A collection of layer URIs from the associated map that are explicitly excluded from the legend.
balanceColumnsbooleanA value indicating whether to balance the columns or simply "pour" the text into each column.

Enumeration: LegendFittingStrategy

A list of legend fitting strategies.

PropertyValueDescription
AdjustSize0Adjust the size of the text.
AdjustColumns1Adjust the number of columns within the frame.
AdjustColumnsAndSize2Adjust the number of columns and size of the text.
AdjustFrame3Adjust the size of the legend frame.
ManualColumns4Adjust the columns manually.

Enumeration: LegendItemArrangement

A list of legend item arrangement options.

PropertyValueDescription
PatchLabelDescription0Display patch, label, then description.
PatchDescriptionLabel1display patch, description, then label.
LabelPatchDescription2Display label, patch, then description.
LabelDescriptionPatch3Display label, description, then patch.
DescriptionPatchLabel4Display description, patch, then label.
DescriptionLabelPatch5Display description, label, then patch.

Enumeration: LegendKeepTogetherOption

A list of choices for keeping legend parts together.

PropertyValueDescription
None0Don't try to keep parts together.
Items1Keep legend items together.
Groups2Keep legend groups together.

CIMMGRSGridLine

Represents a gridLine to draw the 100,000 MGRS grids.

CIMGridLine

PropertyTypeDescription
namestringName of the grid line.
elementTypeenumeration GridElementTypeThe type of the graticule element.
gridLineOrientationenumeration GridLineOrientationThe orientation of the gridLine with reference to the coordinate system of the spatial reference. For graticules it is latitudes and longitudes. For grids it is eastings and northings.
symbolCIMSymbolReferenceSymbol of the grid line.
patternCIMGridPatternThe pattern of the grid lines.
fromTickCIMExteriorTickThe properties of the tick that is at the start of the grid line it represents.
toTickCIMExteriorTickThe properties of the tick that is at the end of the grid line it represents.
interiorTicks[CIMInteriorTick]The properties of the interior ticks for a grid line.
visibleIndices[long]The visibility of the corner labels to edges by index.

CIMMGRSGridLine

PropertyTypeDescription
XOffsetdoubleThe offset in the x-coordinate direction for the grid label.
YOffsetdoubleThe offset in the y-coordinate direction for the grid label.
labelPositionenumeration MGRSLabelPositionThe position of the label in the 100,000m grid square.

Enumeration: MGRSLabelPosition

Represents the position of the MGRS label in the 100,000m grid square.

PropertyValueDescription
Corner1Represents the corner position of the label in the 100,000m grid square.
Center2Represents the center position of the label in the 100,000m grid square.

CIMMapFrame

Represents a map frame on a page layout.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapFrame

PropertyTypeDescription
autoCameraCIMAutoCameraThe camera associated with the map frame.
URIstringThe path to the map in the project.
viewCIMMapViewThe view associated with the map frame.
extentIndicators[CIMExtentIndicator]The extent indicators associated with the map frame.
grids[CIMMapGrid]The Grids and Graticules associated with the MapFrame.
useMapBackgroundColorbooleanA value indicating whether the MapFrame should use the Map background color.
extentIndicatorsExpandedbooleanA value indicating whether the map frame extent indicators are expanded in the contents pane.
mapGridsExpandedbooleanA value indicating whether the map frame grids are expanded in the contents pane.
overrideLayerVisibilitybooleanA value indicating whether LayerVisibilityOverrides are used to override layer visibility.
layerVisibilityOverrides[CIMLayerOverrideSet]The array of layer visibility overrides.

CIMMapGridEdge

Represents a map grid edge.

CIMMapGridEdge

PropertyTypeDescription
partIndexlongThe part index of the map grid edge.
segmentIndices[long]The segment indices of the segments making up the edge.

CIMMapProductFeatureGuide

Represents the Guide to Numbered (GNF) surround element.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMBaseStreetIndex

PropertyTypeDescription
layerURIstringThe path to the layer containing the features to be indexed.
fields[CIMTableField]The fields displayed in the street index.
titleTextstringThe title of the element.
titleTextSymbolCIMSymbolReferenceThe text symbol for title text.
headerTextSymbolCIMSymbolReferenceThe text symbol for header text.
textSymbolCIMSymbolReferenceThe text symbol for the features.
fittingStrategyenumeration TableFrameFittingStrategyThe fitting strategy.
wrapMethodenumeration StreetIndexWrapMethodHow the data should wrap across multiple columns.
minFontSizedoubleThe minimum font size. Units in points.
headerGapdoubleThe spacing between headers and data.
groupTextSymbolCIMSymbolReferenceThe text symbol for a field that is grouped.
groupGapdoubleThe spacing between group and headers.
columnslongThe number of columns allowed to display.
indexDelimiterenumeration StreetIndexDelimiterThe delimiter that is displayed between columns.

CIMMapProductSurround

PropertyTypeDescription
autoUpdatebooleanA value indicating whether properties of the surround should update automatically based on changes in the map.
productSpecificationenumeration MapProductSpecTypeThe map product specification type of the surround.
drawToSpecificationbooleanA value indicating whether to draw the element to specification size or allow user to manually resize element.

CIMMapProductFeatureGuide

PropertyTypeDescription
gridReferenceCIMMapProductGridReferenceThe grid reference field name.
IDNumberFieldNamestringThe Identification Number field name.
categoryCodeFieldNamestringThe Category Code field name.

CIMMapProductGridReference

Represents how a grid reference (MGRS) should be displayed within CIMMapProductGridStreetIndex.

CIMMapProductGridReference

PropertyTypeDescription
gridReferenceFieldNamestringThe grid reference field name.
precisionLevelenumeration GridReferencePrecisionLevelGrid reference resolution.

CIMMapProductGridStreetIndex

Represents a street index that calculates the grid reference (MGRS) of each street in surround element.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMBaseStreetIndex

PropertyTypeDescription
layerURIstringThe path to the layer containing the features to be indexed.
fields[CIMTableField]The fields displayed in the street index.
titleTextstringThe title of the element.
titleTextSymbolCIMSymbolReferenceThe text symbol for title text.
headerTextSymbolCIMSymbolReferenceThe text symbol for header text.
textSymbolCIMSymbolReferenceThe text symbol for the features.
fittingStrategyenumeration TableFrameFittingStrategyThe fitting strategy.
wrapMethodenumeration StreetIndexWrapMethodHow the data should wrap across multiple columns.
minFontSizedoubleThe minimum font size. Units in points.
headerGapdoubleThe spacing between headers and data.
groupTextSymbolCIMSymbolReferenceThe text symbol for a field that is grouped.
groupGapdoubleThe spacing between group and headers.
columnslongThe number of columns allowed to display.
indexDelimiterenumeration StreetIndexDelimiterThe delimiter that is displayed between columns.

CIMMapProductSurround

PropertyTypeDescription
autoUpdatebooleanA value indicating whether properties of the surround should update automatically based on changes in the map.
productSpecificationenumeration MapProductSpecTypeThe map product specification type of the surround.
drawToSpecificationbooleanA value indicating whether to draw the element to specification size or allow user to manually resize element.

CIMMapProductGridStreetIndex

PropertyTypeDescription
gridReferenceCIMMapProductGridReferenceThe grid reference field name.

Enumeration: MapProductSpecType

Defines the layout types that meet different map product specifications.

PropertyValueDescription
Unset-1Unset product specification
TLM0Topographic Line Map, a.k.a. Topographic Map
ICM1Image City Map
JOG2Joint Operation Graphics
USTOPO3United States Topographic Maps
GNC4Global Navigation and Planning Chart
JNC5Jet Navigation Chart
ONC6Operational Navigation Chart
TPC7Tactical Pilotage Chart
EVC8Escape Evasion Chart

CIMMargin

Represents a margin to apply around the page.

CIMMargin

PropertyTypeDescription
leftdoubleThe left margin.
rightdoubleThe right margin.
topdoubleThe top margin.
bottomdoubleThe bottom margin.

CIMMarkerNorthArrow

Represents a marker north arrow on a page layout.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMNorthArrow

PropertyTypeDescription
referenceLocationPointThe reference location for a north arrow.
calibrationAngledoubleThe calibration angle for a north arrow.

CIMMarkerNorthArrow

PropertyTypeDescription
pointSymbolCIMSymbolReferenceThe point symbol for a north arrow.
northTypeenumeration NorthTypeThe type of north arrow.

CIMMeasuredGrid

Represents a measured grid of the mapFrame.

CIMMapGrid

PropertyTypeDescription
namestringThe name of the Grid or Graticule.
isVisiblebooleanA value indicating whether the grid or graticule is visible.
neatlineSymbolCIMSymbolReferenceThe neat line symbol of the Grid or Graticule.
maxInteriorAngledoubleThe maximum value of the interior angle that determines the edge of the mapFrame polygon. The angle is defined in degrees.
edgeMinimumLengthdoubleThe minimum length of the edge of the mapFrame polygon in page units.
mapGridEdges[CIMMapGridEdge]The map grid edges.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMMeasuredGrid

PropertyTypeDescription
customOriginPointThe custom origin of the measured grid.
projectedCoordinateSystemProjectedCoordinateSystemThe projected coordinate system of the grid.
gridLines[CIMGridLine]The gridLines of the measured grid.
isAutoScaledbooleanA value indicating whether to auto-scale the grid.
clipUTMZonebooleanA value indicating whether to clip the grid to the UTM zone. If the measured grid is not defined in one of the UTM coordinates, then this property is irrelevant.
useMapClipShapebooleanA value indicating whether to use the clip shape of the map (if set) as the grid boundary.

CIMMeterReferenceGuide

Provides a set of instructions and examples that enable users to compose standard grid reference.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMMapProductSurround

PropertyTypeDescription
autoUpdatebooleanA value indicating whether properties of the surround should update automatically based on changes in the map.
productSpecificationenumeration MapProductSpecTypeThe map product specification type of the surround.
drawToSpecificationbooleanA value indicating whether to draw the element to specification size or allow user to manually resize element.

CIMMeterReferenceGuide

PropertyTypeDescription
gridSquareTypeenumeration MeterReferenceSquareTypeThe type of the 100,000-Square identification area.
isSingleGridZonebooleanA value indicating whether the grid zone is using single (true) or multiple (false) designators.
propertiesCIMMeterReferencePropertiesThe display properties of the meter reference guide.
textSymbolCIMSymbolReferenceThe symbol used for the text elements in the meter reference guide.
lineSymbolCIMSymbolReferenceThe symbol used for the grid lines in the meter reference guide.

CIMMeterReferenceProperties

Defines the display properties of the meter reference guide.

CIMMeterReferenceProperties

PropertyTypeDescription
gridSquareUpperLeftstringThe text displayed in the upper left corner of the square identification area.
gridSquareUpperRightstringThe text displayed in the upper right corner of the square identification area.
gridSquareLowerLeftstringThe text displayed in the lower left corner of the square identification area.
gridSquareLowerRightstringThe text displayed in the lower right corner of the square identification area.
gridSquareUpperLeftDualstringThe auxiliary text displayed in the upper left corner of the square identification area.
gridSquareUpperRightDualstringThe auxiliary text displayed in the upper left corner of the square identification area.
gridSquareLowerLeftDualstringThe auxiliary text displayed in the lower left corner of the square identification area.
gridSquareLowerRightDualstringThe auxiliary text displayed in the lower right corner of the square identification area.
gridSquareVerticalSeparatorlongThe vertical separator value of the square identification area.
gridSquareHorizontalSeparatorlongThe horizontal separator value of the square identification area.
gridSquareHorizontalSeparatorDuallongThe horizontal auxiliary separator value of the square identification area.
gridZoneUpperLeftstringThe text displayed in the upper left corner of the grid zone designation area.
gridZoneUpperRightstringThe text displayed in the upper right corner of the grid zone designation area.
gridZoneLowerLeftstringThe text displayed in the lower left corner of the grid zone designation area.
gridZoneLowerRightstringThe text displayed in the lower right corner of the grid zone designation area.
gridZoneLatitudelongThe latitude of the grid zone.
gridZoneLongitudelongThe longitude of the grid zone.

Enumeration: MeterReferenceSquareType

Defines options for 100,000-Square identification area.

PropertyValueDescription
Single0Single location identifier
Multiple1Multiple location identifiers for additional information
DualGrid2Enables location identifiers across multiple UTM zones.

CIMNestedLegendItem

Represents a nested legend item in a legend.

CIMLegendItem

PropertyTypeDescription
namestringThe legend item name.
newColumnbooleanA value indicating whether a legend item should be placed in a new column.
layerNameSymbolCIMSymbolReferenceThe legend item symbol.
manualColumnlongThe manual column assignment for a legend item.
keepTogetherOptionenumeration LegendKeepTogetherOptionA value indicating whether the legend item or group should be kept together.
showLayerNamebooleanA value indicating whether the legend item layer name should be displayed.
showHeadingbooleanA value indicating whether the legend item heading should be displayed.
headingSymbolCIMSymbolReferenceThe legend item heading symbol.
showLabelsbooleanA value indicating whether the legend item labels should be displayed.
layerstringThe legend item layer's path.
showDescriptionbooleanA value indicating whether a legend item description should be displayed.
labelSymbolCIMSymbolReferenceThe legend item label symbol.
descriptionSymbolCIMSymbolReferenceThe legend item description symbol.
patchWidthdoubleThe legend item patch width. Units in points.
patchHeightdoubleThe legend item patch height. Units in points.
autoVisibilitybooleanA value indicating whether the legend item should be displayed if in the visible extent.
useMapSeriesShapebooleanA value indicating whether to use map series shape instead of map frame to find dynamic classes.
classIndentdoubleDistance from the class name to the edge of the legend.
headingIndentdoubleDistance from the heading to the edge of the legend.
layerNameIndentdoubleDistance of the layer name to the edge of the legend.
showGroupLayerNamebooleanA value indicating whether to show the containing group layer name above the item.
groupLayerNameSymbolCIMSymbolReferenceThe symbol used to display the group layer name.
scaleToPatchbooleanA value indicating whether to scale the symbol to the specified patch size.
showCountsbooleanA value indicating whether the legend should display count statistics.
countFormatNumberFormatThe feature count format.
countPrefixstringThe feature count prefix.
countSuffixstringThe feature count suffix.
isVisiblebooleanA value indicating whether the legend item is visible.
groupFilter[long]A value specifying which legend groups are displayed.

CIMLegendItemLeader

PropertyTypeDescription
lineSymbolCIMSymbolReferenceThe line symbol for a legend item leader.
lineLengthdoubleThe line length for a legend item leader.

CIMLegendItemArrangement

PropertyTypeDescription
arrangementenumeration LegendItemArrangementThe Arrangement.

CIMNestedLegendItem

PropertyTypeDescription
autoLayoutbooleanA value indicating whether to automatically layout the legend item.
labelEndsbooleanA value indicating whether the ends of a nested legend item should be labeled.
outlineSymbolCIMSymbolReferenceThe outline symbol for the nested legend item.
showOutlinesbooleanA value indicating whether outlines should be displayed for a nested legend item.
patchAlignmentenumeration HorizontalAlignmentThe patch alignment for a nested legend item.

Enumeration: NorthType

A list of north arrows types.

PropertyValueDescription
SimpleNorth0Simple north arrow.
TrueNorth1True north arrow.
GridNorth2Grid north arrow.
MagneticNorth3Magnetic north arrow.

Enumeration: Orientation

A list of orientation values.

PropertyValueDescription
Horizontal0Horizontal.
Vertical1Vertical.

CIMPage

Represents the page information associated with a layout.

CIMPage

PropertyTypeDescription
heightdoubleThe height of the layout in page units.
stretchElementsbooleanA value indicating whether elements should be stretched when the page size is changed.
widthdoubleThe width of the layout in page units.
printerPreferencesCIMPrinterPreferencesThe printer preferences for the page.
unitsLinearUnitThe page units for the layout.
guides[CIMGuide]The guides on a layout.
showRulersbooleanA value indicating whether rulers should be displayed on the layout.
showGuidesbooleanA value indicating whether guides should be displayed on the layout.
smallestRulerDivisiondoubleThe smallest ruler division.
marginCIMMarginThe margin for the page.
showMarginbooleanA value indicating whether the printer margin should be displayed on the layout.

Enumeration: PageOrientation

A list of page orientation values.

PropertyValueDescription
Portrait0Portrait orientation.
Landscape1Landscape orientation.

CIMPrinterPreferences

Represents the printer preferences associated with a layout.

CIMPrinterPreferences

PropertyTypeDescription
printerNamestringThe printer name.
paperNamestringThe paper size name.
paperSourcelongThe paper source.

CIMProfileFrame

Layout element used to draw Profile view of Runway, Terrain, obstacles and Obstruction Identification Surfaces (OIS).

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMProfileFrame

PropertyTypeDescription
heightOptionenumeration ProfileFrameHeightOptionThe option to control the height of profile.
heightdoubleThe height of the profile, used if the height option is set to ConstantHeight.
heightUnitsLinearUnitThe height units of the profile, used if the height option is set to ConstantHeight.
ratiodoubleThe ratio between width and height scale.
runwayDesignatorstringThe runway designator for which profile is created.
primaryOISDescriptionstringThe primary OIS surface for which profile is created.
secondaryOISDescriptionstringThe secondary OIS description for cases where different classifications were used for the ends of runway user can choose secondary classification.
primarySurfaceDescriptionstringThe primary surface description.
OISLayerURIstringThe URI of the layer of the OIS feature which defines the data for which profile is drawn.
gridCIMProfileGridThe display options for the grid.
terrainCIMProfileTerrainDisplay options for terrain.
runwayCIMProfileRunwayThe text symbol for runway elevation.
OISSurfaces[CIMProfileOIS]The display option for all the OIS surfaces shown in the profile.
obstacles[CIMProfileObstacle]The display option for all the point obstacles shown in the profile.
profileTypeenumeration ProfileFrameTypeThe option for profile type.
profileStyleenumeration ProfileFrameStyleThe style of the profile frame.
runwayEndLeftAsReferencebooleanA value indicating whether to use left end of runway as base elevation.

Enumeration: ProfileFrameHeightOption

Options for controlling the height of the profile element.

PropertyValueDescription
ConstantHeight0Adjust the cell height based on the overall height of element
ConstantRatio1Keeps a constant ratio between width to height of each cell

Enumeration: ProfileFrameStyle

Available styles for profile frames.

PropertyValueDescription
AOC0Aerodrome Obstacle Chart style.
PATC1Precision Approach Terrain Chart style.

Enumeration: ProfileFrameType

Options to specify if profile is displaying straight or curved approach.

PropertyValueDescription
Straight0Default option for straight approach profile
Curved1option for a curved approach profile

CIMProfileGrid

Grid shown for the profile.

CIMProfileGrid

PropertyTypeDescription
horizontalScaledoubleThe horizontal scale for the profile.
horizontalScaleUnitsLinearUnitThe horizontal scale units for the profile.
verticalScaledoubleThe vertical scale for the profile.
verticalScaleUnitsLinearUnitThe vertical scale units for the profile.
autoGridExtentbooleanA value indicating whether to calculate the start and stop of grid automatically If set to false user will set the minimum and maximum based on requirements.
YMindoubleThe vertical scale minimum value.
YMaxdoubleThe vertical scale maximum value.
subDivisionsXlongThe number of subdivisions in horizontal direction.
subDivisionsYlongThe number of divisions in vertical direction.
gridSymbolCIMSymbolReferenceThe line Symbol for the major grid lines.
subDivisionSymbolCIMSymbolReferenceThe line symbol for the subdivision.
horizontalScaleTextSymbolCIMSymbolReferenceThe text symbol for the horizontal scale.
verticalScaleLeftTextSymbolCIMSymbolReferenceThe text symbol for the vertical scale left.
verticalScaleRightTextSymbolCIMSymbolReferenceThe text symbol for the vertical scale right.
showEntireApproachbooleanA value indicating whether to show the entire length of curved approach, or just show up to a particular distance.
XMaxdoubleThe horizontal length maximum value.
verticalIntervalInMeterslongThe vertical interval for scale in meters.
verticalIntervalInFeetlongThe vertical interval for scale in feet.
showAbsoluteHorizontalScalebooleanA value indicating whether to display absolute or relative grid text automatically.
runwayObstacleDisplaybooleanA value indicating whether to display obstacle along the runway.

CIMProfileOIS

Defines the properties for OIS features.

CIMProfileOIS

PropertyTypeDescription
OISDescriptionstringThe description of OIS surface read only.
OISLabelstringThe label to be displayed for OIS.
showOISbooleanA value indicating whether to show OIS surface.
isPrimarybooleanA value indicating whether the surface is primary. If surface is primary it can't be hidden and terrain and obstacles will be drawn based on the primary surface.
displayOrderlongThe zero based index to control the display order.
OISSymbolCIMSymbolReferenceThe line Symbol used to draw the OIS Surface.
OISTextSymbolCIMSymbolReferenceThe text symbol used to draw the label of OIS Surface.

CIMProfileObstacle

Represents common properties for all the obstacles.

CIMProfileObstacle

PropertyTypeDescription
showPenetratingbooleanA value indicating whether to the obstacle only if it penetrates OIS Surface.
obstacleLayerNamestringThe name connecting display options to obstacle layers coming from Obstacle JSON (read only).
symbolSubstitutionTypeenumeration ProfileObstacleSymbolSubstitutionTypeThe type of substitution applied to the obstacle symbol.

Enumeration: ProfileObstacleGroundDisplayOption

Options for displaying the base of polygon/polyline obstacles.

PropertyValueDescription
Actual0Show the actual ground elevation of each vertex
Max1Show the maximum ground elevation for all the vertices
Min2Show the minimum ground elevation for all the vertices
Average3Show the average ground elevation for all the vertices

Enumeration: ProfileObstacleMarkerLocation

Marker display location options.

PropertyValueDescription
Surface0Show marker at the OIS surface
Top1Show marker at the top of obstacle
Base2Show marker at the base of obstacle

Enumeration: ProfileObstacleSymbolSubstitutionType

Types of symbol substitution used to display obstacles.

PropertyValueDescription
None0No substitute symbols used to display obstacles
Penetrating1Penetrating obstacles are displayed with substitute symbols
Protruding2Protruding portion of penetrating obstacles is displayed with substitute symbols

CIMProfilePointObstacle

Defines the properties for a Point obstacle.

CIMProfileObstacle

PropertyTypeDescription
showPenetratingbooleanA value indicating whether to the obstacle only if it penetrates OIS Surface.
obstacleLayerNamestringThe name connecting display options to obstacle layers coming from Obstacle JSON (read only).
symbolSubstitutionTypeenumeration ProfileObstacleSymbolSubstitutionTypeThe type of substitution applied to the obstacle symbol.

CIMProfilePointObstacle

PropertyTypeDescription
markerLocationenumeration ProfileObstacleMarkerLocationThe location of marker symbol for obstacle.
obstacleBaseSymbolCIMSymbolReferenceThe line symbol to connect from base of the grid to base of the obstacle.
obstacleHeightSymbolCIMSymbolReferenceThe line symbol to display the height of the obstacle (base to top of obstacle).
obstacleMarkerSymbolCIMSymbolReferenceThe point symbol displayed based in the marker location.
obstacleTextSymbolCIMSymbolReferenceThe text symbol to display the number of obstacle at the marker location.
showOnlyShadowingObstaclesbooleanA value indicating whether only shadowing obstacles are displayed.
substituteObstacleBaseSymbolCIMSymbolReferenceThe substitute base symbol.
substituteObstacleHeightSymbolCIMSymbolReferenceThe substitute height symbol.
substituteObstacleMarkerSymbolCIMSymbolReferenceThe substitute marker symbol.
substituteObstacleTextSymbolCIMSymbolReferenceThe substitute text symbol.

CIMProfilePolyObstacle

Represents a profile poly obstacle.

CIMProfileObstacle

PropertyTypeDescription
showPenetratingbooleanA value indicating whether to the obstacle only if it penetrates OIS Surface.
obstacleLayerNamestringThe name connecting display options to obstacle layers coming from Obstacle JSON (read only).
symbolSubstitutionTypeenumeration ProfileObstacleSymbolSubstitutionTypeThe type of substitution applied to the obstacle symbol.

CIMProfilePolyObstacle

PropertyTypeDescription
groundDisplayOptionenumeration ProfileObstacleGroundDisplayOptionThe option to display how the base of obstacle is shown.
obstacleSymbolCIMSymbolReferenceThe symbol used to draw the obstacle.
substituteObstacleSymbolCIMSymbolReferenceThe substitute obstacle symbol.

CIMProfileRunway

Display properties for Runway.

CIMProfileRunway

PropertyTypeDescription
precisionlongThe number of decimal places for runway elevation.
elevationChangeThresholddoubleThe percentage change between two elevation values when we can show the text symbol. Range is calculated by maximum and minimum elevation of the runway.
runwayLineSymbolCIMSymbolReferenceThe display symbol for runway.
runwayTextSymbolCIMSymbolReferenceThe text symbol for runway elevation.

CIMProfileTerrain

Display properties for Terrain.

CIMProfileTerrain

PropertyTypeDescription
showOutlinebooleanA value indicating whether to show only the outline of terrain.
maxTerrainCIMProfileTerrainDisplayThe display settings for maximum elevation of terrain.
minTerrainCIMProfileTerrainDisplayThe display settings for minimum elevation of terrain.
centerLineTerrainCIMProfileTerrainDisplayThe display settings for CenterLine elevation of terrain.

CIMProfileTerrainDisplay

Settings to control how the terrain information is being displayed in the profile.

CIMProfileTerrainDisplay

PropertyTypeDescription
displayOptionenumeration ProfileTerrainDisplayOptionThe display option for terrain.
terrainSymbolCIMSymbolReferenceThe display Symbol for the entire terrain or terrain below OIS surface.
penetratingTerrainSymbolCIMSymbolReferenceThe display Symbol for the penetrating terrain or terrain above OIS surface.

Enumeration: ProfileTerrainDisplayOption

Options to control how terrain data is displayed.

PropertyValueDescription
All0Show the entire terrain using single symbol
PenetratingOnly1Show only the terrain that is above the OIS surface
Highlight2Use two different symbols to display the terrain above and below the OIS surface
None3Terrain is not displayed

Enumeration: RectanglePosition

A list of rectangle position values.

PropertyValueDescription
TopSide0Top side.
BottomSide1Bottom side.
LeftSide2Left side.
RightSide3Right side.

CIMReferenceGrid

Defines a reference grid.

CIMMapGrid

PropertyTypeDescription
namestringThe name of the Grid or Graticule.
isVisiblebooleanA value indicating whether the grid or graticule is visible.
neatlineSymbolCIMSymbolReferenceThe neat line symbol of the Grid or Graticule.
maxInteriorAngledoubleThe maximum value of the interior angle that determines the edge of the mapFrame polygon. The angle is defined in degrees.
edgeMinimumLengthdoubleThe minimum length of the edge of the mapFrame polygon in page units.
mapGridEdges[CIMMapGridEdge]The map grid edges.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMReferenceGrid

PropertyTypeDescription
isAutoScaledbooleanA value indicating whether to auto-adjust the grid according to the size of the map frame.
rowCountlongThe number of rows for the reference grids.
columnCountlongThe number of columns for the reference grids.
gridLines[CIMGridLine]The collection of the grid lines.

CIMReferenceGridLabelTemplate

Defines the label template for the reference grids.

CIMGridLabelTemplate

PropertyTypeDescription

CIMReferenceGridLabelTemplate

PropertyTypeDescription
namestringThe name of the label scheme.
values[string]The list of values to label the grid.
delimiterstringThe delimiter for the list of labels.
symbolCIMSymbolReferenceThe symbol of the label.

CIMRelatedReportSection

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMRelatedReportSection

PropertyTypeDescription
dataSourceCIMReportDataSourceThe data source for a Related Report.
relateNamestringThe relate or relationship class name.
expressions[CIMExpressionInfo]The expressions used by the related report.

CIMReport

Represents a report in a project.

CIMDefinition

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

CIMLayoutDefinition

PropertyTypeDescription
pageCIMPageThe CIMPage for the layout.
dateExportedTimeInstantThe date exported property for a layout.
datePrintedTimeInstantThe date printed property for a layout.
mapSeriesMapSeriesThe map series for a layout.
colorModelenumeration ColorModelThe color model for a layout.
RGBColorProfilestringThe name of the RGB color profile for a layout.
CMYKColorProfilestringThe name of the CMYK color profile for a layout.
simulateOverprintbooleanA value indicating whether to simulate overprint for a layout.
customProperties[CIMStringMap]The custom properties of the layout. Custom properties are limited to key / value pairs of strings and developers are fully responsible for stored content.
defaultColorVisionDeficiencyModeenumeration ColorVisionDeficiencyTypeThe color vision deficiency mode that new views of this layout are opened with.

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReport

PropertyTypeDescription
heightdoubleThe Height of the report.
startPagelongThe starting page for the report.
watermarks[CIMReportWatermark]A collection of watermark for the report.

CIMReportDataSource

Represents the data source properties of a report. The data source can be a map member or external data.

CIMReportDataSource

PropertyTypeDescription
dataConnectionDataConnectionThe data connection to the source.
definitionQuerystringThe definition query.
fields[CIMReportField]The fields used by the report.
mapMemberURIstringThe URI to a Layer or Standalone table in the project.
useSelectionSetbooleanA value indicating whether the selection of the layer or table should be used for the report.

CIMReportDetails

Represents a details section of a report.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMReportDetails

PropertyTypeDescription
columnslongThe number of columns for the details section.
rowBackgroundColors[CIMColor]The collection of background colors for each of the repeating rows.
rowBackgroundCountlongThe number of consecutive rows for each background color.
keepRecordTogetherbooleanA value indicating whether to prevent a page break for a record in the Details subsection.
columnGapdoubleThe gap between data columns. Units in inches.
columnDirectionenumeration ColumnDirectionA value the direction records will be rendered in a column.

CIMReportDocument

Represents a report document which is the document type used for saving .rlfx files.

CIMVersion

PropertyTypeDescription
versionstringDocument version. Set by the system.
buildlongThe build an item was created with. Set by the system.

CIMReportDocument

PropertyTypeDescription
binaryReferences[CIMBinaryReference]The binary references of the document.
layerDefinitions[CIMDefinition]The layer definitions in the report document.
mapDefinitions[CIMDefinition]The map definitions of the report document.
reportDefinitionCIMReportThe report definition of the report document.
tableDefinitions[CIMDefinition]The table definitions of the report document.
layoutDefinitions[CIMDefinition]The layout definitions referenced by supplemental pages of the report document.
linkChartDefinitions[CIMDefinition]The link chart definitions of the report document.
timelineDefinitions[CIMDefinition]The timeline definitions of the report document.
videoDefinitions[CIMDefinition]The video definitions of the report document.
elevationSurfaceLayerDefinitions[CIMDefinition]The elevation surface layer definitions.

CIMReportElementFieldProperties

Represents field properties that will be applied to an element in a report.

CIMReportElementFieldProperties

PropertyTypeDescription
elementstringThe name of the target element.
fieldstringThe name of the source field.
formatNumberFormatThe format for the source field value.
statisticenumeration FieldStatisticsFlagThe statistic to apply to the source field.

CIMReportField

Represents a field in a report.

CIMTableField

PropertyTypeDescription
namestringThe field name and unique identifier.
isVisiblebooleanA value indicating whether the field is visible.
widthdoubleThe width of field. A value of 0 indicates "auto size".
sortInfoenumeration FieldSortInfoThe options when this field is used for sorting.
sortOrderlongThe zero based sort order. -1 indicates field isn't used for sorting.
fieldOrderlongThe zero based display order.
groupbooleanA value indicating whether this is a grouping field.
displayNamestringThe display name for the field.

CIMReportField

PropertyTypeDescription

CIMReportFooter

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMReportFooter

PropertyTypeDescription
alignSubsectionToBottombooleanA value indicating whether to force the subsection to export at the bottom of the page.

CIMReportHeader

Represents a report header section in a report.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMReportHeader

PropertyTypeDescription
coverPagebooleanA value indicating whether the report header is a cover page.

CIMReportLayoutPageSection

Represents a layout supplemental page section of a report.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMReportPageSection

PropertyTypeDescription
includePageNumberbooleanA value indicating whether to include page number elements.

CIMReportLayoutPageSection

PropertyTypeDescription
layoutURIstringThe layout URI.

CIMReportMapFrameElementProperties

Represents properties that will be applied to a map frame element in a report.

CIMReportElementFieldProperties

PropertyTypeDescription
elementstringThe name of the target element.
fieldstringThe name of the source field.
formatNumberFormatThe format for the source field value.
statisticenumeration FieldStatisticsFlagThe statistic to apply to the source field.

CIMReportMapFrameElementProperties

PropertyTypeDescription
spatialMapSeriesCIMSpatialMapSeriesThe spatial map series properties for a map frame element.
highlightFeaturesbooleanA value indicating whether to highlight features in a map frame element.

CIMReportPageFooter

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMReportPageFooter

PropertyTypeDescription

CIMReportPageHeader

Represents a page header section in a report.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMReportPageHeader

PropertyTypeDescription

CIMReportPageSection

Represents a supplemental page section of a report.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMReportPageSection

PropertyTypeDescription
includePageNumberbooleanA value indicating whether to include page number elements.

CIMReportSection

Gets or sets the data source for a report.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMReportSection

PropertyTypeDescription
dataSourceCIMReportDataSourceThe data source for a report.
expressions[CIMExpressionInfo]The expressions used by the report.

CIMReportSectionElement

Represents a section of elements in a report.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMGroupElement

PropertyTypeDescription

CIMElementContainer

PropertyTypeDescription
elements[CIMElement]A collection of elements.

CIMReportSectionElement

PropertyTypeDescription
autoSizebooleanA value indicating whether the section height will grow and shrink to fit the content of the section.
elementFieldProperties[CIMReportElementFieldProperties]The field properties that will be applied to the elements.
excludePageNumberPagesstringThe comma delimited list of pages to exclude the page number from.
excludeSectionPagesstringThe comma delimited list of pages to exclude the section from.
startOnNewPagebooleanA value indicating whether the section should start on a new page.
autoGrowTextElementsbooleanA value indicating whether the height of Text elements in sections will grow based on their content.
honorColumnsbooleanA value indicating whether the section should be displayed in columns.
keepSubsectionTogetherbooleanA value indicating whether to prevent a page break for a subsection. This property can be applied to the report footer, group header, and group footer subsections.

CIMReportWatermark

Represents a watermark in a report.

CIMReportWatermark

PropertyTypeDescription
elementElementThe element for the watermark.
excludePageNumbersstringThe comma delimited list of excluded page numbers.
isBackgroundbooleanA value indicating whether the overlay draws in the background of the report, else it draws on the foreground.

Enumeration: ScaleBarFittingStrategy

A list of scale bar fitting strategies.

PropertyValueDescription
AdjustDivision0Adjust the division value.
AdjustDivisions1Adjust the number of divisions.
AdjustDivisionAndDivisions2Adjust the division value and number of divisions.
AdjustFrame3Adjust the size of the scale bar frame.
FixedWidth4Preserve the width of the scale bar in page units. Deprecated in 3.4. Use FixedBarWidth instead.
FixedHeight5Preserve the total distance shown in the scale bar. Deprecated in 3.4.
FixedBarWidth6Preserve the width of the scale bar in page units.

Enumeration: ScaleBarFrequency

Lists the options for the frequency marks appear on the scale bar.

PropertyValueDescription
None0None.
One1One.
MajorDivisions2Major divisions.
Divisions3Divisions.
DivisionsAndFirstMidpoint4Divisions and first mid point.
DivisionsAndFirstSubdivisions5Divisions and first subdivisions.
DivisionsAndSubdivisions6Divisions and subdivisions.
DivisionsFirstSubdivisionFirstMidpoint7Divisions first subdivision and first midpoint.
EndsAndFirstDivision8Ends and first division.

Enumeration: ScaleBarLabelPosition

Lists the options for scale bar label positions.

PropertyValueDescription
Above0Above the scale bar.
BeforeLabels1Before the labels.
AfterLabels2After labels.
BeforeBar3Before the scale bar.
AfterBar4After the scale bar.
Below5Below the scale bar.
AboveLeft6Above the scale bar and to the left.
AboveRight7Above the scale bar and to the right.
AboveEnds8Above the ends of the scale bar.
BeforeAndAfterLabels9Before and after labels.
BeforeAndAfterBar10Before and after the scale bar.
BelowLeft11Below the scale bar and to the left.
BelowRight12Below the scale bar and to the right.
BelowEnds13Below the scale bar and on the ends.
OnBarAfterFirstDivision14On the scale bar after the first division.

Enumeration: ScaleBarVerticalPosition

A list of scale bar vertical positions.

PropertyValueDescription
Above0Above.
Top1Top.
On2On.
Bottom3Bottom.
Below4Below.
OnRight5On right.
OnLeft6On left.

CIMScaleLine

Represents a Scale line on a page layout.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMScaleBar

PropertyTypeDescription
alignToZeroPointbooleanA value indicating whether the scale bar should align to zero.
barHeightdoubleThe scale bar height.
divisiondoubleThe division value.
divisionslongThe number of divisions.
divisionsBeforeZerolongThe number of divisions before zero.
fittingStrategyenumeration ScaleBarFittingStrategyThe fitting strategy.
labelFrequencyenumeration ScaleBarFrequencyThe label frequency.
labelGapdoubleThe label gap value.
labelPositionenumeration ScaleBarVerticalPositionThe label position.
labelSymbolCIMSymbolReferenceLabel symbol.
numberFormatNumberFormatThe number format.
subdivisionslongThe number of subdivisions.
unitLabelstringThe unit label.
unitLabelGapdoubleThe unit label gap. Units set in points.
unitLabelPositionenumeration ScaleBarLabelPositionThe unit label position.
unitLabelSymbolCIMSymbolReferenceThe unit label symbol.
unitsUnitThe units for the scale bar.
useFractionCharactersbooleanA value indicating whether fractional characters should be used.
zeroPointPointThe zero location for the scale bar.
computeAtCenterbooleanA value indicating whether to compute the scale at map center.
displayFirstOutsidebooleanA value indicating whether to display the first numeric value outside the bar.
displayLastOutsidebooleanA value indicating whether to display the last numeric value outside the bar.
barWidthdoubleThe width of the scale bar.

CIMScaleMarks

PropertyTypeDescription
divisionMarkHeightdoubleThe division mark height value.
divisionMarkSymbolCIMSymbolReferenceThe division mark line symbol.
markFrequencyenumeration ScaleBarFrequencyThe division mark frequency.
markPositionenumeration ScaleBarVerticalPositionThe division mark position.
subdivisionMarkHeightdoubleThe subdivision mark height.
subdivisionMarkSymbolCIMSymbolReferenceThe subdivision mark line symbol.
midpointMarkHeightdoubleThe midpoint mark height.
midpointMarkSymbolCIMSymbolReferenceThe midpoint mark line symbol.

CIMScaleLine

PropertyTypeDescription
lineSymbolCIMSymbolReferenceThe scale line symbol.
steppedbooleanA value indicating whether the scale line should be stepped.

CIMSimpleGridLabelTemplate

Represents a simple format for a label.

CIMGridLabelTemplate

PropertyTypeDescription

CIMSimpleGridLabelTemplate

PropertyTypeDescription
dynamicStringTemplatestringThe dynamic text as a template for labels.
symbolCIMSymbolReferenceThe symbol for the text of labels.

CIMSingleFillScaleBar

Represents and single fill scale bar on a page layout.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMScaleBar

PropertyTypeDescription
alignToZeroPointbooleanA value indicating whether the scale bar should align to zero.
barHeightdoubleThe scale bar height.
divisiondoubleThe division value.
divisionslongThe number of divisions.
divisionsBeforeZerolongThe number of divisions before zero.
fittingStrategyenumeration ScaleBarFittingStrategyThe fitting strategy.
labelFrequencyenumeration ScaleBarFrequencyThe label frequency.
labelGapdoubleThe label gap value.
labelPositionenumeration ScaleBarVerticalPositionThe label position.
labelSymbolCIMSymbolReferenceLabel symbol.
numberFormatNumberFormatThe number format.
subdivisionslongThe number of subdivisions.
unitLabelstringThe unit label.
unitLabelGapdoubleThe unit label gap. Units set in points.
unitLabelPositionenumeration ScaleBarLabelPositionThe unit label position.
unitLabelSymbolCIMSymbolReferenceThe unit label symbol.
unitsUnitThe units for the scale bar.
useFractionCharactersbooleanA value indicating whether fractional characters should be used.
zeroPointPointThe zero location for the scale bar.
computeAtCenterbooleanA value indicating whether to compute the scale at map center.
displayFirstOutsidebooleanA value indicating whether to display the first numeric value outside the bar.
displayLastOutsidebooleanA value indicating whether to display the last numeric value outside the bar.
barWidthdoubleThe width of the scale bar.

CIMScaleMarks

PropertyTypeDescription
divisionMarkHeightdoubleThe division mark height value.
divisionMarkSymbolCIMSymbolReferenceThe division mark line symbol.
markFrequencyenumeration ScaleBarFrequencyThe division mark frequency.
markPositionenumeration ScaleBarVerticalPositionThe division mark position.
subdivisionMarkHeightdoubleThe subdivision mark height.
subdivisionMarkSymbolCIMSymbolReferenceThe subdivision mark line symbol.
midpointMarkHeightdoubleThe midpoint mark height.
midpointMarkSymbolCIMSymbolReferenceThe midpoint mark line symbol.

CIMSingleFillScaleBar

PropertyTypeDescription
fillSymbolCIMSymbolReferenceThe fill symbol for the scale bar.

CIMSlopeGuide

A slope guide surround element which is used to ascertaining terrain slope graphically as a percentage and a gradient (degree).

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMMapProductSurround

PropertyTypeDescription
autoUpdatebooleanA value indicating whether properties of the surround should update automatically based on changes in the map.
productSpecificationenumeration MapProductSpecTypeThe map product specification type of the surround.
drawToSpecificationbooleanA value indicating whether to draw the element to specification size or allow user to manually resize element.

CIMSlopeGuide

PropertyTypeDescription
slopeGuideLayerURIstringThe layer used to calculate slope guide.
contourIntervalFieldstringThe name of the contour interval field.
mapScalelongThe map scale the slope guide will be based on.
contourIntervallongThe contour interval.
titleTextSymbolCIMSymbolReferenceThe symbol used for title of element.
slopeUnitTextSymbolCIMSymbolReferenceThe symbol used for text identifying slope as percentage or degree.
slopeTextSymbolCIMSymbolReferenceThe symbol used for labeling slope values.
footnoteTextSymbolCIMSymbolReferenceThe symbol used for footnote at bottom of slope guide.
verticalLineSymbolCIMSymbolReferenceThe symbol used for vertical lines in slope guide.
horizontalLineSymbolCIMSymbolReferenceThe symbol used for horizontal lines in slope guide.
tickLineSymbolCIMSymbolReferenceThe symbol used for dashed lines in slope guide.

CIMSpatialMapSeries

Spatial Map Series is a means to create a series of map pages based off of spatial features.

CIMMapSeries

PropertyTypeDescription
enabledbooleanA value indicating whether the map series is enabled on the layout.
mapFrameNamestringThe URI of the MapFrame to which MapSeries is linked.
startingPageNumberlongThe starting page number.
currentPageIDlong longThe current page Id.

CIMSpatialMapSeries

PropertyTypeDescription
indexLayerURIstringThe URI of the index layer.
nameFieldstringThe name of the specified page.
numberFieldstringThe number of the specified page.
categoryFieldstringThe category of the page.
rotationFieldstringThe page specific rotation.
sortFieldstringThe required field that specifies the field used to determine sort order.
scaleFieldstringField that specifies the page specific scale.
spatialReferenceFieldstringThe spatial reference of the page.
sortAscendingbooleanA value indicating whether to sort in ascending or descending order.
scaleRoundingdoubleThe specified value to which the scale rounds to.
extentOptionsenumeration ExtentFitTypeThe extent fitting options.
marginTypeenumeration UnitTypeThe type of margins.
marginUnitsLinearUnitThe units of the margin.
margindoubleThe value of the margin.
clipMapToIndexFeaturebooleanA value indicating whether map clipping is synchronized with the current series index feature.

Enumeration: StreetIndexDelimiter

List of delimiters for column separation.

PropertyValueDescription
Period0Period delimiter.
Space1Space delimiter.
Hyphen2Hyphen delimiter.
Underscore3Underscore delimiter.

Enumeration: StreetIndexWrapMethod

A list of ways to wrap data across multiple columns in CIMMapProductBaseStreetIndex.

PropertyValueDescription
Wrap0Wrap text based on height of frame across multiple columns. Text will continue at top of next column.
GroupWrap1Wrap text based on a grouped field across multiple columns. Text will continue at top of next column if group does not fit in current column.

CIMTMElevationGuideBarElement

Represents TM Elevation Guide Bar surround element.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMMapProductSurround

PropertyTypeDescription
autoUpdatebooleanA value indicating whether properties of the surround should update automatically based on changes in the map.
productSpecificationenumeration MapProductSpecTypeThe map product specification type of the surround.
drawToSpecificationbooleanA value indicating whether to draw the element to specification size or allow user to manually resize element.

CIMTMElevationGuideBarElement

PropertyTypeDescription
elevationBandLayerURIstringElevation bands feature class, the number of bands in the bar is dependent on the number of bands identified in feature class.
numberOfBandslongThe number of bands displayed in the Elevation Guide Bar, if data is from source that does not have Bands field.
textSymbolCIMSymbolReferenceThe symbol used for text elements in the elevation guide bar.
lineSymbolCIMSymbolReferenceThe symbol used for line elements in the elevation guide bar.
highestBandSymbolCIMSymbolReferenceThe highest band symbol in the elevation guide bar.
highBandSymbolCIMSymbolReferenceThe high band symbol in the elevation guide bar.
mediumBandSymbolCIMSymbolReferenceThe medium band symbol in the elevation guide bar.
lowBandSymbolCIMSymbolReferenceThe low band symbol in the elevation guide bar.

CIMTableFrame

Layout element used to display tabular data.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMTableFrame

PropertyTypeDescription
fields[CIMTableFrameField]The fields displayed by the table frame.
mapMemberURIstringThe layer or standalone table that defines the data to display.
fillingStrategyenumeration TableFrameFillingStrategyThe strategy used to query records.
fittingStrategyenumeration TableFrameFittingStrategyThe strategy used to query records.
columnslongThe number of columns.
minFontSizedoubleThe limit when reducing font sizes. Values is in points.
verticalTextGapdoubleThe vertical gap around field values.
horizontalTextGapdoubleThe horizontal gap around field values.
headingGapdoubleThe gap between field names and rows.
rowGapdoubleThe gap between rows.
fieldGapdoubleThe gap between fields.
columnGapdoubleThe gap between table columns.
headingBackgroundSymbolCIMSymbolReferenceThe field name/alias background symbol.
headingBorderSymbolCIMSymbolReferenceThe field name/alias border symbol.
headingLineSymbolCIMSymbolReferenceThe field name/alias underline symbol.
columnBorderSymbolCIMSymbolReferenceThe column border symbol.
alternate1RowBackgroundSymbolCIMSymbolReferenceThe second alternating data record background symbol.
alternate1RowBackgroundCountlongThe alternate 1 row background count. Show even row background for this many rows before alternating.
alternate2RowBackgroundSymbolCIMSymbolReferenceThe first alternating data record background symbol.
alternate2RowBackgroundCountlongThe alternate 2 row background count. Show odd row background for this many rows before alternating.
rowBorderSymbolCIMSymbolReferenceThe border symbol for row sections: data records, summary statistics, and statistics totals.
customWhereClausestringThe custom where clause. Show rows that match custom where clause when FillingStrategy is set to esriCIMTableFrameFillingStrategy_CustomWhereClause.
defaultTableFrameFieldCIMTableFrameFieldThe default table frame field used when creating new table frames.
balanceColumnsbooleanA value indicating whether to balance the columns of the table.
rowLimitlongThe maximum number of rows the table frame will show. 0 Indicates "no limit".
showHeadingsbooleanA value indicating whether to show the headings.

CIMTableFrameField

Display properties for fields in a table frame.

CIMTableField

PropertyTypeDescription
namestringThe field name and unique identifier.
isVisiblebooleanA value indicating whether the field is visible.
widthdoubleThe width of field. A value of 0 indicates "auto size".
sortInfoenumeration FieldSortInfoThe options when this field is used for sorting.
sortOrderlongThe zero based sort order. -1 indicates field isn't used for sorting.
fieldOrderlongThe zero based display order.
groupbooleanA value indicating whether this is a grouping field.
displayNamestringThe display name for the field.

CIMTableFrameField

PropertyTypeDescription
enableWordWrappingbooleanA value indicating whether to wrap field values that don't fit the width.
headingTextSymbolCIMSymbolReferenceThe field name/alias text symbol.
textSymbolCIMSymbolReferenceThe field value text symbol.
backgroundSymbolCIMSymbolReferenceThe field background symbol.
borderSymbolCIMSymbolReferenceThe field border symbol.
verticalLineSymbolCIMSymbolReferenceThe symbol for vertical lines on sides of field.

Enumeration: TableFrameFillingStrategy

Table frame fitting strategies.

PropertyValueDescription
ShowAllRows0Show all the rows.
ShowVisibleRows1Show the rows that are visible.
ShowMapSeriesRows2Show the rows that intersect the current map series shape.
CustomWhereClause3Show rows that match a custom query.

Enumeration: TableFrameFittingStrategy

Defines which table rows to display.

PropertyValueDescription
AdjustSize0Reduce fonts sizes to make data fit.
AdjustColumns1Flow to multiple columns to make data fit.
AdjustColumnsAndSize2Reduce font sizes and flow to multiple columns to make data fit.
AdjustFrame3Adjust the frame to fit the specified font sizes and columns.

CIMTopoCompassRose

Represents a compass rose north arrow which displays declination with a compass dial.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMNorthArrow

PropertyTypeDescription
referenceLocationPointThe reference location for a north arrow.
calibrationAngledoubleThe calibration angle for a north arrow.

CIMTopoNorthArrow

PropertyTypeDescription
dateTimeInstantThe date used when calculating declination using world magnetic model.
zoneSpatialReferenceThe spatial reference used for calculating declination, typically a UTM zone.
isPrimaryZonebooleanA value indicating whether the zone is the primary zone. Set to false when using 2nd north arrow for maps that extend across two UTM zones.
GMAngleCIMDeclinationThe Grid Magnetic declination.
gridConvergenceCIMDeclinationThe Grid Convergence declination.
directionalNotesbooleanA value indicating whether the directional notes are displayed on the north arrow.
leadingZerobooleanA value indicating whether a leading zero is displayed for minute coordinates of grid convergence.
roundGMAnglebooleanA value indicating whether GM angle is rounded for display. If true GM angle is displayed to nearest 1/2 degree, if false it is displayed as degrees and minutes.
roundMilsbooleanA value indicating whether Mils rounded for display. If true Mils for both GC and GM will be displayed rounded to nearest 10 Mils, otherwise to nearest 1 Mil. If RoundGMAngle is true, this property is ignored.
autoUpdatebooleanA value indicating whether the properties of the topographic north arrow should update automatically based on changes in the map.
largeSizebooleanA value indicating whether the topographic north arrow is displayed in large size.
textSymbolCIMSymbolReferenceThe symbol used for text elements in topographic north arrow.
lineSymbolCIMSymbolReferenceThe symbol used for line elements in the topographic north arrow.
trueNorthMarkerSymbolCIMSymbolReferenceThe symbol displayed at top of true north line, default is a star.
magneticNorthNegativeSymbolCIMSymbolReferenceThe symbol displayed at top of magnetic north line when the gm-angle is negative.
magneticNorthPositiveSymbolCIMSymbolReferenceThe symbol displayed at top of magnetic north line when the gm-angle is positive.
magneticNorthZeroSymbolCIMSymbolReferenceThe symbol displayed at top of magnetic north line when the gm-angle is 0 degrees.
declinationArcSymbolCIMSymbolReferenceThe line symbol used to display declination arc lines.
productSpecificationenumeration MapProductSpecTypeThe map product specification type of topographic north arrow.
drawToSpecificationbooleanA value indicating whether to draw the element to specification size or allow user to manually resize element.
dateIntervallongA value indicating the date interval used to calculate declination. The default value is 5 which is based on the interval used by the World Magnetic Model. A value of zero indicates the current date should be used.

CIMTopoCompassRose

PropertyTypeDescription
degreeLabelFrequencylongThe frequency in which a degree label is displayed. Valid values are 0 to 359.
divisionMarkSymbolCIMSymbolReferenceThe line symbol used to draw the division marks on compass dial.
subdivisionMarkSymbolCIMSymbolReferenceThe line symbol used to draw the sub division marks on compass dial.
degreeMarkSymbolCIMSymbolReferenceThe line symbol used to draw the degree marks on compass dial.
divisionslongThe frequency of divisions on the compass dial. Valid values are 0 to 359.
subdivisionslongThe frequency of subdivisions on the compass dial. Valid values are 0 to 359.

CIMTopoNorthArrow

Represents a topographic north arrow which displays declination of true, grid and magnetic north.

CIMElement

PropertyTypeDescription
anchorenumeration AnchorThe anchor position of the element.
lockedbooleanA value indicating whether the element is locked. Each element in the contents pane has a lock icon. If the icon is shown as locked, you can not select that feature in the layout using the select tool.
namestringThe name of the element.
visiblebooleanA value indicating whether the element is visible.
rotationdoubleThe rotation of the element.
rotationCenterPointThe location of the anchor in page units.This is also the location the feature is rotated around.
lockedAspectRatiobooleanA value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally.
customProperties[CIMStringMap]The custom properties of the element.
expandedbooleanA value indicating whether this element is expanded in the contents pane.

CIMFrameElement

PropertyTypeDescription
framePolygonThe geometry of a frame for an element.
graphicFrameCIMGraphicFrameThe graphic symbology of an element's frame.

CIMMapSurround

PropertyTypeDescription
mapFramestringThe map frame associated with the map surround.
minScaledoubleThe minimum scale.
maxScaledoubleThe maximum scale.

CIMNorthArrow

PropertyTypeDescription
referenceLocationPointThe reference location for a north arrow.
calibrationAngledoubleThe calibration angle for a north arrow.

CIMTopoNorthArrow

PropertyTypeDescription
dateTimeInstantThe date used when calculating declination using world magnetic model.
zoneSpatialReferenceThe spatial reference used for calculating declination, typically a UTM zone.
isPrimaryZonebooleanA value indicating whether the zone is the primary zone. Set to false when using 2nd north arrow for maps that extend across two UTM zones.
GMAngleCIMDeclinationThe Grid Magnetic declination.
gridConvergenceCIMDeclinationThe Grid Convergence declination.
directionalNotesbooleanA value indicating whether the directional notes are displayed on the north arrow.
leadingZerobooleanA value indicating whether a leading zero is displayed for minute coordinates of grid convergence.
roundGMAnglebooleanA value indicating whether GM angle is rounded for display. If true GM angle is displayed to nearest 1/2 degree, if false it is displayed as degrees and minutes.
roundMilsbooleanA value indicating whether Mils rounded for display. If true Mils for both GC and GM will be displayed rounded to nearest 10 Mils, otherwise to nearest 1 Mil. If RoundGMAngle is true, this property is ignored.
autoUpdatebooleanA value indicating whether the properties of the topographic north arrow should update automatically based on changes in the map.
largeSizebooleanA value indicating whether the topographic north arrow is displayed in large size.
textSymbolCIMSymbolReferenceThe symbol used for text elements in topographic north arrow.
lineSymbolCIMSymbolReferenceThe symbol used for line elements in the topographic north arrow.
trueNorthMarkerSymbolCIMSymbolReferenceThe symbol displayed at top of true north line, default is a star.
magneticNorthNegativeSymbolCIMSymbolReferenceThe symbol displayed at top of magnetic north line when the gm-angle is negative.
magneticNorthPositiveSymbolCIMSymbolReferenceThe symbol displayed at top of magnetic north line when the gm-angle is positive.
magneticNorthZeroSymbolCIMSymbolReferenceThe symbol displayed at top of magnetic north line when the gm-angle is 0 degrees.
declinationArcSymbolCIMSymbolReferenceThe line symbol used to display declination arc lines.
productSpecificationenumeration MapProductSpecTypeThe map product specification type of topographic north arrow.
drawToSpecificationbooleanA value indicating whether to draw the element to specification size or allow user to manually resize element.
dateIntervallongA value indicating the date interval used to calculate declination. The default value is 5 which is based on the interval used by the World Magnetic Model. A value of zero indicates the current date should be used.

Enumeration: UnitType

Lists the unit type values.

PropertyValueDescription
Percent0Percent.
MapUnits1Map Units.
PageUnits2Page units.

CIMVerticalLegendItem

Represents a vertical legend item in a legend.

CIMLegendItem

PropertyTypeDescription
namestringThe legend item name.
newColumnbooleanA value indicating whether a legend item should be placed in a new column.
layerNameSymbolCIMSymbolReferenceThe legend item symbol.
manualColumnlongThe manual column assignment for a legend item.
keepTogetherOptionenumeration LegendKeepTogetherOptionA value indicating whether the legend item or group should be kept together.
showLayerNamebooleanA value indicating whether the legend item layer name should be displayed.
showHeadingbooleanA value indicating whether the legend item heading should be displayed.
headingSymbolCIMSymbolReferenceThe legend item heading symbol.
showLabelsbooleanA value indicating whether the legend item labels should be displayed.
layerstringThe legend item layer's path.
showDescriptionbooleanA value indicating whether a legend item description should be displayed.
labelSymbolCIMSymbolReferenceThe legend item label symbol.
descriptionSymbolCIMSymbolReferenceThe legend item description symbol.
patchWidthdoubleThe legend item patch width. Units in points.
patchHeightdoubleThe legend item patch height. Units in points.
autoVisibilitybooleanA value indicating whether the legend item should be displayed if in the visible extent.
useMapSeriesShapebooleanA value indicating whether to use map series shape instead of map frame to find dynamic classes.
classIndentdoubleDistance from the class name to the edge of the legend.
headingIndentdoubleDistance from the heading to the edge of the legend.
layerNameIndentdoubleDistance of the layer name to the edge of the legend.
showGroupLayerNamebooleanA value indicating whether to show the containing group layer name above the item.
groupLayerNameSymbolCIMSymbolReferenceThe symbol used to display the group layer name.
scaleToPatchbooleanA value indicating whether to scale the symbol to the specified patch size.
showCountsbooleanA value indicating whether the legend should display count statistics.
countFormatNumberFormatThe feature count format.
countPrefixstringThe feature count prefix.
countSuffixstringThe feature count suffix.
isVisiblebooleanA value indicating whether the legend item is visible.
groupFilter[long]A value specifying which legend groups are displayed.

CIMLegendItemArrangement

PropertyTypeDescription
arrangementenumeration LegendItemArrangementThe Arrangement.

CIMVerticalLegendItem

PropertyTypeDescription
patchAlignmentenumeration HorizontalAlignmentA value to allow alignment of graduated symbols to be specified.