CIMCharacterMarker (ArcObjects Java API)

java.lang.Object
- com.esri.arcgis.cartox.cim.CIMObject
- - com.esri.arcgis.cartox.cim.CIMSymbolLayer
  - - com.esri.arcgis.cartox.cim.CIMMarker
    - - com.esri.arcgis.cartox.cim.CIMCharacterMarker

public class CIMCharacterMarker
extends CIMMarker

Represents a character marker.

Constructor Summary

Constructors
Constructor and Description

CIMCharacterMarker()

Constructors
Constructor and Description
`CIMCharacterMarker()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deserialize(JSONObject jsonObject)` Deserializes this object from its JSON representation.
`static CIMCharacterMarker`	`fromJSON(java.lang.String json)` Creates the object with a specified state from a JSON encoding.
`int`	`getCharacterIndex()` Gets the Unicode decimal value for the individual glyph of the font that defines the shape of the marker.
`double`	`getDepth3D()` Gets the depth of the marker when drawn in 3D.
`java.lang.String`	`getFontFamilyName()` Gets the font family name of the font.
`java.lang.String`	`getFontStyleName()` Gets the style name for the font family.
`FontType`	`getFontType()` Gets the font type.
`CIMFontVariation[]`	`getFontVariationSettings()` Gets an array of CIM font variation objects, describing a particular instance of a variable font through the font axis tags and their values.
`boolean`	`getRespectFrame()` Gets a value indicating whether the frame of the character marker should be honored when transforming the marker.
`boolean`	`getScaleSymbolsProportionally()` Gets a value indicating whether the strokes and/or fills of a marker are scaled proportionally when the symbol size is changed.
`double`	`getScaleX()` Gets the width of the symbol without changing the height (or depth in 3D), as a ratio.
`CIMPolygonSymbol`	`getSymbol()` Gets the polygon symbol that is used to renderer the marker.
`boolean`	`getVerticalOrientation3D()` Gets a value indicating whether the marker stands a marker upright as though locked in place.
`void`	`serialize(JSONObject jsonObject)` Serializes this object to its JSON representation.
`void`	`setCharacterIndex(int characterIndex)` Sets the Unicode decimal value for the individual glyph of the font that defines the shape of the marker.
`void`	`setDepth3D(double depth3D)` Sets the depth of the marker when drawn in 3D.
`void`	`setFontFamilyName(java.lang.String fontFamilyName)` Sets the font family name of the font.
`void`	`setFontStyleName(java.lang.String fontStyleName)` Sets the style name for the font family.
`void`	`setFontType(FontType fontType)` Sets the font type.
`void`	`setFontVariationSettings(CIMFontVariation[] fontVariationSettings)` Sets an array of CIM font variation objects, describing a particular instance of a variable font through the font axis tags and their values.
`void`	`setRespectFrame(boolean respectFrame)` Sets a value indicating whether the frame of the character marker should be honored when transforming the marker.
`void`	`setScaleSymbolsProportionally(boolean scaleSymbolsProportionally)` Sets a value indicating whether the strokes and/or fills of a marker are scaled proportionally when the symbol size is changed.
`void`	`setScaleX(double scaleX)` Sets the width of the symbol without changing the height (or depth in 3D), as a ratio.
`void`	`setSymbol(CIMPolygonSymbol symbol)` Sets the polygon symbol that is used to renderer the marker.
`void`	`setVerticalOrientation3D(boolean verticalOrientation3D)` Sets a value indicating whether the marker stands a marker upright as though locked in place.
`java.lang.String`	`toJSON()` Creates a JSON encoding of the object and its current state.

Methods inherited from class com.esri.arcgis.cartox.cim.CIMMarker
getAnchorPoint, getAnchorPointUnits, getAngleX, getAngleY, getBillboardMode3D, getDominantSizeAxis3D, getMarkerPlacement, getOffsetX, getOffsetY, getOffsetZ, getRotateClockwise, getRotation, getSize, setAnchorPoint, setAnchorPointUnits, setAngleX, setAngleY, setBillboardMode3D, setDominantSizeAxis3D, setMarkerPlacement, setOffsetX, setOffsetY, setOffsetZ, setRotateClockwise, setRotation, setSize

Methods inherited from class com.esri.arcgis.cartox.cim.CIMSymbolLayer
getAnimations, getColorLocked, getEffects, getEnable, getName, getOverprint, getPrimitiveName, setAnimations, setColorLocked, setEffects, setEnable, setName, setOverprint, setPrimitiveName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CIMCharacterMarker
```
public CIMCharacterMarker()
```
- Method Detail
  - getCharacterIndex
```
public int getCharacterIndex()
```
    Gets the Unicode decimal value for the individual glyph of the font that defines the shape of the marker.
  - setCharacterIndex
