CIMGraphics.md

CIMGraphicFrame

Represents a graphic frame.

CIMGraphicFrame

Property	Type	Description
backgroundSymbol	CIMSymbolReference	The background symbol of the graphic frame.
borderSymbol	CIMSymbolReference	The border symbol of the graphic frame.
shadowSymbol	CIMSymbolReference	The shadow symbol of the graphic frame.
backgroundGapX	double	The background X gap.
backgroundGapY	double	The background Y gap.
backgroundCornerRounding	double	The background corner rounding. 0 = fully square. 100 = fully round.
borderGapX	double	The border X gap.
borderGapY	double	The border Y gap.
borderCornerRounding	double	The border corner rounding. 0 = fully square. 100 = fully round.
shadowOffsetX	double	The shadow X offset.
shadowOffsetY	double	The shadow Y offset.
shadowCornerRounding	double	The shadow corner rounding. 0 = fully square. 100 = fully round.

CIMInkGraphic

Represents an ink graphic.

CIMGraphic

Property	Type	Description
symbol	CIMSymbolReference	The symbol for the graphic.
transparency	double	The transparency of the graphic as a percentage. Typically set by the layer or element during draw, but not persisted. Change the transparency of layers in the symbol for persistent changes.
blendingMode	enumeration BlendingMode	The blending mode of the graphic. Typically set by the layer or element during draw.
masks	[{JSON_object}]	An array of masks for the graphic. Set by the layer or element during draw, but not persisted in the project. The per-feature masks which defines an area where the CIMGraphic should NOT draw. Every element in the array should support be a Polygon.
referenceScale	double	The reference scale of the graphic. Typically set by the layer or element during draw.
attributes	{JSON_object}	A property set of attributes. Typically set by the layer or element during draw.
placement	enumeration Anchor	The placement anchor of the graphic.

CIMInkGraphic

Property	Type	Description
bounds	Envelope	The bounds of the ink graphic.
inkData	string	The ink data as a string.
roughSketch	Polyline	A polyline used to define a rough sketch of the ink data.

CIMLeaderLine

Represents a leader line.

CIMLeader

Property	Type	Description

CIMLeaderLine

Property	Type	Description
line	Polyline	The leader line drawn from the graphic.

CIMLeaderPoint

Represents a leader point.

CIMLeader

Property	Type	Description

CIMLeaderPoint

Property	Type	Description
point	Point	The anchor point for the leader.

CIMLineGraphic

Represents a line graphic.

CIMGraphic

Property	Type	Description
symbol	CIMSymbolReference	The symbol for the graphic.
transparency	double	The transparency of the graphic as a percentage. Typically set by the layer or element during draw, but not persisted. Change the transparency of layers in the symbol for persistent changes.
blendingMode	enumeration BlendingMode	The blending mode of the graphic. Typically set by the layer or element during draw.
masks	[{JSON_object}]	An array of masks for the graphic. Set by the layer or element during draw, but not persisted in the project. The per-feature masks which defines an area where the CIMGraphic should NOT draw. Every element in the array should support be a Polygon.
referenceScale	double	The reference scale of the graphic. Typically set by the layer or element during draw.
attributes	{JSON_object}	A property set of attributes. Typically set by the layer or element during draw.
placement	enumeration Anchor	The placement anchor of the graphic.

CIMShapeGraphic

Property	Type	Description
name	string	The name.
popupHtmlText	string	The pop-up HTML text.

CIMLineGraphic

Property	Type	Description
line	Polyline	The polyline of the line graphic.

CIMMultiPatchGraphic

Represents a shape graphic with a MultiPatch geometry.

CIMGraphic

