Class CIMLabelClass
Represents a label class which describes how to generate a set of text labels from a group of features in a feature layer.
public class CIMLabelClass : CIMObject
- Inheritance
-
CIMLabelClass
- Inherited Members
Constructors
CIMLabelClass()
public CIMLabelClass()
Properties
Expression
Gets or sets the label expression.
public string Expression { get; set; }
Property Value
ExpressionEngine
Gets or sets the label expression engine (the language the expression is written in).
public LabelExpressionEngine ExpressionEngine { get; set; }
Property Value
ExpressionTitle
Gets or sets the human readable text title that describes the label expression.
public string ExpressionTitle { get; set; }
Property Value
FeaturesToLabel
Gets or sets a parameter indicating which features to label.
public FeaturesToLabel FeaturesToLabel { get; set; }
Property Value
ID
Gets or sets the ID of the label class. This property is only used in the context of annotation.
public int ID { get; set; }
Property Value
MaplexLabelPlacementProperties
Gets or sets the Maplex placement properties which are used when the map uses the Maplex label engine.
public CIMMaplexLabelPlacementProperties MaplexLabelPlacementProperties { get; set; }
Property Value
MaximumScale
Gets or sets the maximum scale for labeling (set as the denominator of the scale's representative fraction).
public double MaximumScale { get; set; }
Property Value
MinimumScale
Gets or sets the minimum scale for labeling (set as the denominator of the scale's representative fraction).
public double MinimumScale { get; set; }
Property Value
Name
Gets or sets the name of the label class.
public string Name { get; set; }
Property Value
Priority
Gets or sets the priority of the label class.
public int Priority { get; set; }
Property Value
StandardLabelPlacementProperties
Gets or sets the standard placement properties which are used when the map uses the standard label engine.
public CIMStandardLabelPlacementProperties StandardLabelPlacementProperties { get; set; }
Property Value
TextSymbol
Gets or sets the text symbol of the label class.
public CIMSymbolReference TextSymbol { get; set; }
Property Value
UseCodedValue
Gets or sets a value indicating whether or not to use coded value domain descriptions when labeling.
public bool UseCodedValue { get; set; }
Property Value
Visibility
Gets or sets a value indicating whether this label class is visible.
public bool Visibility { get; set; }
Property Value
WhereClause
Gets or sets the SQL where clause of which features to label with this label class.
public string WhereClause { get; set; }
Property Value
Methods
FromJson(string, JsonDeserializationSettings)
Reconstructs the CIMLabelClass with a specified state from a JSON encoding.
public static CIMLabelClass FromJson(string json, JsonDeserializationSettings settings = null)
Parameters
jsonstringThe JSON string containing the CIMLabelClass state.
settingsJsonDeserializationSettingsThe JSON deserialization settings.
Returns
ToJson(JsonSerializationSettings)
Creates a JSON encoding of the CIMLabelClass and its current state.
public override string ToJson(JsonSerializationSettings settings = null)
Parameters
settingsJsonSerializationSettingsThe JSON serialization settings.