Class CIMCharacterMarker
Represents a character marker.
public class CIMCharacterMarker : CIMMarker
- Inheritance
-
CIMCharacterMarker
- Inherited Members
Remarks
The shape of a marker is defined by a glyph in a font. The marker is drawn using the specified size and color. Each marker has a defined frame around the glyph that is considered when the size is applied. As a result, character markers of the same size may appear different sizes if the glyphs frames are different sizes.
Constructors
CIMCharacterMarker()
public CIMCharacterMarker()
Properties
CharacterIndex
Gets or sets the Unicode decimal value for the individual glyph of the font that defines the shape of the marker.
public int CharacterIndex { get; set; }
Property Value
Depth3D
Gets or sets the depth of the marker when drawn in 3D.
public double Depth3D { get; set; }
Property Value
FontFamilyName
Gets or sets the font family name of the font. e.g. Comic Sans.
public string FontFamilyName { get; set; }
Property Value
FontStyleName
Gets or sets the style name for the font family. e.g. Regular, Bold, or Italic.
public string FontStyleName { get; set; }
Property Value
FontType
Gets or sets the font type.
public FontType FontType { get; set; }
Property Value
FontVariationSettings
Gets or sets an array of CIM font variation objects, describing a particular instance of a variable font through the font axis tags and their values. The number of CIM font variations will correspond to the number of variation axes specified by the font. This is only used for variable fonts.
public CIMFontVariation[] FontVariationSettings { get; set; }
Property Value
RespectFrame
Gets or sets a value indicating whether the frame of the character marker should be honored when transforming the marker.
public bool RespectFrame { get; set; }
Property Value
ScaleSymbolsProportionally
Gets or sets a value indicating whether the strokes and/or fills of a marker are scaled proportionally when the symbol size is changed.
public bool ScaleSymbolsProportionally { get; set; }
Property Value
Remarks
When enabled, the strokes for the outline or fill of the polygon symbol used to draw the marker will be scaled proportionally with changes to the symbol size. If this property is not enabled, the stroke will draw with the specified width regardless of the marker size.
ScaleX
Gets or sets the width of the symbol without changing the height (or depth in 3D), as a ratio.
public double ScaleX { get; set; }
Property Value
Symbol
Gets or sets the polygon symbol that is used to renderer the marker.
public CIMPolygonSymbol Symbol { get; set; }
Property Value
VerticalOrientation3D
Gets or sets a value indicating whether the marker stands a marker upright as though locked in place. The marker can be viewed from all angles.
public bool VerticalOrientation3D { get; set; }
Property Value
Methods
FromJson(string, JsonDeserializationSettings)
Reconstructs the CIMCharacterMarker with a specified state from a JSON encoding.
public static CIMCharacterMarker FromJson(string json, JsonDeserializationSettings settings = null)
Parameters
jsonstringThe JSON string containing the CIMCharacterMarker state.
settingsJsonDeserializationSettingsThe JSON deserialization settings.
Returns
ToJson(JsonSerializationSettings)
Creates a JSON encoding of the CIMCharacterMarker and its current state.
public override string ToJson(JsonSerializationSettings settings = null)
Parameters
settingsJsonSerializationSettingsThe JSON serialization settings.