Property	Type	Description
symbol	CIMSymbolReference	The symbol for the graphic.
transparency	double	The transparency of the graphic as a percentage. Typically set by the layer or element during draw, but not persisted. Change the transparency of layers in the symbol for persistent changes.
blendingMode	enumeration BlendingMode	The blending mode of the graphic. Typically set by the layer or element during draw.
masks	[{JSON_object}]	An array of masks for the graphic. Set by the layer or element during draw, but not persisted in the project. The per-feature masks which defines an area where the CIMGraphic should NOT draw. Every element in the array should support be a Polygon.
referenceScale	double	The reference scale of the graphic. Typically set by the layer or element during draw.
attributes	{JSON_object}	A property set of attributes. Typically set by the layer or element during draw.
placement	enumeration Anchor	The placement anchor of the graphic.

CIMShapeGraphic

Property	Type	Description
name	string	The name.
popupHtmlText	string	The pop-up HTML text.

CIMMultiPatchGraphic

Property	Type	Description
multiPatch	MultiPatch	The graphic's MultiPatch geometry.

CIMMultipointGraphic

Represents a shape graphic with a Multipoint geometry.

CIMGraphic

Property	Type	Description
symbol	CIMSymbolReference	The symbol for the graphic.
transparency	double	The transparency of the graphic as a percentage. Typically set by the layer or element during draw, but not persisted. Change the transparency of layers in the symbol for persistent changes.
blendingMode	enumeration BlendingMode	The blending mode of the graphic. Typically set by the layer or element during draw.
masks	[{JSON_object}]	An array of masks for the graphic. Set by the layer or element during draw, but not persisted in the project. The per-feature masks which defines an area where the CIMGraphic should NOT draw. Every element in the array should support be a Polygon.
referenceScale	double	The reference scale of the graphic. Typically set by the layer or element during draw.
attributes	{JSON_object}	A property set of attributes. Typically set by the layer or element during draw.
placement	enumeration Anchor	The placement anchor of the graphic.

CIMShapeGraphic

Property	Type	Description
name	string	The name.
popupHtmlText	string	The pop-up HTML text.

CIMMultipointGraphic

Property	Type	Description
multipoint	Multipoint	The graphic's multipoint geometry.

CIMParagraphTextGraphic

Represents a paragraph text graphic.

CIMGraphic

Property	Type	Description
symbol	CIMSymbolReference	The symbol for the graphic.
transparency	double	The transparency of the graphic as a percentage. Typically set by the layer or element during draw, but not persisted. Change the transparency of layers in the symbol for persistent changes.
blendingMode	enumeration BlendingMode	The blending mode of the graphic. Typically set by the layer or element during draw.
masks	[{JSON_object}]	An array of masks for the graphic. Set by the layer or element during draw, but not persisted in the project. The per-feature masks which defines an area where the CIMGraphic should NOT draw. Every element in the array should support be a Polygon.
referenceScale	double	The reference scale of the graphic. Typically set by the layer or element during draw.
attributes	{JSON_object}	A property set of attributes. Typically set by the layer or element during draw.
placement	enumeration Anchor	The placement anchor of the graphic.

CIMTextGraphic

Property	Type	Description
text	string	The text string of the text graphic.
shape	Geometry	The geometry of the text graphic.
leaders	[CIMLeader]	A collection of leaders coming off of the graphic.

CIMParagraphTextGraphic

Property	Type	Description
frame	CIMGraphicFrame	The graphic frame of the paragraph text graphic.
columnCount	long	Number of columns in the paragraph text graphic.
columnGap	double	The gap between columns.
margin	double	The margin of the paragraph text graphic.

CIMPictureGraphic

Represents a picture graphic.

CIMGraphic

Property	Type	Description
symbol	CIMSymbolReference	The symbol for the graphic.
transparency	double	The transparency of the graphic as a percentage. Typically set by the layer or element during draw, but not persisted. Change the transparency of layers in the symbol for persistent changes.
blendingMode	enumeration BlendingMode	The blending mode of the graphic. Typically set by the layer or element during draw.
masks	[{JSON_object}]	An array of masks for the graphic. Set by the layer or element during draw, but not persisted in the project. The per-feature masks which defines an area where the CIMGraphic should NOT draw. Every element in the array should support be a Polygon.
referenceScale	double	The reference scale of the graphic. Typically set by the layer or element during draw.
attributes	{JSON_object}	A property set of attributes. Typically set by the layer or element during draw.
placement	enumeration Anchor	The placement anchor of the graphic.

