com.esri.arcgis.cartox.cim

Class CIMMarkerPlacementAlongLine

java.lang.Object

com.esri.arcgis.cartox.cim.CIMObject

com.esri.arcgis.cartox.cim.CIMMarkerPlacement

com.esri.arcgis.cartox.cim.CIMMarkerStrokePlacement

com.esri.arcgis.cartox.cim.CIMMarkerPlacementAlongLine

Direct Known Subclasses:

CIMMarkerPlacementAlongLineRandomSize, CIMMarkerPlacementAlongLineSameSize

public abstract class CIMMarkerPlacementAlongLine
extends CIMMarkerStrokePlacement

Represents marker placement along the line which defines how a marker is placed along a line or polygon outline.

Constructor Summary

Constructors

Constructor and Description
CIMMarkerPlacementAlongLine()

Method Summary

Modifier and Type	Method and Description
void	deserialize(JSONObject jsonObject) Deserializes this object from its JSON representation.
double	getCustomEndingOffset() Gets where the pattern should end relative to the ending point of the geometry.
PlacementEndings	getEndings() Gets how markers are placed at the end points of a line.
double	getOffsetAlongLine() Gets where the pattern should begin relative to the starting point of the geometry.
double[]	getPlacementTemplate() Gets the numeric pattern that defines the sequence of placed markers and the length of space between them.
void	serialize(JSONObject jsonObject) Serializes this object to its JSON representation.
void	setCustomEndingOffset(double customEndingOffset) Sets where the pattern should end relative to the ending point of the geometry.
void	setEndings(PlacementEndings endings) Sets how markers are placed at the end points of a line.
void	setOffsetAlongLine(double offsetAlongLine) Sets where the pattern should begin relative to the starting point of the geometry.
void	setPlacementTemplate(double[] placementTemplate) Sets the numeric pattern that defines the sequence of placed markers and the length of space between them.

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

getAngleToLine, getKeepUpright, getOffset, setAngleToLine, setKeepUpright, setOffset

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

getPlacePerPart, getPrimitiveName, setPlacePerPart, setPrimitiveName

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

fromJSON, toJSON

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CIMMarkerPlacementAlongLine

public CIMMarkerPlacementAlongLine()

Method Detail

getCustomEndingOffset

public double getCustomEndingOffset()

Gets where the pattern should end relative to the ending point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the Endings property is set to Custom.

setCustomEndingOffset

public void setCustomEndingOffset(double customEndingOffset)

Sets where the pattern should end relative to the ending point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the Endings property is set to Custom.

getEndings

public PlacementEndings getEndings()

Gets how markers are placed at the end points of a line.

setEndings

public void setEndings(PlacementEndings endings)

Sets how markers are placed at the end points of a line.

getOffsetAlongLine

public double getOffsetAlongLine()

Gets where the pattern should begin relative to the starting point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the Endings property is set to No Constraint or Custom.

setOffsetAlongLine

public void setOffsetAlongLine(double offsetAlongLine)

Sets where the pattern should begin relative to the starting point of the geometry. The entire pattern is shifted along the line for the specified distance. Negative numbers shift to the left and positive numbers shift to the right. This is only applied if the Endings property is set to No Constraint or Custom.

getPlacementTemplate

public double[] getPlacementTemplate()

Gets the numeric pattern that defines the sequence of placed markers and the length of space between them.

setPlacementTemplate

public void setPlacementTemplate(double[] placementTemplate)

Sets the numeric pattern that defines the sequence of placed markers and the length of space between them.

deserialize

public void deserialize(JSONObject jsonObject)
                 throws CIMJSONException

Deserializes this object from its JSON representation.

Overrides:

deserialize in class CIMMarkerStrokePlacement

Throws:

CIMJSONException

serialize

public void serialize(JSONObject jsonObject)

Serializes this object to its JSON representation.

Overrides:

serialize in class CIMMarkerStrokePlacement