CIMLegend Class—ArcGIS Pro

CIMLegend Class Properties

In This Topic

For a list of all members of this type, see CIMLegend members.

Public Properties

	Name	Description
	Anchor	Gets or sets the anchor position of the element. (Inherited from ArcGIS.Core.CIM.CIMElement)
	AutoAdd	Gets or sets a value indicating whether items should automatically be added to the legend.
	AutoFonts	Gets or sets a value indicating whether legend fonts should automatically be sized.
	AutoReorder	Gets or sets a value indicating whether the items should automatically be ordered when added.
	AutoVisibility	Gets or sets a value indicating whether the items should display when not in the visible extent.
	BalanceColumns	Gets or sets a value indicating whether to balance the columns or simply "pour" the text into each column.
	ClassGap	Gets or sets the gap between classes. Units in points.
	Columns	Gets or sets the number of legend columns when either of the following fitting strategies is in ///effect: SpecifyColumnsAndAdjustFrame or SpecifyColumnsAndAdjustSize.
	CustomProperties	Gets or sets the custom properties of the element. (Inherited from ArcGIS.Core.CIM.CIMElement)
	DefaultLegendItem	Gets or sets the default legend item used as the basis for new legend item creation.
	DefaultPatchHeight	Gets or sets an items default patch height. Units in points.
	DefaultPatchWidth	Gets or sets an items default patch width. Units in points.
	DescriptionWidth	Gets or sets the description width threshold. Units in points.
	ExcludedLayers	Gets or sets a collection of layer URIs from the associated map that are explicitly excluded from the legend.
	Expanded	Gets or sets a value indicating whether this element is expanded in the contents pane. (Inherited from ArcGIS.Core.CIM.CIMElement)
	FeatureCountPrefix	Gets or sets the feature count prefix. Deprecated in 1.4. Use count prefix in legend item instead.
	FeatureCountSuffix	Gets or sets the feature count suffix. Deprecated in 1.4. Use count suffix in legend item instead.
	FittingStrategy	Gets or sets the legends fitting strategy.
	Frame	Gets or sets the geometry of a frame for an element. (Inherited from ArcGIS.Core.CIM.CIMFrameElement)
	GraphicFrame	Gets or sets the graphic symbology of an element's frame. (Inherited from ArcGIS.Core.CIM.CIMFrameElement)
	GroupGap	Gets or sets the gap between groups. Units in points.
	GroupLayerNameGap	Gets or sets the gap following the group layer name.
	HeadingGap	Gets or sets the heading gap. Units in points.
	HorizontalItemGap	Gets or sets the gap between horizontal items. Units in points.
	ItemGap	Gets or sets the gap between items. Units in points,.
	Items	Gets or sets a collection of items in a layout.
	LabelWidth	Gets or sets the label width. Units in points.
	LayerNameGap	Gets or sets the layer name gap. Units in points.
	Locked	Gets or sets a 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. (Inherited from ArcGIS.Core.CIM.CIMElement)
	LockedAspectRatio	Gets or sets a value indicating whether the aspect ratio for an element is locked. If locked, the width and height values stretch proportionally. (Inherited from ArcGIS.Core.CIM.CIMElement)
	MakeColumnsSameWidth	Gets or sets a value indicating whether to ensure all the columns are the same width.
	MapFrame	Gets or sets the map frame associated with the map surround. (Inherited from ArcGIS.Core.CIM.CIMMapSurround)
	MaxScale	Gets or sets the maximum scale. (Inherited from ArcGIS.Core.CIM.CIMMapSurround)
	MinFontSize	Gets or sets the minimum font size. Units in points.
	MinScale	Gets or sets the minimum scale. (Inherited from ArcGIS.Core.CIM.CIMMapSurround)
	Name	Gets or sets the name of the element. (Inherited from ArcGIS.Core.CIM.CIMElement)
	PatchGap	Gets or sets the gap between patches. Units in points.
	RightToLeft	Gets or sets a value indicating whether right to left orientation should be applied.
	Rotation	Gets or sets the rotation of the element. (Inherited from ArcGIS.Core.CIM.CIMElement)
	RotationCenter	Gets or sets the location of the anchor in page units.This is also the location the feature is rotated around. (Inherited from ArcGIS.Core.CIM.CIMElement)
	ScaleSymbols	Gets or sets a value indicating whether symbols should be scaled.
	ShowTitle	Gets or sets a value indicating whether the legend title should be displayed.
	TextGap	Gets or sets the gap between text. Units in points.
	Title	Gets or sets the title for the legend.
	TitleGap	Gets or sets the title gap. Units in points.
	TitleSymbol	Gets or sets the symbol for the title.
	Visible	Gets or sets a value indicating whether the element is visible. (Inherited from ArcGIS.Core.CIM.CIMElement)

Top

Reference

CIMLegend Class
ArcGIS.Core.CIM Namespace

Send feedback