```
public void setCharacterIndex(int characterIndex)
```
    Sets the Unicode decimal value for the individual glyph of the font that defines the shape of the marker.
  - getDepth3D
```
public double getDepth3D()
```
    Gets the depth of the marker when drawn in 3D.
  - setDepth3D
```
public void setDepth3D(double depth3D)
```
    Sets the depth of the marker when drawn in 3D.
  - getFontFamilyName
```
public java.lang.String getFontFamilyName()
```
    Gets the font family name of the font. e.g. Comic Sans.
  - setFontFamilyName
```
public void setFontFamilyName(java.lang.String fontFamilyName)
```
    Sets the font family name of the font. e.g. Comic Sans.
  - getFontStyleName
```
public java.lang.String getFontStyleName()
```
    Gets the style name for the font family. e.g. Regular, Bold, or Italic.
  - setFontStyleName
```
public void setFontStyleName(java.lang.String fontStyleName)
```
    Sets the style name for the font family. e.g. Regular, Bold, or Italic.
  - getFontType
```
public FontType getFontType()
```
    Gets the font type.
  - setFontType
```
public void setFontType(FontType fontType)
```
    Sets the font type.
  - getFontVariationSettings
```
public CIMFontVariation[] getFontVariationSettings()
```
    Gets 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.
  - setFontVariationSettings
```
public void setFontVariationSettings(CIMFontVariation[] fontVariationSettings)
```
    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.
  - getScaleX
```
public double getScaleX()
```
    Gets the width of the symbol without changing the height (or depth in 3D), as a ratio.
  - setScaleX
```
public void setScaleX(double scaleX)
```
    Sets the width of the symbol without changing the height (or depth in 3D), as a ratio.
  - getSymbol
```
public CIMPolygonSymbol getSymbol()
```
    Gets the polygon symbol that is used to renderer the marker.
  - setSymbol
```
public void setSymbol(CIMPolygonSymbol symbol)
```
    Sets the polygon symbol that is used to renderer the marker.
  - getVerticalOrientation3D
```
public boolean getVerticalOrientation3D()
```
    Gets a value indicating whether the marker stands a marker upright as though locked in place. The marker can be viewed from all angles.
  - setVerticalOrientation3D
```
public void setVerticalOrientation3D(boolean verticalOrientation3D)
```
    Sets a value indicating whether the marker stands a marker upright as though locked in place. The marker can be viewed from all angles.
  - getScaleSymbolsProportionally
```
public boolean getScaleSymbolsProportionally()
```
    Gets a value indicating whether the strokes and/or fills of a marker are scaled proportionally when the symbol size is changed.
  - setScaleSymbolsProportionally
```
public void setScaleSymbolsProportionally(boolean scaleSymbolsProportionally)
```
    Sets a value indicating whether the strokes and/or fills of a marker are scaled proportionally when the symbol size is changed.
  - getRespectFrame
```
public boolean getRespectFrame()
```
    Gets a value indicating whether the frame of the character marker should be honored when transforming the marker.
  - setRespectFrame
```
public void setRespectFrame(boolean respectFrame)
```
    Sets a value indicating whether the frame of the character marker should be honored when transforming the marker.
  - fromJSON
```
public static CIMCharacterMarker fromJSON(java.lang.String json)
                                   throws CIMJSONException
```
    Creates the object with a specified state from a JSON encoding.
    
    Throws:
    
    CIMJSONException
  - toJSON
```
public java.lang.String toJSON()
```
    Creates a JSON encoding of the object and its current state.
    
    Specified by:
    
    toJSON in class CIMObject
  - deserialize
```
public void deserialize(JSONObject jsonObject)
                 throws CIMJSONException
```
    Deserializes this object from its JSON representation.
    
    Overrides:
    
    deserialize in class CIMMarker
    
    Throws:
    
    CIMJSONException
  - serialize
```
public void serialize(JSONObject jsonObject)
```
    Serializes this object to its JSON representation.
    
    Overrides:
    
    serialize in class CIMMarker

Class CIMCharacterMarker

Constructor Summary

Method Summary

Methods inherited from class com.esri.arcgis.cartox.cim.CIMMarker

Methods inherited from class com.esri.arcgis.cartox.cim.CIMSymbolLayer

Methods inherited from class java.lang.Object

Constructor Detail

CIMCharacterMarker

Method Detail

getCharacterIndex

setCharacterIndex

getDepth3D

setDepth3D

getFontFamilyName

setFontFamilyName

getFontStyleName

setFontStyleName

getFontType

setFontType

getFontVariationSettings

setFontVariationSettings

getScaleX

setScaleX

getSymbol

setSymbol

getVerticalOrientation3D

setVerticalOrientation3D

getScaleSymbolsProportionally

setScaleSymbolsProportionally

getRespectFrame

setRespectFrame

fromJSON

toJSON

deserialize

serialize