public class CIMMaplexLabelPlacementProperties extends CIMLabelPlacementProperties
| Constructor and Description |
|---|
CIMMaplexLabelPlacementProperties() |
| Modifier and Type | Method and Description |
|---|---|
void |
deserialize(JSONObject jsonObject)
Deserializes this object from its JSON representation.
|
static CIMMaplexLabelPlacementProperties |
fromJSON(java.lang.String json)
Creates the object with a specified state from a JSON encoding.
|
boolean |
getAlignLabelToLineDirection()
Gets a value indicating whether to align the label with the label direction so the label may appear upside down.
|
boolean |
getAllowAsymmetricOverrun()
Gets a value indicating whether a label may overrun one side of a polygon feature.
|
boolean |
getAllowStraddleStacking()
Gets a value indicating whether a stacked label may straddle the line feature.
|
CIMExpressionInfo |
getAlternateLabelExpressionInfo()
Gets the ExpressionInfo for the alternate label expression.
|
boolean |
getAvoidOverlappingLabeledPolygonsAsIfHoles()
Gets a value indicating whether labels should avoid overlapping labeled polygons as if they were holes.
|
boolean |
getAvoidPolygonHoles()
Gets a value indicating whether labels should avoid holes in polygons.
|
boolean |
getBackgroundLabel()
Gets a value indicating whether to place the label first and allow other labels to be placed over it.
|
boolean |
getBoundaryLabelingAllowHoles()
Gets a value indicating whether to allow holes in boundary labeling.
|
boolean |
getBoundaryLabelingAllowSingleSided()
Gets a value indicating whether to allow single sided boundary labeling.
|
boolean |
getBoundaryLabelingSingleSidedOnLine()
Gets a value indicating whether single sided boundary label is centered on line.
|
boolean |
getCanAbbreviateLabel()
Gets a value indicating whether to abbreviate the label using an abbreviation dictionary.
|
boolean |
getCanFlipStackedStreetLabel()
Gets a value indicating whether a stacked label may be flipped over to obtain a better position.
|
boolean |
getCanKeyNumberLabel()
Gets a value indicating whether to key number the label and feature.
|
boolean |
getCanOverrunFeature()
Gets a value indicating whether to place the label over end of line or over polygon boundary.
|
boolean |
getCanPlaceLabelOnTopOfFeature()
Gets a value indicating whether the label can be placed on top of the street feature.
|
boolean |
getCanPlaceLabelOutsidePolygon()
Gets a value indicating whether to place a label outside the polygon if it does not fit inside.
|
boolean |
getCanReduceFontSize()
Gets a value indicating whether to reduce the size of the font.
|
boolean |
getCanReduceLeading()
Gets a value indicating whether the leading can be reduced for a stacked label.
|
boolean |
getCanRemoveOverlappingLabel()
Gets a value indicating whether to remove the label if it overlaps with other labels.
|
boolean |
getCanShiftPointLabel()
Gets a value indicating whether to allow the point label to be shifted upon a fixed position.
|
boolean |
getCanStackLabel()
Gets a value indicating whether to stack the label to obtain a better position.
|
boolean |
getCanTruncateLabel()
Gets a value indicating whether to truncate the label using an algorithm.
|
boolean |
getCanUseAlternateLabelExpression()
Gets a value indicating whether an alternate label expression is allowed to be used.
|
MaplexCenterLabelAnchorType |
getCenterLabelAnchorType()
Gets options to determine where to anchor a centered point label.
|
MaplexConnectionType |
getConnectionType()
Gets the options for connecting line features.
|
MaplexConstrainOffset |
getConstrainOffset()
Gets the label constraint options.
|
MaplexContourAlignmentType |
getContourAlignmentType()
Gets the options for the contour label alignment.
|
MaplexContourLadderType |
getContourLadderType()
Gets the options for the contour label ladder types.
|
int |
getContourMaximumAngle()
Gets the maximum angle at which a contour label may be placed.
|
java.lang.String |
getDictionaryName()
Gets the name of the abbreviations dictionary referenced by this layer.
|
boolean |
getEnableConnection()
Gets a value indicating whether to turn off line connection.
|
boolean |
getEnablePointPlacementPriorities()
Gets a value indicating whether to use user-defined point placement priorities.
|
boolean |
getEnablePolygonFixedPosition()
Gets a value indicating whether a label is to be placed at a fixed position in the polygon.
|
boolean |
getEnableSecondaryOffset()
Gets a value indicating whether to place a label at a secondary offset from the line feature.
|
int |
getFeatureWeight()
Gets the feature weight which controls which features may be overlapped and to what extent.
|
double |
getFontHeightReductionLimit()
Gets font height reduction limit.
|
double |
getFontHeightReductionStep()
Gets font height reduction step.
|
double |
getFontWidthReductionLimit()
Gets font width reduction limit.
|
double |
getFontWidthReductionStep()
Gets font width reduction step.
|
boolean |
getGraticuleAlignment()
Gets a value indicating whether to enable graticule alignment.
|
MaplexGraticuleAlignmentType |
getGraticuleAlignmentType()
Gets the options for the graticule alignment type.
|
boolean |
getIsLabelBufferHardConstraint()
Gets a value indicating whether the label buffer is a hard constraint and must be honored.
|
boolean |
getIsMinimumSizeBasedOnArea()
Gets a value indicating whether the minimum feature size for labeling is based on area.
|
boolean |
getIsOffsetFromFeatureGeometry()
Gets a value indicating whether to measure the label offset from the feature geometry.
|
java.lang.String |
getKeyNumberGroupName()
Gets the name of the key number group to use for key numbering the labels.
|
int |
getLabelBuffer()
Gets the label buffer.
|
boolean |
getLabelLargestPolygon()
Gets a value indicating whether to label only the largest polygon in a compound polygon feature.
|
int |
getLabelPriority()
Gets the label priority.
|
CIMMaplexLabelStackingProperties |
getLabelStackingProperties()
Gets the label stacking properties for a layer.
|
MaplexLineFeatureType |
getLineFeatureType()
Gets the line feature type.
|
MaplexLinePlacementMethod |
getLinePlacementMethod()
Gets the line placement method.
|
double |
getMaximumCharacterSpacing()
Gets the maximum character spacing.
|
double |
getMaximumLabelOverrun()
Gets the maximum distance that a label is allowed to overrun the end of its feature.
|
MaplexUnit |
getMaximumLabelOverrunUnit()
Gets the label overrun unit.
|
double |
getMaximumWordSpacing()
Gets maximum word spacing.
|
boolean |
getMeasureFromClippedFeatureGeometry()
Gets a value indicating whether or not to measure the offset from the clipped feature geometry.
|
double |
getMinimumEndOfStreetClearance()
Gets minimum clearance between street label and street end.
|
MaplexUnit |
getMinimumFeatureSizeUnit()
Gets minimum feature size unit.
|
double |
getMinimumRepetitionInterval()
Gets the interval that must elapse before label is repeated.
|
double |
getMinimumSizeForLabeling()
Gets the minimum size of a line or area feature for it to be labeled.
|
MaplexMultiPartOption |
getMultiPartOption()
Gets the option for labeling multi-part shapes.
|
boolean |
getNeverRemoveLabel()
Gets a value indicating whether to not remove the label if no position is found.
|
CIMMaplexOffsetAlongLineProperties |
getOffsetAlongLineProperties()
Gets the offset along line properties for a layer.
|
CIMMaplexExternalZonePriorities |
getPointExternalZonePriorities()
Gets the properties which control placement of a label around point feature.
|
MaplexPointPlacementMethod |
getPointPlacementMethod()
Gets the point placement method.
|
double |
getPolygonAnchorPointPerimeterInset()
Gets the inset value for perimeter polygon anchor leader anchor points.
|
MaplexUnit |
getPolygonAnchorPointPerimeterInsetUnit()
Gets the unit of the inset value for perimeter polygon anchor points.
|
MaplexAnchorPointType |
getPolygonAnchorPointType()
Gets the polygon anchor point type.
|
int |
getPolygonBoundaryWeight()
Gets the feature weight for the boundary of the polygon.
|
CIMMaplexExternalZonePriorities |
getPolygonExternalZones()
Gets the placement priorities associated with zones external to the polygon.
|
MaplexPolygonFeatureType |
getPolygonFeatureType()
Gets the polygon feature type.
|
CIMMaplexInternalZonePriorities |
getPolygonInternalZones()
Gets the placement priorities associated with zones internal to the polygon.
|
MaplexPolygonPlacementMethod |
getPolygonPlacementMethod()
Gets the polygon placement method.
|
boolean |
getPreferHorizontalPlacement()
Gets a value indicating whether there is a preference to place the label horizontally.
|
boolean |
getPreferLabelNearJunction()
Gets a value indicating whether there is a preference for placing a line label near a junction.
|
double |
getPreferLabelNearJunctionClearance()
Gets the preferred clearance for placing a line label near a junction.
|
boolean |
getPreferLabelNearMapBorder()
Gets a value indicating whether there is a preference for placing a line label near the map border.
|
double |
getPreferLabelNearMapBorderClearance()
Gets the preferred clearance for placing a line label near the map border.
|
double |
getPreferredEndOfStreetClearance()
Gets the preferred clearance between street label and street end.
|
double |
getPrimaryOffset()
Gets the primary offset between label and symbol.
|
MaplexUnit |
getPrimaryOffsetUnit()
Gets the unit of the primary offset.
|
MaplexRemoveAmbiguousLabelsType |
getRemoveAmbiguousLabels()
Gets the method to determine when to remove ambiguous labels.
|
boolean |
getRemoveExtraLineBreaks()
Gets a value indicating whether extra line breaks are removed from the label text.
|
boolean |
getRemoveExtraWhiteSpace()
Gets a value indicating whether extra white space characters are removed from the label text.
|
boolean |
getRepeatLabel()
Gets a value indicating whether to enable the repetition of label along line feature.
|
MaplexUnit |
getRepetitionIntervalUnit()
Gets the label repetition interval unit.
|
CIMMaplexRotationProperties |
getRotationProperties()
Gets the label rotation properties.
|
double |
getSecondaryOffset()
Gets the secondary offset between label and symbol.
|
double |
getSecondaryOffsetMaximum()
Gets the secondary offset maximum.
|
double |
getSecondaryOffsetMinimum()
Gets the secondary offset minimum.
|
MaplexUnit |
getSecondaryOffsetUnit()
Gets the unit of the secondary offset.
|
boolean |
getSpreadCharacters()
Gets a value indicating whether to spread label characters along line features.
|
boolean |
getSpreadWords()
Gets a value indicating whether to whether to spread words along line features.
|
CIMMaplexStrategyPriorities |
getStrategyPriorities()
Gets the priority of a placement strategy when placing text.
|
boolean |
getThinDuplicateLabels()
Gets a value indicating whether to remove duplicate labels that lie within a specified distance of each other.
|
double |
getThinningDistance()
Gets the distance used to control the thinning of duplicate labels.
|
MaplexUnit |
getThinningDistanceUnit()
Gets the thinning distance unit.
|
java.lang.String |
getTruncationExcludedCharacters()
Gets the excluded characters used by the truncation strategy.
|
java.lang.String |
getTruncationMarkerCharacter()
Gets the marker character used by the truncation strategy.
|
int |
getTruncationMinimumLength()
Gets the minimum length of a label used by the truncation strategy.
|
java.lang.String |
getTruncationPreferredCharacters()
Gets the preferred characters used by the truncation strategy.
|
boolean |
getUseExactSymbolOutline()
Gets a value indicating whether to use the exact polygon outline of a symbol when measuring the label offset.
|
void |
serialize(JSONObject jsonObject)
Serializes this object to its JSON representation.
|
void |
setAlignLabelToLineDirection(boolean alignLabelToLineDirection)
Sets a value indicating whether to align the label with the label direction so the label may appear upside down.
|
void |
setAllowAsymmetricOverrun(boolean allowAsymmetricOverrun)
Sets a value indicating whether a label may overrun one side of a polygon feature.
|
void |
setAllowStraddleStacking(boolean allowStraddleStacking)
Sets a value indicating whether a stacked label may straddle the line feature.
|
void |
setAlternateLabelExpressionInfo(CIMExpressionInfo alternateLabelExpressionInfo)
Sets the ExpressionInfo for the alternate label expression.
|
void |
setAvoidOverlappingLabeledPolygonsAsIfHoles(boolean avoidOverlappingLabeledPolygonsAsIfHoles)
Sets a value indicating whether labels should avoid overlapping labeled polygons as if they were holes.
|
void |
setAvoidPolygonHoles(boolean avoidPolygonHoles)
Sets a value indicating whether labels should avoid holes in polygons.
|
void |
setBackgroundLabel(boolean backgroundLabel)
Sets a value indicating whether to place the label first and allow other labels to be placed over it.
|
void |
setBoundaryLabelingAllowHoles(boolean boundaryLabelingAllowHoles)
Sets a value indicating whether to allow holes in boundary labeling.
|
void |
setBoundaryLabelingAllowSingleSided(boolean boundaryLabelingAllowSingleSided)
Sets a value indicating whether to allow single sided boundary labeling.
|
void |
setBoundaryLabelingSingleSidedOnLine(boolean boundaryLabelingSingleSidedOnLine)
Sets a value indicating whether single sided boundary label is centered on line.
|
void |
setCanAbbreviateLabel(boolean canAbbreviateLabel)
Sets a value indicating whether to abbreviate the label using an abbreviation dictionary.
|
void |
setCanFlipStackedStreetLabel(boolean canFlipStackedStreetLabel)
Sets a value indicating whether a stacked label may be flipped over to obtain a better position.
|
void |
setCanKeyNumberLabel(boolean canKeyNumberLabel)
Sets a value indicating whether to key number the label and feature.
|
void |
setCanOverrunFeature(boolean canOverrunFeature)
Sets a value indicating whether to place the label over end of line or over polygon boundary.
|
void |
setCanPlaceLabelOnTopOfFeature(boolean canPlaceLabelOnTopOfFeature)
Sets a value indicating whether the label can be placed on top of the street feature.
|
void |
setCanPlaceLabelOutsidePolygon(boolean canPlaceLabelOutsidePolygon)
Sets a value indicating whether to place a label outside the polygon if it does not fit inside.
|
void |
setCanReduceFontSize(boolean canReduceFontSize)
Sets a value indicating whether to reduce the size of the font.
|
void |
setCanReduceLeading(boolean canReduceLeading)
Sets a value indicating whether the leading can be reduced for a stacked label.
|
void |
setCanRemoveOverlappingLabel(boolean canRemoveOverlappingLabel)
Sets a value indicating whether to remove the label if it overlaps with other labels.
|
void |
setCanShiftPointLabel(boolean canShiftPointLabel)
Sets a value indicating whether to allow the point label to be shifted upon a fixed position.
|
void |
setCanStackLabel(boolean canStackLabel)
Sets a value indicating whether to stack the label to obtain a better position.
|
void |
setCanTruncateLabel(boolean canTruncateLabel)
Sets a value indicating whether to truncate the label using an algorithm.
|
void |
setCanUseAlternateLabelExpression(boolean canUseAlternateLabelExpression)
Sets a value indicating whether an alternate label expression is allowed to be used.
|
void |
setCenterLabelAnchorType(MaplexCenterLabelAnchorType centerLabelAnchorType)
Sets options to determine where to anchor a centered point label.
|
void |
setConnectionType(MaplexConnectionType connectionType)
Sets the options for connecting line features.
|
void |
setConstrainOffset(MaplexConstrainOffset constrainOffset)
Sets the label constraint options.
|
void |
setContourAlignmentType(MaplexContourAlignmentType contourAlignmentType)
Sets the options for the contour label alignment.
|
void |
setContourLadderType(MaplexContourLadderType contourLadderType)
Sets the options for the contour label ladder types.
|
void |
setContourMaximumAngle(int contourMaximumAngle)
Sets the maximum angle at which a contour label may be placed.
|
void |
setDictionaryName(java.lang.String dictionaryName)
Sets the name of the abbreviations dictionary referenced by this layer.
|
void |
setEnableConnection(boolean enableConnection)
Sets a value indicating whether to turn off line connection.
|
void |
setEnablePointPlacementPriorities(boolean enablePointPlacementPriorities)
Sets a value indicating whether to use user-defined point placement priorities.
|
void |
setEnablePolygonFixedPosition(boolean enablePolygonFixedPosition)
Sets a value indicating whether a label is to be placed at a fixed position in the polygon.
|
void |
setEnableSecondaryOffset(boolean enableSecondaryOffset)
Sets a value indicating whether to place a label at a secondary offset from the line feature.
|
void |
setFeatureWeight(int featureWeight)
Sets the feature weight which controls which features may be overlapped and to what extent.
|
void |
setFontHeightReductionLimit(double fontHeightReductionLimit)
Sets font height reduction limit.
|
void |
setFontHeightReductionStep(double fontHeightReductionStep)
Sets font height reduction step.
|
void |
setFontWidthReductionLimit(double fontWidthReductionLimit)
Sets font width reduction limit.
|
void |
setFontWidthReductionStep(double fontWidthReductionStep)
Sets font width reduction step.
|
void |
setGraticuleAlignment(boolean graticuleAlignment)
Sets a value indicating whether to enable graticule alignment.
|
void |
setGraticuleAlignmentType(MaplexGraticuleAlignmentType graticuleAlignmentType)
Sets the options for the graticule alignment type.
|
void |
setIsLabelBufferHardConstraint(boolean isLabelBufferHardConstraint)
Sets a value indicating whether the label buffer is a hard constraint and must be honored.
|
void |
setIsMinimumSizeBasedOnArea(boolean isMinimumSizeBasedOnArea)
Sets a value indicating whether the minimum feature size for labeling is based on area.
|
void |
setIsOffsetFromFeatureGeometry(boolean isOffsetFromFeatureGeometry)
Sets a value indicating whether to measure the label offset from the feature geometry.
|
void |
setKeyNumberGroupName(java.lang.String keyNumberGroupName)
Sets the name of the key number group to use for key numbering the labels.
|
void |
setLabelBuffer(int labelBuffer)
Sets the label buffer.
|
void |
setLabelLargestPolygon(boolean labelLargestPolygon)
Sets a value indicating whether to label only the largest polygon in a compound polygon feature.
|
void |
setLabelPriority(int labelPriority)
Sets the label priority.
|
void |
setLabelStackingProperties(CIMMaplexLabelStackingProperties labelStackingProperties)
Sets the label stacking properties for a layer.
|
void |
setLineFeatureType(MaplexLineFeatureType lineFeatureType)
Sets the line feature type.
|
void |
setLinePlacementMethod(MaplexLinePlacementMethod linePlacementMethod)
Sets the line placement method.
|
void |
setMaximumCharacterSpacing(double maximumCharacterSpacing)
Sets the maximum character spacing.
|
void |
setMaximumLabelOverrun(double maximumLabelOverrun)
Sets the maximum distance that a label is allowed to overrun the end of its feature.
|
void |
setMaximumLabelOverrunUnit(MaplexUnit maximumLabelOverrunUnit)
Sets the label overrun unit.
|
void |
setMaximumWordSpacing(double maximumWordSpacing)
Sets maximum word spacing.
|
void |
setMeasureFromClippedFeatureGeometry(boolean measureFromClippedFeatureGeometry)
Sets a value indicating whether or not to measure the offset from the clipped feature geometry.
|
void |
setMinimumEndOfStreetClearance(double minimumEndOfStreetClearance)
Sets minimum clearance between street label and street end.
|
void |
setMinimumFeatureSizeUnit(MaplexUnit minimumFeatureSizeUnit)
Sets minimum feature size unit.
|
void |
setMinimumRepetitionInterval(double minimumRepetitionInterval)
Sets the interval that must elapse before label is repeated.
|
void |
setMinimumSizeForLabeling(double minimumSizeForLabeling)
Sets the minimum size of a line or area feature for it to be labeled.
|
void |
setMultiPartOption(MaplexMultiPartOption multiPartOption)
Sets the option for labeling multi-part shapes.
|
void |
setNeverRemoveLabel(boolean neverRemoveLabel)
Sets a value indicating whether to not remove the label if no position is found.
|
void |
setOffsetAlongLineProperties(CIMMaplexOffsetAlongLineProperties offsetAlongLineProperties)
Sets the offset along line properties for a layer.
|
void |
setPointExternalZonePriorities(CIMMaplexExternalZonePriorities pointExternalZonePriorities)
Sets the properties which control placement of a label around point feature.
|
void |
setPointPlacementMethod(MaplexPointPlacementMethod pointPlacementMethod)
Sets the point placement method.
|
void |
setPolygonAnchorPointPerimeterInset(double polygonAnchorPointPerimeterInset)
Sets the inset value for perimeter polygon anchor leader anchor points.
|
void |
setPolygonAnchorPointPerimeterInsetUnit(MaplexUnit polygonAnchorPointPerimeterInsetUnit)
Sets the unit of the inset value for perimeter polygon anchor points.
|
void |
setPolygonAnchorPointType(MaplexAnchorPointType polygonAnchorPointType)
Sets the polygon anchor point type.
|
void |
setPolygonBoundaryWeight(int polygonBoundaryWeight)
Sets the feature weight for the boundary of the polygon.
|
void |
setPolygonExternalZones(CIMMaplexExternalZonePriorities polygonExternalZones)
Sets the placement priorities associated with zones external to the polygon.
|
void |
setPolygonFeatureType(MaplexPolygonFeatureType polygonFeatureType)
Sets the polygon feature type.
|
void |
setPolygonInternalZones(CIMMaplexInternalZonePriorities polygonInternalZones)
Sets the placement priorities associated with zones internal to the polygon.
|
void |
setPolygonPlacementMethod(MaplexPolygonPlacementMethod polygonPlacementMethod)
Sets the polygon placement method.
|
void |
setPreferHorizontalPlacement(boolean preferHorizontalPlacement)
Sets a value indicating whether there is a preference to place the label horizontally.
|
void |
setPreferLabelNearJunction(boolean preferLabelNearJunction)
Sets a value indicating whether there is a preference for placing a line label near a junction.
|
void |
setPreferLabelNearJunctionClearance(double preferLabelNearJunctionClearance)
Sets the preferred clearance for placing a line label near a junction.
|
void |
setPreferLabelNearMapBorder(boolean preferLabelNearMapBorder)
Sets a value indicating whether there is a preference for placing a line label near the map border.
|
void |
setPreferLabelNearMapBorderClearance(double preferLabelNearMapBorderClearance)
Sets the preferred clearance for placing a line label near the map border.
|
void |
setPreferredEndOfStreetClearance(double preferredEndOfStreetClearance)
Sets the preferred clearance between street label and street end.
|
void |
setPrimaryOffset(double primaryOffset)
Sets the primary offset between label and symbol.
|
void |
setPrimaryOffsetUnit(MaplexUnit primaryOffsetUnit)
Sets the unit of the primary offset.
|
void |
setRemoveAmbiguousLabels(MaplexRemoveAmbiguousLabelsType removeAmbiguousLabels)
Sets the method to determine when to remove ambiguous labels.
|
void |
setRemoveExtraLineBreaks(boolean removeExtraLineBreaks)
Sets a value indicating whether extra line breaks are removed from the label text.
|
void |
setRemoveExtraWhiteSpace(boolean removeExtraWhiteSpace)
Sets a value indicating whether extra white space characters are removed from the label text.
|
void |
setRepeatLabel(boolean repeatLabel)
Sets a value indicating whether to enable the repetition of label along line feature.
|
void |
setRepetitionIntervalUnit(MaplexUnit repetitionIntervalUnit)
Sets the label repetition interval unit.
|
void |
setRotationProperties(CIMMaplexRotationProperties rotationProperties)
Sets the label rotation properties.
|
void |
setSecondaryOffset(double secondaryOffset)
Sets the secondary offset between label and symbol.
|
void |
setSecondaryOffsetMaximum(double secondaryOffsetMaximum)
Sets the secondary offset maximum.
|
void |
setSecondaryOffsetMinimum(double secondaryOffsetMinimum)
Sets the secondary offset minimum.
|
void |
setSecondaryOffsetUnit(MaplexUnit secondaryOffsetUnit)
Sets the unit of the secondary offset.
|
void |
setSpreadCharacters(boolean spreadCharacters)
Sets a value indicating whether to spread label characters along line features.
|
void |
setSpreadWords(boolean spreadWords)
Sets a value indicating whether to whether to spread words along line features.
|
void |
setStrategyPriorities(CIMMaplexStrategyPriorities strategyPriorities)
Sets the priority of a placement strategy when placing text.
|
void |
setThinDuplicateLabels(boolean thinDuplicateLabels)
Sets a value indicating whether to remove duplicate labels that lie within a specified distance of each other.
|
void |
setThinningDistance(double thinningDistance)
Sets the distance used to control the thinning of duplicate labels.
|
void |
setThinningDistanceUnit(MaplexUnit thinningDistanceUnit)
Sets the thinning distance unit.
|
void |
setTruncationExcludedCharacters(java.lang.String truncationExcludedCharacters)
Sets the excluded characters used by the truncation strategy.
|
void |
setTruncationMarkerCharacter(java.lang.String truncationMarkerCharacter)
Sets the marker character used by the truncation strategy.
|
void |
setTruncationMinimumLength(int truncationMinimumLength)
Sets the minimum length of a label used by the truncation strategy.
|
void |
setTruncationPreferredCharacters(java.lang.String truncationPreferredCharacters)
Sets the preferred characters used by the truncation strategy.
|
void |
setUseExactSymbolOutline(boolean useExactSymbolOutline)
Sets a value indicating whether to use the exact polygon outline of a symbol when measuring the label offset.
|
java.lang.String |
toJSON()
Creates a JSON encoding of the object and its current state.
|
getFeatureType, setFeatureTypepublic boolean getAlignLabelToLineDirection()
public void setAlignLabelToLineDirection(boolean alignLabelToLineDirection)
public boolean getAllowAsymmetricOverrun()
public void setAllowAsymmetricOverrun(boolean allowAsymmetricOverrun)
public boolean getAllowStraddleStacking()
public void setAllowStraddleStacking(boolean allowStraddleStacking)
public CIMExpressionInfo getAlternateLabelExpressionInfo()
public void setAlternateLabelExpressionInfo(CIMExpressionInfo alternateLabelExpressionInfo)
public boolean getAvoidOverlappingLabeledPolygonsAsIfHoles()
public void setAvoidOverlappingLabeledPolygonsAsIfHoles(boolean avoidOverlappingLabeledPolygonsAsIfHoles)
public boolean getAvoidPolygonHoles()
public void setAvoidPolygonHoles(boolean avoidPolygonHoles)
public boolean getBackgroundLabel()
public void setBackgroundLabel(boolean backgroundLabel)
public boolean getBoundaryLabelingAllowHoles()
public void setBoundaryLabelingAllowHoles(boolean boundaryLabelingAllowHoles)
public boolean getBoundaryLabelingAllowSingleSided()
public void setBoundaryLabelingAllowSingleSided(boolean boundaryLabelingAllowSingleSided)
public boolean getBoundaryLabelingSingleSidedOnLine()
public void setBoundaryLabelingSingleSidedOnLine(boolean boundaryLabelingSingleSidedOnLine)
public boolean getCanAbbreviateLabel()
public void setCanAbbreviateLabel(boolean canAbbreviateLabel)
public boolean getCanFlipStackedStreetLabel()
public void setCanFlipStackedStreetLabel(boolean canFlipStackedStreetLabel)
public boolean getCanKeyNumberLabel()
public void setCanKeyNumberLabel(boolean canKeyNumberLabel)
public boolean getCanOverrunFeature()
public void setCanOverrunFeature(boolean canOverrunFeature)
public boolean getCanPlaceLabelOnTopOfFeature()
public void setCanPlaceLabelOnTopOfFeature(boolean canPlaceLabelOnTopOfFeature)
public boolean getCanPlaceLabelOutsidePolygon()
public void setCanPlaceLabelOutsidePolygon(boolean canPlaceLabelOutsidePolygon)
public boolean getCanReduceFontSize()
public void setCanReduceFontSize(boolean canReduceFontSize)
public boolean getCanReduceLeading()
public void setCanReduceLeading(boolean canReduceLeading)
public boolean getCanRemoveOverlappingLabel()
public void setCanRemoveOverlappingLabel(boolean canRemoveOverlappingLabel)
public boolean getCanShiftPointLabel()
public void setCanShiftPointLabel(boolean canShiftPointLabel)
public boolean getCanStackLabel()
public void setCanStackLabel(boolean canStackLabel)
public boolean getCanTruncateLabel()
public void setCanTruncateLabel(boolean canTruncateLabel)
public boolean getCanUseAlternateLabelExpression()
public void setCanUseAlternateLabelExpression(boolean canUseAlternateLabelExpression)
public MaplexCenterLabelAnchorType getCenterLabelAnchorType()
public void setCenterLabelAnchorType(MaplexCenterLabelAnchorType centerLabelAnchorType)
public MaplexConnectionType getConnectionType()
public void setConnectionType(MaplexConnectionType connectionType)
public MaplexConstrainOffset getConstrainOffset()
public void setConstrainOffset(MaplexConstrainOffset constrainOffset)
public MaplexContourAlignmentType getContourAlignmentType()
public void setContourAlignmentType(MaplexContourAlignmentType contourAlignmentType)
public MaplexContourLadderType getContourLadderType()
public void setContourLadderType(MaplexContourLadderType contourLadderType)
public int getContourMaximumAngle()
public void setContourMaximumAngle(int contourMaximumAngle)
public java.lang.String getDictionaryName()
public void setDictionaryName(java.lang.String dictionaryName)
public boolean getEnableConnection()
public void setEnableConnection(boolean enableConnection)
public boolean getEnablePointPlacementPriorities()
public void setEnablePointPlacementPriorities(boolean enablePointPlacementPriorities)
public boolean getEnablePolygonFixedPosition()
public void setEnablePolygonFixedPosition(boolean enablePolygonFixedPosition)
public boolean getEnableSecondaryOffset()
public void setEnableSecondaryOffset(boolean enableSecondaryOffset)
public int getFeatureWeight()
public void setFeatureWeight(int featureWeight)
public double getFontHeightReductionLimit()
public void setFontHeightReductionLimit(double fontHeightReductionLimit)
public double getFontHeightReductionStep()
public void setFontHeightReductionStep(double fontHeightReductionStep)
public double getFontWidthReductionLimit()
public void setFontWidthReductionLimit(double fontWidthReductionLimit)
public double getFontWidthReductionStep()
public void setFontWidthReductionStep(double fontWidthReductionStep)
public boolean getGraticuleAlignment()
public void setGraticuleAlignment(boolean graticuleAlignment)
public MaplexGraticuleAlignmentType getGraticuleAlignmentType()
public void setGraticuleAlignmentType(MaplexGraticuleAlignmentType graticuleAlignmentType)
public boolean getIsLabelBufferHardConstraint()
public void setIsLabelBufferHardConstraint(boolean isLabelBufferHardConstraint)
public boolean getIsMinimumSizeBasedOnArea()
public void setIsMinimumSizeBasedOnArea(boolean isMinimumSizeBasedOnArea)
public boolean getIsOffsetFromFeatureGeometry()
public void setIsOffsetFromFeatureGeometry(boolean isOffsetFromFeatureGeometry)
public java.lang.String getKeyNumberGroupName()
public void setKeyNumberGroupName(java.lang.String keyNumberGroupName)
public int getLabelBuffer()
public void setLabelBuffer(int labelBuffer)
public boolean getLabelLargestPolygon()
public void setLabelLargestPolygon(boolean labelLargestPolygon)
public int getLabelPriority()
public void setLabelPriority(int labelPriority)
public CIMMaplexLabelStackingProperties getLabelStackingProperties()
public void setLabelStackingProperties(CIMMaplexLabelStackingProperties labelStackingProperties)
public MaplexLineFeatureType getLineFeatureType()
public void setLineFeatureType(MaplexLineFeatureType lineFeatureType)
public MaplexLinePlacementMethod getLinePlacementMethod()
public void setLinePlacementMethod(MaplexLinePlacementMethod linePlacementMethod)
public double getMaximumCharacterSpacing()
public void setMaximumCharacterSpacing(double maximumCharacterSpacing)
public double getMaximumLabelOverrun()
public void setMaximumLabelOverrun(double maximumLabelOverrun)
public MaplexUnit getMaximumLabelOverrunUnit()
public void setMaximumLabelOverrunUnit(MaplexUnit maximumLabelOverrunUnit)
public double getMaximumWordSpacing()
public void setMaximumWordSpacing(double maximumWordSpacing)
public boolean getMeasureFromClippedFeatureGeometry()
public void setMeasureFromClippedFeatureGeometry(boolean measureFromClippedFeatureGeometry)
public double getMinimumEndOfStreetClearance()
public void setMinimumEndOfStreetClearance(double minimumEndOfStreetClearance)
public MaplexUnit getMinimumFeatureSizeUnit()
public void setMinimumFeatureSizeUnit(MaplexUnit minimumFeatureSizeUnit)
public double getMinimumRepetitionInterval()
public void setMinimumRepetitionInterval(double minimumRepetitionInterval)
public double getMinimumSizeForLabeling()
public void setMinimumSizeForLabeling(double minimumSizeForLabeling)
public MaplexMultiPartOption getMultiPartOption()
public void setMultiPartOption(MaplexMultiPartOption multiPartOption)
public boolean getNeverRemoveLabel()
public void setNeverRemoveLabel(boolean neverRemoveLabel)
public CIMMaplexOffsetAlongLineProperties getOffsetAlongLineProperties()
public void setOffsetAlongLineProperties(CIMMaplexOffsetAlongLineProperties offsetAlongLineProperties)
public CIMMaplexExternalZonePriorities getPointExternalZonePriorities()
public void setPointExternalZonePriorities(CIMMaplexExternalZonePriorities pointExternalZonePriorities)
public MaplexPointPlacementMethod getPointPlacementMethod()
public void setPointPlacementMethod(MaplexPointPlacementMethod pointPlacementMethod)
public MaplexAnchorPointType getPolygonAnchorPointType()
public void setPolygonAnchorPointType(MaplexAnchorPointType polygonAnchorPointType)
public int getPolygonBoundaryWeight()
public void setPolygonBoundaryWeight(int polygonBoundaryWeight)
public CIMMaplexExternalZonePriorities getPolygonExternalZones()
public void setPolygonExternalZones(CIMMaplexExternalZonePriorities polygonExternalZones)
public MaplexPolygonFeatureType getPolygonFeatureType()
public void setPolygonFeatureType(MaplexPolygonFeatureType polygonFeatureType)
public CIMMaplexInternalZonePriorities getPolygonInternalZones()
public void setPolygonInternalZones(CIMMaplexInternalZonePriorities polygonInternalZones)
public MaplexPolygonPlacementMethod getPolygonPlacementMethod()
public void setPolygonPlacementMethod(MaplexPolygonPlacementMethod polygonPlacementMethod)
public boolean getPreferHorizontalPlacement()
public void setPreferHorizontalPlacement(boolean preferHorizontalPlacement)
public boolean getPreferLabelNearJunction()
public void setPreferLabelNearJunction(boolean preferLabelNearJunction)
public double getPreferLabelNearJunctionClearance()
public void setPreferLabelNearJunctionClearance(double preferLabelNearJunctionClearance)
public boolean getPreferLabelNearMapBorder()
public void setPreferLabelNearMapBorder(boolean preferLabelNearMapBorder)
public double getPreferLabelNearMapBorderClearance()
public void setPreferLabelNearMapBorderClearance(double preferLabelNearMapBorderClearance)
public double getPreferredEndOfStreetClearance()
public void setPreferredEndOfStreetClearance(double preferredEndOfStreetClearance)
public double getPrimaryOffset()
public void setPrimaryOffset(double primaryOffset)
public MaplexUnit getPrimaryOffsetUnit()
public void setPrimaryOffsetUnit(MaplexUnit primaryOffsetUnit)
public MaplexRemoveAmbiguousLabelsType getRemoveAmbiguousLabels()
public void setRemoveAmbiguousLabels(MaplexRemoveAmbiguousLabelsType removeAmbiguousLabels)
public boolean getRemoveExtraLineBreaks()
public void setRemoveExtraLineBreaks(boolean removeExtraLineBreaks)
public boolean getRemoveExtraWhiteSpace()
public void setRemoveExtraWhiteSpace(boolean removeExtraWhiteSpace)
public boolean getRepeatLabel()
public void setRepeatLabel(boolean repeatLabel)
public MaplexUnit getRepetitionIntervalUnit()
public void setRepetitionIntervalUnit(MaplexUnit repetitionIntervalUnit)
public CIMMaplexRotationProperties getRotationProperties()
public void setRotationProperties(CIMMaplexRotationProperties rotationProperties)
public double getSecondaryOffset()
public void setSecondaryOffset(double secondaryOffset)
public double getSecondaryOffsetMaximum()
public void setSecondaryOffsetMaximum(double secondaryOffsetMaximum)
public double getSecondaryOffsetMinimum()
public void setSecondaryOffsetMinimum(double secondaryOffsetMinimum)
public MaplexUnit getSecondaryOffsetUnit()
public void setSecondaryOffsetUnit(MaplexUnit secondaryOffsetUnit)
public boolean getSpreadCharacters()
public void setSpreadCharacters(boolean spreadCharacters)
public boolean getSpreadWords()
public void setSpreadWords(boolean spreadWords)
public CIMMaplexStrategyPriorities getStrategyPriorities()
public void setStrategyPriorities(CIMMaplexStrategyPriorities strategyPriorities)
public boolean getThinDuplicateLabels()
public void setThinDuplicateLabels(boolean thinDuplicateLabels)
public double getThinningDistance()
public void setThinningDistance(double thinningDistance)
public MaplexUnit getThinningDistanceUnit()
public void setThinningDistanceUnit(MaplexUnit thinningDistanceUnit)
public java.lang.String getTruncationMarkerCharacter()
public void setTruncationMarkerCharacter(java.lang.String truncationMarkerCharacter)
public int getTruncationMinimumLength()
public void setTruncationMinimumLength(int truncationMinimumLength)
public java.lang.String getTruncationPreferredCharacters()
public void setTruncationPreferredCharacters(java.lang.String truncationPreferredCharacters)
public boolean getUseExactSymbolOutline()
public void setUseExactSymbolOutline(boolean useExactSymbolOutline)
public java.lang.String getTruncationExcludedCharacters()
public void setTruncationExcludedCharacters(java.lang.String truncationExcludedCharacters)
public double getPolygonAnchorPointPerimeterInset()
public void setPolygonAnchorPointPerimeterInset(double polygonAnchorPointPerimeterInset)
public MaplexUnit getPolygonAnchorPointPerimeterInsetUnit()
public void setPolygonAnchorPointPerimeterInsetUnit(MaplexUnit polygonAnchorPointPerimeterInsetUnit)
public static CIMMaplexLabelPlacementProperties fromJSON(java.lang.String json) throws CIMJSONException
CIMJSONExceptionpublic java.lang.String toJSON()
public void deserialize(JSONObject jsonObject) throws CIMJSONException
deserialize in class CIMLabelPlacementPropertiesCIMJSONExceptionpublic void serialize(JSONObject jsonObject)
serialize in class CIMLabelPlacementProperties