Namespace ESRI.ArcGIS.CIM
The CIM library describes custom symbols assembled from strokes, fills, markers, and other symbol-layer components.
Classes
- CIM3DSymbolProperties
Represents 3D symbol properties, a collection of symbol properties that apply when the symbol is used in a 3D context.
- CIMAnimatedSymbolProperties
Represents animated symbol properties, a collection of symbol properties that apply when the symbol layer has animation data.
- CIMBackgroundCallout
Represents a background callout which draws a callout with an optional polygon background and leader line.
- CIMBalloonCallout
Represents a balloon callout. Balloon callouts are a filled background that is placed behind text. They may or may not have a leader line connecting the callout to an anchor point.
- CIMCGAAttribute
Represents a CGA attribute, the symbol attribute as specified by the CGA code in the rule package.
- CIMCMYKColor
Represents a color in the CMYK color model.
- CIMCallout
Represents a callout.
- CIMCharacterMarker
Represents a character marker.
- CIMClippingPath
Represents a vector marker clipping path.
- CIMColor
Supports colors in the CIM model by providing low level access to properties common amongst all color types.
- CIMColorRamp
Supports color ramp schemes in the CIM model by providing low level access to properties common amongst all color ramp types.
- CIMColorSpace
Supports colors spaces by providing a common base type for all color spaces.
- CIMColorSubstitution
Represents color substitution, an ordered list of color substitutes.
- CIMCompositeCallout
Represents a composite callout. Composite callouts are a filled background along with an optional shadow, which is placed behind text. They may also have a leader line (consisting of one or both of a simple line, and filled dart) connecting the callout to an anchor point. Composite callouts may have additional surrounding text elements. The text representing these parts is specified in the text string using tags. Their relative position properties are specified in the CIMCompositeCallout through their corresponding CIMCompositeTextPartPosition elements specified below, but these properties can also be overridden with tag attributes.
- CIMCompositeTextPartPosition
Represents the text part position properties on a callout part.
- CIMContinuousColorRamp
Supports continuous color ramp schemes by providing low level access to properties common amongst all continuous color ramp types.
- CIMDimensionStyle
Represents an dimension style which defines dimension appearance.
- CIMExpressionInfo
Represents the properties required for authoring an Arcade expression.
- CIMFill
Represents a fill which defines how the polygonal geometry is drawn.
- CIMFixedColorRamp
Represents a color scheme composed of discrete colors.
- CIMFontVariation
Represents a font variation tag name and value. This is sometimes referred to as a variation-axis tag and variation-axis value.
- CIMGeneralPlacementProperties
Represents general placement properties. This is base class for general placement properties for each label engine.
- CIMGeometricEffect
Represents a geometric effect, this is base class for all geometric effects.
- CIMGeometricEffectAddControlPoints
Represents the add control points geometric effect.
- CIMGeometricEffectArrow
Represents the arrow geometric effect which creates a dynamic line along a line feature with an arrow of a specified arrow type and width.
- CIMGeometricEffectBuffer
Represents the buffer geometric effect which creates a dynamic polygon with a specified distance around features.
- CIMGeometricEffectCircularSector
Represents the circular sector geometric effect which creates a circular sector of a specified radius and start/end angles originating from a point feature.
- CIMGeometricEffectControlMeasureLine
Represents the control measure line geometric effect.
- CIMGeometricEffectCut
Represents the cut geometric effect which creates a dynamic line that is shorter on one or both ends than the line feature or polygon outline.
- CIMGeometricEffectDashes
Represents the dashes geometric effect which creates a dynamic multipart line geometry from a line feature or the outline of a polygon based on a template.
- CIMGeometricEffectDonut
Represents the donut geometric effect which creates a dynamic polygon ring of a specified width in relation to the outline of polygon features.
- CIMGeometricEffectEnclosingPolygon
Represents the enclosing polygon geometric effect which creates a dynamic polygon from the spatial extent of a line or polygon feature.
- CIMGeometricEffectExtension
Represents the extension geometric effect which creates a dynamic line that is extended from either the beginning or the end of the line feature at a specified deflection angle and length.
- CIMGeometricEffectJog
Represents the jog geometric effect which creates a dynamic line with a jog of a specified angle, position, and width in the line.
- CIMGeometricEffectLocalizerFeather
Represents a geometric effect which creates a localizer feather for aeronautical charts.
- CIMGeometricEffectMove
Represents the move geometric effect which creates a point, line or polygon that is offset a specified distance in X and Y.
- CIMGeometricEffectOffset
Represents the offset geometric effect which creates a dynamic line or polygon offset at a specified distance perpendicularly from a feature.
- CIMGeometricEffectOffsetHatch
Represents a geometric effect which creates a hatch pattern to depict special use airspace for aeronautical charts.
- CIMGeometricEffectOffsetTangent
Represents the offset tangent geometric effect which creates a dynamic line along a line feature offset in the direction defined by either the beginning or the end of the line.
- CIMGeometricEffectRadial
Represents the radial geometric effect which creates a dynamic line of a specified length and angle originating from a point feature.
- CIMGeometricEffectRegularPolygon
Represents the regular polygon geometric effect which creates a dynamic polygon around a point feature with a specified number of edges. All edges are equal in length and all angles are equal.
- CIMGeometricEffectReverse
Represents the reverse geometric effect which creates a dynamic polygon around a point feature with a specified number of edges. All edges are equal in length and all angles are equal.
- CIMGeometricEffectRotate
Represents the rotate geometric effect which creates a dynamic line or polygon rotated a specified angle from the feature.
- CIMGeometricEffectScale
Represents the rotate geometric effect which creates a dynamic line or polygon scaled by a specified factor. Vertices are moved in relation to the center point of a feature envelope. Values greater than 1 move vertices away from the center point. Values between 0 and 1 move vertices toward the center point. Values less than 0 draw an inverse dynamic line or polygon where the vertices have crossed to the other side of the center point.
- CIMGeometricEffectSuppress
Represents the suppress geometric effect which creates a dynamic line that hides sections of a stroke between pairs control points.
- CIMGeometricEffectTaperedPolygon
Represents the tapered polygon geometric effect which creates a dynamic polygon along a line feature, whose width varies by two specified amounts along its length, as defined by a percentage of the line feature's length.
- CIMGeometricEffectWave
Represents the wave geometric effect which creates a dynamic line or polygon along a feature with a repeating wave pattern.
- CIMGradientFill
Represents a gradient fill which fills polygonal geometry with a specified color scheme.
- CIMGradientStroke
Represents a gradient stroke which draws linear geometry with a specified color scheme.
- CIMGraphic
Represents a graphic.
- CIMGraphicFrame
Represents a graphic frame.
- CIMGrayColor
Represents a grayscale color defined by lightness.
- CIMHSLColor
Represents a color defined by hue, saturation, and lightness.
- CIMHSVColor
Represents a color defined by hue, saturation, and brightness (value).
- CIMHatchFill
Represents a hatch fill which fills polygonal geometry with a uniform series of parallel line symbols.
- CIMICCColorSpace
Represents a color space defined by an International Color Consortium (ICC) color profile.
- CIMLABColor
Represents a color defined in the LAB color space.
- CIMLabelClass
Represents a label class which describes how to generate a set of text labels from a group of features in a feature layer.
- CIMLabelClassProperties
Represents label class properties.
- CIMLabelPlacementProperties
Represents label placement properties.
- CIMLeader
Represents the generic base type for leaders.
- CIMLeaderLine
Represents a leader line.
- CIMLeaderPoint
Represents a leader point.
- CIMLineCallout
Represents a line callout.
- CIMLineSymbol
Represents a line symbol which is used to draw polyline features or graphics.
- CIMLinearContinuousColorRamp
Represents a linear continuous color ramp scheme.
- CIMMaplexDictionary
Represents a Maplex dictionary.
- CIMMaplexDictionaryEntry
Represents a Maplex dictionary entry.
- CIMMaplexExternalZonePriorities
Represents Maplex external zone priorities.
- CIMMaplexGeneralPlacementProperties
Represents Maplex general placement properties.
- CIMMaplexInternalZonePriorities
Represents Maplex internal zone priorities.
- CIMMaplexKeyNumberGroup
Represents a Maplex key number group.
- CIMMaplexLabelPlacementProperties
Represents Maplex label placement properties.
- CIMMaplexLabelStackingProperties
Represents Maplex label stacking properties.
- CIMMaplexOffsetAlongLineProperties
Represents Maplex offset along the line properties.
- CIMMaplexRotationProperties
Represents Maplex rotation properties.
- CIMMaplexStackingSeparator
Represents a Maplex stacking separator.
- CIMMaplexStrategyPriorities
Represents Maplex strategy priorities.
- CIMMarker
Represents a marker which is a self-contained shape or image that can draw for a point graphic or placed in a repeating arrangement along a stroke or within a fill. It can be a glyph from a font, a picture, a collection of vector geometries, or a 3D model.
- CIMMarkerFillPlacement
Represents a marker fill placement.
- CIMMarkerGraphic
Represents a marker graphic which is used to define vector graphics in a vector marker.
- CIMMarkerPlacement
Represents a marker placement.
- CIMMarkerPlacementAlongLine
Represents marker placement along the line which defines how a marker is placed along a line or polygon outline.
- CIMMarkerPlacementAlongLineRandomSize
Represents marker placement along the line which places randomly sized markers evenly along a line or polygon outline.
- CIMMarkerPlacementAlongLineSameSize
Represents marker placement along the line which places markers that are the same size evenly along a line or polygon outline.
- CIMMarkerPlacementAlongLineVariableSize
Represents marker placement along the line which places markers in either increasing, decreasing or alternating gradations along a line or polygon outline.
- CIMMarkerPlacementAroundPolygon
Represents marker placement around polygon which places a marker on a specific position on the polygon outline.
- CIMMarkerPlacementAtExtremities
Represents marker placement at extremities which places markers at only one or both endpoints of a line.
- CIMMarkerPlacementAtMeasuredUnits
Represents marker placement at geometry M values.
- CIMMarkerPlacementAtRatioPositions
Represents marker placement at ratio positions which places a set number of markers along the line or the outline of a polygon.
- CIMMarkerPlacementInsidePolygon
Represents marker placement inside a polygon which defines how a polygon is filled with a pattern of markers.
- CIMMarkerPlacementOnLine
Represents a marker placement on the line.
- CIMMarkerPlacementOnVertices
Represents a marker placement on vertices which places a single marker on a line or polygon outline at a set distance from the middle or one of the endpoints.
- CIMMarkerPlacementPolygonCenter
Represents marker placement polygon center which defines how a single marker will be placed within the polygon.
- CIMMarkerStrokePlacement
Represents a marker stroke placement.
- CIMMaterialSymbolLayer
Represents a material which defines how the multipatch or mesh is drawn.
- CIMMeshEdge
Represents a stroke drawn at specified edges of a mesh.
- CIMMeshSymbol
Represents a mesh symbol which is used to draw multipatch features or mesh features.
- CIMMultiLayerSymbol
Represents a multilayer symbol, a generic type for point, line, and polygon symbols, specifying that they can contain more than one symbol layers.
- CIMMultipartColorRamp
Represents a multipart color ramp scheme.
- CIMObject
Represents the base CIM object class.
- CIMParagraphTextGraphic
Represents a paragraph text graphic.
- CIMPictureFill
Represents a picture fill which fills polygonal geometry with a picture. Supported file types are .bmp, .jpg, .png, and .gif.
- CIMPictureMarker
Represents a picture marker created from a raster (bitmapped) image file. The image can have color substitutions to replace one or more colors in the image or it can have a tint applied to the whole image depending on the picture type. Supported formats are .bmp, .jpg, .png, and .gif.
- CIMPictureStroke
Represents a picture stroke which draws linear geometry with a repeating image file. Supported file types are .bmp, .jpg, .png, and .gif.
- CIMPointSymbol
Represents a point symbol used to draw point features and point graphics.
- CIMPointSymbolCallout
Represents a point symbol callout which draws a point symbol as the background and a line symbol for leaders. Often used for highway shields.
- CIMPolarContinuousColorRamp
Represents a polar continuous color ramp scheme.
- CIMPolygonSymbol
Represents a polygon symbol which is used to draw polygon features or polygon graphics.
- CIMPrimitiveOverride
Represents a primitive override.
- CIMProceduralSymbolLayer
Represents a procedural symbol layer which defines rendering using script-based logic to construct complex 3D objects and textures from simple geometries. Properties of the symbol are derived from a rule package (.rpk file).
- CIMRGBColor
Represents a color in the RGB color model.
- CIMRandomHSVColorRamp
Represents a random HSV color ramp scheme.
- CIMScaleDependentSizeVariation
Represents the scale dependent size variations for a symbol reference.
- CIMShapeVertex
Represents a shape vertex.
- CIMShapeVertices
Represents shape vertices.
- CIMSimpleLineCallout
Represents a simple line callout for drawing basic leader lines.
- CIMSolidFill
Represents a solid fill which fills polygonal geometry with a single solid color.
- CIMSolidMeshEdge
Represents a stroke drawn at specified edges of a mesh using solid color.
- CIMSolidStroke
Represents a solid stroke which draws linear geometry with a single solid color.
- CIMSpotColor
Represents a spot color.
- CIMSpotColorSpace
Represents a color space for spot colors.
- CIMStandardGeneralPlacementProperties
Represents standard label engine general placement properties.
- CIMStandardLabelPlacementProperties
Represents standard label engine label placement properties.
- CIMStandardLineLabelPosition
Represents standard label engine line label position.
- CIMStandardLineLabelPriorities
Represents standard label engine line label priorities.
- CIMStandardPointPlacementPriorities
Represents standard label engine point placement priorities.
- CIMStroke
Represents a stroke which defines how line geometry or the outline of polygon geometry is drawn.
- CIMSymbol
Represents a symbol. A symbol is used to describe how a geometric shape, such as that from a graphic or feature, is displayed.
- CIMSymbolAnimation
Represents an animation of a symbol, this is the base class for all animations.
- CIMSymbolAnimationColor
Represents the color animation.
- CIMSymbolAnimationMoveAlongLine
Represents the move along line animation.
- CIMSymbolAnimationOffset
Represents the offset animation.
- CIMSymbolAnimationRotation
Represents the rotation animation.
- CIMSymbolAnimationScale
Represents the scale animation.
- CIMSymbolAnimationSize
Represents the size animation.
- CIMSymbolAnimationTransparency
Represents the transparency animation.
- CIMSymbolIdentifier
Represents a symbol identifier.
- CIMSymbolLayer
Represents a symbol layer. Symbol layers are the components that make up a symbol. A symbol layer is represented by a stroke, fill, marker, or procedural symbol layer.
- CIMSymbolReference
Represents a symbol reference.
- CIMTextGraphic
Represents a text graphic.
- CIMTextGraphicBase
Represents a text graphic base class, the generic base class for text based graphics.
- CIMTextMargin
Represents a text margin which defines the margin to apply around text.
- CIMTextSymbol
Represents a text symbol which is used to draw text graphics, bleeds, and annotation. Text symbols do not contain any symbol layers but can have callouts.
- CIMVectorMarker
Represents a vector marker which can represent vector graphics. It's constructed from MarkerGraphics which are geometries and symbols used as building blocks for the marker.
- CIMWaterFill
Represents a water fill which fills polygonal geometry with animated water.
- CIMXYZColor
Represents a color in the XYZ color model.
- CIMglTFMarker3D
Represents a marker symbol for 3D objects.
Enums
- Anchor
A list of anchor positions for an element on a page layout.
- AngleAlignment
Angle alignment types.
- AnimatedSymbolEasingType
Represents the easing options for an animated symbol.
- AnimatedSymbolRepeatType
Represents the ways an animated symbol can be repeated.
- AnimationColorMode
Options to control how the animation color combines with symbol layer colors.
- BalloonCalloutStyle
Balloon callout styles.
- BillboardMode
A list of different billboard modes.
- BlendingMode
Blending modes.
- BlockProgression
Block progressions.
- CGAAttributeType
CGA attribute type.
- ClippingType
Clipping types.
- ColorSpaceType
Specifies color spaces used for colors.
- DimensionMarkerFit
Dimension marker fit options.
- DimensionPartOptions
Dimension part options.
- DimensionTextFit
Dimension text fit options.
- DimensionTextOption
Dimension text options.
- DimensionType
Dimension types supported by dimension features.
- DominantSizeAxis
Specifies the dominant size axis types.
- ExpressionReturnType
Return types for Arcade expressions.
- ExternalColorMixMode
Options to control how material combines with externally defined colors.
- ExtremityPlacement
Extremity placement options which specify at which ends of the line a marker will be placed.
- FeaturesToLabel
A list of types of features to label.
- FillMode
Fill modes.
- FixedColorRampArrangementType
Specifies the arrangement type for fixed color ramp.
- FontEffects
Font effects.
- FontEncoding
Font encodings.
- FontType
Font types.
- GeometricEffectArrowType
Geometric effect arrow types.
- GeometricEffectControlMeasureLineRule
Specifies the rules to transform the input ground control points given as a line.
- GeometricEffectDonutMethod
Geometric effect donut methods.
- GeometricEffectEnclosingPolygonMethod
Geometric effect enclosing polygon methods.
- GeometricEffectExtensionOrigin
Geometric effect extension origins. Specifies the origin of the extension to add to the line. The beginning and end of the line is defined by the direction the line was digitized.
- GeometricEffectLocalizerFeatherStyle
Geometric effect localizer feather styles.
- GeometricEffectOffsetMethod
Geometric effect offset method which specifies the way the strokes or fills are displayed at corners.
- GeometricEffectOffsetOption
Geometric effect offset options which specify the way the symbol handles complex geometries.
- GeometricEffectOffsetTangentMethod
Geometric effect offset tangent methods which specify the origin of the tangent offset for the line. The beginning and end of the lines are defined by how the line was digitized.
- GeometricEffectWaveform
Geometric effect offset waveforms.
- GlyphHinting
Glyph hinting options.
- GradientAlignment
Gradient alignment types.
- GradientFillMethod
Describes the gradient fill method which is how the gradient is applied.
- GradientStrokeMethod
The different methods of gradient strokes.
- GradientStrokeType
Gradient stroke types.
- HorizontalAlignment
Horizontal alignment types.
- LabelExpressionEngine
Label expression engine types.
- LabelFeatureType
The label feature types.
- LeaderLineStyle
The style of line to generate when a leader is drawn defined by an enumeration value. Line leaders will always be drawn with their own geometry.
- LineCapStyle
The style of stroke ending caps.
- LineDashEnding
Determines how the strokes with dash patterns and other patterns (tiled pictures, placement effects) are handled at the end points of the line geometry's segments.
- LineDecorationStyle
Defines simple decorations for lines.
- LineGapType
Specifies the type of line gap (line spacing) that is applied.
- LineJoinStyle
Specifies how the symbol is drawn at the stroke segment connections.
- MaplexAbbreviationType
Maplex abbreviation types.
- MaplexAnchorPointType
Maplex anchor point types.
- MaplexCenterLabelAnchorType
Options to determine how to place a centered point label.
- MaplexConnectionType
Maplex connection types.
- MaplexConstrainOffset
Maplex offset constraint types.
- MaplexContourAlignmentType
Maplex contour alignment types.
- MaplexContourLadderType
Maplex contour ladder types.
- MaplexGraticuleAlignmentType
Maplex graticule alignment types.
- MaplexKeyNumberHorizontalAlignment
Maplex key number group horizontal alignment types.
- MaplexKeyNumberMethod
Options that describe how a key numbering group is used.
- MaplexKeyNumberResetType
Identifies the options for reseting the key numbers in a Maplex key numbering group.
- MaplexLabelAnchorPoint
Maplex label anchor point.
- MaplexLabelRotationType
Maplex rotation types.
- MaplexLineFeatureType
Maplex line feature types.
- MaplexLinePlacementMethod
Maplex line placement methods.
- MaplexMultiPartOption
Maplex multipart options.
- MaplexOffsetAlongLineMethod
Maplex offset along the line methods.
- MaplexPointPlacementMethod
Maplex point placement methods.
- MaplexPolygonFeatureType
Maplex polygon feature types.
- MaplexPolygonPlacementMethod
Maplex polygon placement methods.
- MaplexQualityType
Maplex quality types.
- MaplexRemoveAmbiguousLabelsType
Options that describe when to remove ambiguous labels.
- MaplexRotationAlignmentType
Maplex rotation alignment types.
- MaplexStackingAlignment
Maplex stacking alignment.
- MaplexUnit
Maplex units.
- MarkerPlacementType
Marker placement types.
- MaterialMode
Material modes.
- MovementAlongLineType
Options to control the movement type for the move along line animation, indicating whether the symbol animates along the line by distance or by speed.
- PlacementAroundPolygonPosition
Options for how markers are placed in a uniform grid or randomly.
- PlacementClip
Options for how the markers should be clipped at the polygon boundary.
- PlacementEndings
Options for how markers are placed at extremities and control points.
- PlacementGridType
Options for how markers are placed in a uniform grid or randomly.
- PlacementOnLineRelativeTo
Options for the location on a line where a marker will be placed.
- PlacementPolygonCenterMethod
Options for how a single marker will be placed within the polygon.
- PlacementRandomlyAlongLineRandomization
Options for the amount of randomness to be used for the size and rotation of the markers on the line.
- PlacementStepPosition
Options for the placement step position.
- PointSymbolCalloutScale
An enumeration that defines how the background point symbol is scaled to fit the dimensions of the text.
- PolarDirection
Specifies the direction of the polar progression for the path from the beginning hue to the ending hue.
- PrimitiveShapeType
Indicates the types of primitive shapes.
- PrimitiveType3D
Indicates the types of 3D primitives.
- RotationOrder
Rotation order modes.
- Simple3DLineAnchor
Defines the vertical anchor used to render the simple 3D line style in relation to the ground in 3D. This property is ignored for the Strip style which is drawn flat upon the surface, and for the Wall style which always uses a Bottom anchor.
- Simple3DLineStyle
Simple 3D line styles which define how strokes will be rendered in 3D.
- SimplePlacementEndings
Options for how markers are placed at extremities and control points for the Variable Size marker placement.
- SizeVariationMethod
Size variation methods which define the order in which the change of size in the markers should occur.
- StandardFeatureWeight
Standard label engine feature weights.
- StandardLabelRotationType
Standard label engine label rotation types.
- StandardLabelWeight
Standard label engine label weight.
- StandardNumLabelsOption
Standard label engine number of labels options.
- StandardPointPlacementMethod
Standard label engine point placement methods.
- StandardPolygonPlacementMethod
Standard label engine polygon placement methods.
- SymbolUnits
Symbol unit types.
- TextCase
The letter case used to draw text.
- TextReadingDirection
Text reading directions.
- TextureFilter
Texture filter types.
- VerticalAlignment
Vertical alignment types.
- VerticalGlyphOrientation
Vertical glyph orientation.
- VerticalPositioning
Vertical positioning types.
- WaterbodySize
Waterbody size.
- WaveStrength
Strength of waves.