Class CIMMaplexLabelPlacementProperties
Represents Maplex label placement properties.
public class CIMMaplexLabelPlacementProperties : CIMLabelPlacementProperties
- Inheritance
-
CIMMaplexLabelPlacementProperties
- Inherited Members
Constructors
CIMMaplexLabelPlacementProperties()
public CIMMaplexLabelPlacementProperties()
Properties
AlignLabelToLineDirection
Gets or sets a value indicating whether to align the label with the label direction so the label may appear upside down.
public bool AlignLabelToLineDirection { get; set; }
Property Value
AllowAsymmetricOverrun
Gets or sets a value indicating whether a label may overrun one side of a polygon feature.
public bool AllowAsymmetricOverrun { get; set; }
Property Value
AllowStraddleStacking
Gets or sets a value indicating whether a stacked label may straddle the line feature.
public bool AllowStraddleStacking { get; set; }
Property Value
AlternateLabelExpressionInfo
Gets or sets the ExpressionInfo for the alternate label expression.
public CIMExpressionInfo AlternateLabelExpressionInfo { get; set; }
Property Value
AvoidOverlappingLabeledPolygonsAsIfHoles
Gets or sets a value indicating whether labels should avoid overlapping labeled polygons as if they were holes.
public bool AvoidOverlappingLabeledPolygonsAsIfHoles { get; set; }
Property Value
AvoidPolygonHoles
Gets or sets a value indicating whether labels should avoid holes in polygons.
public bool AvoidPolygonHoles { get; set; }
Property Value
BackgroundLabel
Gets or sets a value indicating whether to place the label first and allow other labels to be placed over it.
public bool BackgroundLabel { get; set; }
Property Value
BoundaryLabelingAllowHoles
Gets or sets a value indicating whether to allow holes in boundary labeling.
public bool BoundaryLabelingAllowHoles { get; set; }
Property Value
BoundaryLabelingAllowSingleSided
Gets or sets a value indicating whether to allow single sided boundary labeling.
public bool BoundaryLabelingAllowSingleSided { get; set; }
Property Value
BoundaryLabelingSingleSidedOnLine
Gets or sets a value indicating whether single sided boundary label is centered on line.
public bool BoundaryLabelingSingleSidedOnLine { get; set; }
Property Value
CanAbbreviateLabel
Gets or sets a value indicating whether to abbreviate the label using an abbreviation dictionary.
public bool CanAbbreviateLabel { get; set; }
Property Value
CanFlipStackedStreetLabel
Gets or sets a value indicating whether a stacked label may be flipped over to obtain a better position.
public bool CanFlipStackedStreetLabel { get; set; }
Property Value
CanKeyNumberLabel
Gets or sets a value indicating whether to key number the label and feature.
public bool CanKeyNumberLabel { get; set; }
Property Value
CanOverrunFeature
Gets or sets a value indicating whether to place the label over end of line or over polygon boundary.
public bool CanOverrunFeature { get; set; }
Property Value
CanPlaceLabelOnTopOfFeature
Gets or sets a value indicating whether the label can be placed on top of the street feature.
public bool CanPlaceLabelOnTopOfFeature { get; set; }
Property Value
CanPlaceLabelOutsidePolygon
Gets or sets a value indicating whether to place a label outside the polygon if it does not fit inside.
public bool CanPlaceLabelOutsidePolygon { get; set; }
Property Value
CanReduceFontSize
Gets or sets a value indicating whether to reduce the size of the font.
public bool CanReduceFontSize { get; set; }
Property Value
CanReduceLeading
Gets or sets a value indicating whether the leading can be reduced for a stacked label.
public bool CanReduceLeading { get; set; }
Property Value
CanRemoveOverlappingLabel
Gets or sets a value indicating whether to remove the label if it overlaps with other labels.
public bool CanRemoveOverlappingLabel { get; set; }
Property Value
CanShiftPointLabel
Gets or sets a value indicating whether to allow the point label to be shifted upon a fixed position.
public bool CanShiftPointLabel { get; set; }
Property Value
CanStackLabel
Gets or sets a value indicating whether to stack the label to obtain a better position.
public bool CanStackLabel { get; set; }
Property Value
CanTruncateLabel
Gets or sets a value indicating whether to truncate the label using an algorithm.
public bool CanTruncateLabel { get; set; }
Property Value
CanUseAlternateLabelExpression
Gets or sets a value indicating whether an alternate label expression is allowed to be used.
public bool CanUseAlternateLabelExpression { get; set; }
Property Value
CenterLabelAnchorType
Gets or sets options to determine where to anchor a centered point label.
public MaplexCenterLabelAnchorType CenterLabelAnchorType { get; set; }
Property Value
ConnectionType
Gets or sets the options for connecting line features.
public MaplexConnectionType ConnectionType { get; set; }
Property Value
ConstrainOffset
Gets or sets the label constraint options.
public MaplexConstrainOffset ConstrainOffset { get; set; }
Property Value
ContourAlignmentType
Gets or sets the options for the contour label alignment.
public MaplexContourAlignmentType ContourAlignmentType { get; set; }
Property Value
ContourLadderType
Gets or sets the options for the contour label ladder types.
public MaplexContourLadderType ContourLadderType { get; set; }
Property Value
ContourMaximumAngle
Gets or sets the maximum angle at which a contour label may be placed.
public int ContourMaximumAngle { get; set; }
Property Value
DictionaryName
Gets or sets the name of the abbreviations dictionary referenced by this layer.
public string DictionaryName { get; set; }
Property Value
EnableConnection
Gets or sets a value indicating whether to turn off line connection.
public bool EnableConnection { get; set; }
Property Value
EnablePointPlacementPriorities
Gets or sets a value indicating whether to use user-defined point placement priorities.
public bool EnablePointPlacementPriorities { get; set; }
Property Value
EnablePolygonFixedPosition
Gets or sets a value indicating whether a label is to be placed at a fixed position in the polygon.
public bool EnablePolygonFixedPosition { get; set; }
Property Value
EnableSecondaryOffset
Gets or sets a value indicating whether to place a label at a secondary offset from the line feature.
public bool EnableSecondaryOffset { get; set; }
Property Value
FeatureWeight
Gets or sets the feature weight which controls which features may be overlapped and to what extent.
public int FeatureWeight { get; set; }
Property Value
FontHeightReductionLimit
Gets or sets font height reduction limit. The font may be reduced in height until this limit is reached.
public double FontHeightReductionLimit { get; set; }
Property Value
FontHeightReductionStep
Gets or sets font height reduction step. This is the step interval for font height reduction.
public double FontHeightReductionStep { get; set; }
Property Value
FontWidthReductionLimit
Gets or sets font width reduction limit. The font may be reduced in width until this limit is reached.
public double FontWidthReductionLimit { get; set; }
Property Value
FontWidthReductionStep
Gets or sets font width reduction step. This is the step interval for font width reduction.
public double FontWidthReductionStep { get; set; }
Property Value
GraticuleAlignment
Gets or sets a value indicating whether to enable graticule alignment.
public bool GraticuleAlignment { get; set; }
Property Value
GraticuleAlignmentType
Gets or sets the options for the graticule alignment type.
public MaplexGraticuleAlignmentType GraticuleAlignmentType { get; set; }
Property Value
IsLabelBufferHardConstraint
Gets or sets a value indicating whether the label buffer is a hard constraint and must be honored.
public bool IsLabelBufferHardConstraint { get; set; }
Property Value
IsMinimumSizeBasedOnArea
Gets or sets a value indicating whether the minimum feature size for labeling is based on area.
public bool IsMinimumSizeBasedOnArea { get; set; }
Property Value
IsOffsetFromFeatureGeometry
Gets or sets a value indicating whether to measure the label offset from the feature geometry.
public bool IsOffsetFromFeatureGeometry { get; set; }
Property Value
KeyNumberGroupName
Gets or sets the name of the key number group to use for key numbering the labels.
public string KeyNumberGroupName { get; set; }
Property Value
LabelBuffer
Gets or sets the label buffer. Increase buffer to stop labels from being placed too close to each other.
public int LabelBuffer { get; set; }
Property Value
LabelLargestPolygon
Gets or sets a value indicating whether to label only the largest polygon in a compound polygon feature.
public bool LabelLargestPolygon { get; set; }
Property Value
LabelPriority
Gets or sets the label priority. Label priority controls approximate placement order.
public int LabelPriority { get; set; }
Property Value
LabelStackingProperties
Gets or sets the label stacking properties for a layer.
public CIMMaplexLabelStackingProperties LabelStackingProperties { get; set; }
Property Value
LineFeatureType
Gets or sets the line feature type.
public MaplexLineFeatureType LineFeatureType { get; set; }
Property Value
LinePlacementMethod
Gets or sets the line placement method.
public MaplexLinePlacementMethod LinePlacementMethod { get; set; }
Property Value
MaximumCharacterSpacing
Gets or sets the maximum character spacing. Character spacing may be increased up to this limit.
public double MaximumCharacterSpacing { get; set; }
Property Value
MaximumLabelOverrun
Gets or sets the maximum distance that a label is allowed to overrun the end of its feature.
public double MaximumLabelOverrun { get; set; }
Property Value
MaximumLabelOverrunUnit
Gets or sets the label overrun unit.
public MaplexUnit MaximumLabelOverrunUnit { get; set; }
Property Value
MaximumWordSpacing
Gets or sets maximum word spacing. The word spacing may be increased up to this limit.
public double MaximumWordSpacing { get; set; }
Property Value
MeasureFromClippedFeatureGeometry
Gets or sets a value indicating whether or not to measure the offset from the clipped feature geometry. This property applies to label offsets when using the Along Line or Fixed Position Polygon placement methods.
public bool MeasureFromClippedFeatureGeometry { get; set; }
Property Value
MinimumEndOfStreetClearance
Gets or sets minimum clearance between street label and street end.
public double MinimumEndOfStreetClearance { get; set; }
Property Value
MinimumFeatureSizeUnit
Gets or sets minimum feature size unit.
public MaplexUnit MinimumFeatureSizeUnit { get; set; }
Property Value
MinimumRepetitionInterval
Gets or sets the interval that must elapse before label is repeated.
public double MinimumRepetitionInterval { get; set; }
Property Value
MinimumSizeForLabeling
Gets or sets the minimum size of a line or area feature for it to be labeled.
public double MinimumSizeForLabeling { get; set; }
Property Value
MultiPartOption
Gets or sets the option for labeling multi-part shapes.
public MaplexMultiPartOption MultiPartOption { get; set; }
Property Value
NeverRemoveLabel
Gets or sets a value indicating whether to not remove the label if no position is found.
public bool NeverRemoveLabel { get; set; }
Property Value
OffsetAlongLineProperties
Gets or sets the offset along line properties for a layer.
public CIMMaplexOffsetAlongLineProperties OffsetAlongLineProperties { get; set; }
Property Value
PointExternalZonePriorities
Gets or sets the properties which control placement of a label around point feature.
public CIMMaplexExternalZonePriorities PointExternalZonePriorities { get; set; }
Property Value
PointPlacementMethod
Gets or sets the point placement method.
public MaplexPointPlacementMethod PointPlacementMethod { get; set; }
Property Value
PolygonAnchorPointPerimeterInset
Gets or sets the inset value for perimeter polygon anchor leader anchor points.
public double PolygonAnchorPointPerimeterInset { get; set; }
Property Value
PolygonAnchorPointPerimeterInsetUnit
Gets or sets the unit of the inset value for perimeter polygon anchor points.
public MaplexUnit PolygonAnchorPointPerimeterInsetUnit { get; set; }
Property Value
PolygonAnchorPointType
Gets or sets the polygon anchor point type.
public MaplexAnchorPointType PolygonAnchorPointType { get; set; }
Property Value
PolygonBoundaryWeight
Gets or sets the feature weight for the boundary of the polygon.
public int PolygonBoundaryWeight { get; set; }
Property Value
PolygonExternalZones
Gets or sets the placement priorities associated with zones external to the polygon.
public CIMMaplexExternalZonePriorities PolygonExternalZones { get; set; }
Property Value
PolygonFeatureType
Gets or sets the polygon feature type.
public MaplexPolygonFeatureType PolygonFeatureType { get; set; }
Property Value
PolygonInternalZones
Gets or sets the placement priorities associated with zones internal to the polygon.
public CIMMaplexInternalZonePriorities PolygonInternalZones { get; set; }
Property Value
PolygonPlacementMethod
Gets or sets the polygon placement method.
public MaplexPolygonPlacementMethod PolygonPlacementMethod { get; set; }
Property Value
PreferHorizontalPlacement
Gets or sets a value indicating whether there is a preference to place the label horizontally.
public bool PreferHorizontalPlacement { get; set; }
Property Value
PreferLabelNearJunction
Gets or sets a value indicating whether there is a preference for placing a line label near a junction.
public bool PreferLabelNearJunction { get; set; }
Property Value
PreferLabelNearJunctionClearance
Gets or sets the preferred clearance for placing a line label near a junction.
public double PreferLabelNearJunctionClearance { get; set; }
Property Value
PreferLabelNearMapBorder
Gets or sets a value indicating whether there is a preference for placing a line label near the map border.
public bool PreferLabelNearMapBorder { get; set; }
Property Value
PreferLabelNearMapBorderClearance
Gets or sets the preferred clearance for placing a line label near the map border.
public double PreferLabelNearMapBorderClearance { get; set; }
Property Value
PreferredEndOfStreetClearance
Gets or sets the preferred clearance between street label and street end.
public double PreferredEndOfStreetClearance { get; set; }
Property Value
PrimaryOffset
Gets or sets the primary offset between label and symbol.
public double PrimaryOffset { get; set; }
Property Value
PrimaryOffsetUnit
Gets or sets the unit of the primary offset.
public MaplexUnit PrimaryOffsetUnit { get; set; }
Property Value
RemoveAmbiguousLabels
Gets or sets the method to determine when to remove ambiguous labels.
public MaplexRemoveAmbiguousLabelsType RemoveAmbiguousLabels { get; set; }
Property Value
RemoveExtraLineBreaks
Gets or sets a value indicating whether extra line breaks are removed from the label text.
public bool RemoveExtraLineBreaks { get; set; }
Property Value
RemoveExtraWhiteSpace
Gets or sets a value indicating whether extra white space characters are removed from the label text.
public bool RemoveExtraWhiteSpace { get; set; }
Property Value
RepeatLabel
Gets or sets a value indicating whether to enable the repetition of label along line feature.
public bool RepeatLabel { get; set; }
Property Value
RepetitionIntervalUnit
Gets or sets the label repetition interval unit.
public MaplexUnit RepetitionIntervalUnit { get; set; }
Property Value
RotationProperties
Gets or sets the label rotation properties.
public CIMMaplexRotationProperties RotationProperties { get; set; }
Property Value
SecondaryOffset
Gets or sets the secondary offset between label and symbol.
public double SecondaryOffset { get; set; }
Property Value
SecondaryOffsetMaximum
Gets or sets the secondary offset maximum.
public double SecondaryOffsetMaximum { get; set; }
Property Value
SecondaryOffsetMinimum
Gets or sets the secondary offset minimum.
public double SecondaryOffsetMinimum { get; set; }
Property Value
SecondaryOffsetUnit
Gets or sets the unit of the secondary offset.
public MaplexUnit SecondaryOffsetUnit { get; set; }
Property Value
SpreadCharacters
Gets or sets a value indicating whether to spread label characters along line features.
public bool SpreadCharacters { get; set; }
Property Value
SpreadWords
Gets or sets a value indicating whether to whether to spread words along line features.
public bool SpreadWords { get; set; }
Property Value
StrategyPriorities
Gets or sets the priority of a placement strategy when placing text.
public CIMMaplexStrategyPriorities StrategyPriorities { get; set; }
Property Value
ThinDuplicateLabels
Gets or sets a value indicating whether to remove duplicate labels that lie within a specified distance of each other.
public bool ThinDuplicateLabels { get; set; }
Property Value
ThinningDistance
Gets or sets the distance used to control the thinning of duplicate labels.
public double ThinningDistance { get; set; }
Property Value
ThinningDistanceUnit
Gets or sets the thinning distance unit.
public MaplexUnit ThinningDistanceUnit { get; set; }
Property Value
TruncationExcludedCharacters
Gets or sets the excluded characters used by the truncation strategy. These characters will never be removed by truncation.
public string TruncationExcludedCharacters { get; set; }
Property Value
TruncationMarkerCharacter
Gets or sets the marker character used by the truncation strategy.
public string TruncationMarkerCharacter { get; set; }
Property Value
TruncationMinimumLength
Gets or sets the minimum length of a label used by the truncation strategy.
public int TruncationMinimumLength { get; set; }
Property Value
TruncationPreferredCharacters
Gets or sets the preferred characters used by the truncation strategy. These characters will be removed as needed.
public string TruncationPreferredCharacters { get; set; }
Property Value
UseExactSymbolOutline
Gets or sets a value indicating whether to use the exact polygon outline of a symbol when measuring the label offset.
public bool UseExactSymbolOutline { get; set; }
Property Value
Methods
FromJson(string, JsonDeserializationSettings)
Reconstructs the CIMMaplexLabelPlacementProperties with a specified state from a JSON encoding.
public static CIMMaplexLabelPlacementProperties FromJson(string json, JsonDeserializationSettings settings = null)
Parameters
jsonstringThe JSON string containing the CIMMaplexLabelPlacementProperties state.
settingsJsonDeserializationSettingsThe JSON deserialization settings.
Returns
ToJson(JsonSerializationSettings)
Creates a JSON encoding of the CIMMaplexLabelPlacementProperties and its current state.
public override string ToJson(JsonSerializationSettings settings = null)
Parameters
settingsJsonSerializationSettingsThe JSON serialization settings.