CIMPictureGraphic

Property	Type	Description
pictureURL	string	The URL of the picture graphic. Typically a base64 encoded representation of the picture.
box	Envelope	The bounding box of the picture graphic.
frame	CIMGraphicFrame	The graphic frame of the picture graphic.
sourceURL	string	The source URL of the picture graphic. Typically the source of the image copied into the PictureURL.
referenceURI	string	The URI of the binary reference containing the picture data.
shape	Geometry	The shape of the picture graphic.

CIMPointGraphic

Represents a point graphic.

CIMGraphic

Property	Type	Description
symbol	CIMSymbolReference	The symbol for the graphic.
transparency	double	The transparency of the graphic as a percentage. Typically set by the layer or element during draw, but not persisted. Change the transparency of layers in the symbol for persistent changes.
blendingMode	enumeration BlendingMode	The blending mode of the graphic. Typically set by the layer or element during draw.
masks	[{JSON_object}]	An array of masks for the graphic. Set by the layer or element during draw, but not persisted in the project. The per-feature masks which defines an area where the CIMGraphic should NOT draw. Every element in the array should support be a Polygon.
referenceScale	double	The reference scale of the graphic. Typically set by the layer or element during draw.
attributes	{JSON_object}	A property set of attributes. Typically set by the layer or element during draw.
placement	enumeration Anchor	The placement anchor of the graphic.

CIMShapeGraphic

Property	Type	Description
name	string	The name.
popupHtmlText	string	The pop-up HTML text.

CIMPointGraphic

Property	Type	Description
location	Point	The location of the point graphic.
leaders	[CIMLeader]	A collection of leaders coming off of the graphic.

CIMPolygonGraphic

Represents a polygon graphic.

CIMGraphic

Property	Type	Description
symbol	CIMSymbolReference	The symbol for the graphic.
transparency	double	The transparency of the graphic as a percentage. Typically set by the layer or element during draw, but not persisted. Change the transparency of layers in the symbol for persistent changes.
blendingMode	enumeration BlendingMode	The blending mode of the graphic. Typically set by the layer or element during draw.
masks	[{JSON_object}]	An array of masks for the graphic. Set by the layer or element during draw, but not persisted in the project. The per-feature masks which defines an area where the CIMGraphic should NOT draw. Every element in the array should support be a Polygon.
referenceScale	double	The reference scale of the graphic. Typically set by the layer or element during draw.
attributes	{JSON_object}	A property set of attributes. Typically set by the layer or element during draw.
placement	enumeration Anchor	The placement anchor of the graphic.

CIMShapeGraphic

Property	Type	Description
name	string	The name.
popupHtmlText	string	The pop-up HTML text.

CIMPolygonGraphic

Property	Type	Description
polygon	Polygon	The polygon of the polygon graphic.

CIMTextGraphic

Represents a text graphic.

CIMGraphic

Property	Type	Description
symbol	CIMSymbolReference	The symbol for the graphic.
transparency	double	The transparency of the graphic as a percentage. Typically set by the layer or element during draw, but not persisted. Change the transparency of layers in the symbol for persistent changes.
blendingMode	enumeration BlendingMode	The blending mode of the graphic. Typically set by the layer or element during draw.
masks	[{JSON_object}]	An array of masks for the graphic. Set by the layer or element during draw, but not persisted in the project. The per-feature masks which defines an area where the CIMGraphic should NOT draw. Every element in the array should support be a Polygon.
referenceScale	double	The reference scale of the graphic. Typically set by the layer or element during draw.
attributes	{JSON_object}	A property set of attributes. Typically set by the layer or element during draw.
placement	enumeration Anchor	The placement anchor of the graphic.

CIMTextGraphic

Property	Type	Description
text	string	The text string of the text graphic.
shape	Geometry	The geometry of the text graphic.
leaders	[CIMLeader]	A collection of leaders coming off of the graphic.