public class Symbol extends Annotation<Point>
geometry, jsonObject| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getIconAnchor()
Get the IconAnchor property
|
java.lang.String |
getIconColor()
Get the IconColor property
|
int |
getIconColorAsInt()
Get the IconColor property
|
java.lang.Float |
getIconHaloBlur()
Get the IconHaloBlur property
|
java.lang.String |
getIconHaloColor()
Get the IconHaloColor property
|
int |
getIconHaloColorAsInt()
Get the IconHaloColor property
|
java.lang.Float |
getIconHaloWidth()
Get the IconHaloWidth property
|
java.lang.String |
getIconImage()
Get the IconImage property
|
android.graphics.PointF |
getIconOffset()
Get the IconOffset property
|
java.lang.Float |
getIconOpacity()
Get the IconOpacity property
|
java.lang.Float |
getIconRotate()
Get the IconRotate property
|
java.lang.Float |
getIconSize()
Get the IconSize property
|
LatLng |
getLatLng()
Get the LatLng of the symbol, which represents the location of the symbol on the map
|
java.lang.Float |
getSymbolSortKey()
Get the SymbolSortKey property
|
java.lang.String |
getTextAnchor()
Get the TextAnchor property
|
java.lang.String |
getTextColor()
Get the TextColor property
|
int |
getTextColorAsInt()
Get the TextColor property
|
java.lang.String |
getTextField()
Get the TextField property
|
java.lang.String[] |
getTextFont()
Get the TextFont property
|
java.lang.Float |
getTextHaloBlur()
Get the TextHaloBlur property
|
java.lang.String |
getTextHaloColor()
Get the TextHaloColor property
|
int |
getTextHaloColorAsInt()
Get the TextHaloColor property
|
java.lang.Float |
getTextHaloWidth()
Get the TextHaloWidth property
|
java.lang.String |
getTextJustify()
Get the TextJustify property
|
java.lang.Float |
getTextLetterSpacing()
Get the TextLetterSpacing property
|
java.lang.Float |
getTextMaxWidth()
Get the TextMaxWidth property
|
android.graphics.PointF |
getTextOffset()
Get the TextOffset property
|
java.lang.Float |
getTextOpacity()
Get the TextOpacity property
|
java.lang.Float |
getTextRadialOffset()
Get the TextRadialOffset property
|
java.lang.Float |
getTextRotate()
Get the TextRotate property
|
java.lang.Float |
getTextSize()
Get the TextSize property
|
java.lang.String |
getTextTransform()
Get the TextTransform property
|
void |
setIconAnchor(java.lang.String value)
Set the IconAnchor property
|
void |
setIconColor(int color)
Set the IconColor property
|
void |
setIconColor(java.lang.String color)
Set the IconColor property
|
void |
setIconHaloBlur(java.lang.Float value)
Set the IconHaloBlur property
|
void |
setIconHaloColor(int color)
Set the IconHaloColor property
|
void |
setIconHaloColor(java.lang.String color)
Set the IconHaloColor property
|
void |
setIconHaloWidth(java.lang.Float value)
Set the IconHaloWidth property
|
void |
setIconImage(java.lang.String value)
Set the IconImage property
|
void |
setIconOffset(android.graphics.PointF pointF)
Set the IconOffset property.
|
void |
setIconOpacity(java.lang.Float value)
Set the IconOpacity property
|
void |
setIconRotate(java.lang.Float value)
Set the IconRotate property
|
void |
setIconSize(java.lang.Float value)
Set the IconSize property
|
void |
setLatLng(LatLng latLng)
Set the LatLng of the symbol, which represents the location of the symbol on the map
|
void |
setSymbolSortKey(java.lang.Float value)
Set the SymbolSortKey property
|
void |
setTextAnchor(java.lang.String value)
Set the TextAnchor property
|
void |
setTextColor(int color)
Set the TextColor property
|
void |
setTextColor(java.lang.String color)
Set the TextColor property
|
void |
setTextField(java.lang.String value)
Set the TextField property
|
void |
setTextFont(java.lang.String[] value)
Set the TextFont property.
|
void |
setTextHaloBlur(java.lang.Float value)
Set the TextHaloBlur property
|
void |
setTextHaloColor(int color)
Set the TextHaloColor property
|
void |
setTextHaloColor(java.lang.String color)
Set the TextHaloColor property
|
void |
setTextHaloWidth(java.lang.Float value)
Set the TextHaloWidth property
|
void |
setTextJustify(java.lang.String value)
Set the TextJustify property
|
void |
setTextLetterSpacing(java.lang.Float value)
Set the TextLetterSpacing property
|
void |
setTextMaxWidth(java.lang.Float value)
Set the TextMaxWidth property
|
void |
setTextOffset(android.graphics.PointF pointF)
Set the TextOffset property.
|
void |
setTextOpacity(java.lang.Float value)
Set the TextOpacity property
|
void |
setTextRadialOffset(java.lang.Float value)
Set the TextRadialOffset property
|
void |
setTextRotate(java.lang.Float value)
Set the TextRotate property
|
void |
setTextSize(java.lang.Float value)
Set the TextSize property
|
void |
setTextTransform(java.lang.String value)
Set the TextTransform property
|
equals, getData, getGeometry, getId, hashCode, isDraggable, setData, setDraggable, setGeometry, toStringpublic void setLatLng(LatLng latLng)
To update the symbol on the map use AnnotationManager.update(Annotation).
latLng - the location of the symbol in a latitude and longitude pairpublic LatLng getLatLng()
public java.lang.Float getSymbolSortKey()
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key when they overlap. Features with a lower sort key will have priority over other features when doing placement.
public void setSymbolSortKey(java.lang.Float value)
Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key when they overlap. Features with a lower sort key will have priority over other features when doing placement.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.Float getIconSize()
Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by PropertyFactory#iconSize. 1 is the original size; 3 triples the size of the image.
public void setIconSize(java.lang.Float value)
Scales the original size of the icon by the provided factor. The new pixel size of the image will be the original pixel size multiplied by PropertyFactory#iconSize. 1 is the original size; 3 triples the size of the image.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.String getIconImage()
Name of image in sprite to use for drawing an image background.
public void setIconImage(java.lang.String value)
Name of image in sprite to use for drawing an image background.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Stringpublic java.lang.Float getIconRotate()
Rotates the icon clockwise.
public void setIconRotate(java.lang.Float value)
Rotates the icon clockwise.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic android.graphics.PointF getIconOffset()
Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of PropertyFactory#iconSize to obtain the final offset in density-independent pixels. When combined with PropertyFactory#iconRotate the offset will be as if the rotated direction was up.
public void setIconOffset(android.graphics.PointF pointF)
Offset distance of icon from its anchor. Positive values indicate right and down, while negative values indicate left and up. Each component is multiplied by the value of PropertyFactory#iconSize to obtain the final offset in density-independent pixels. When combined with PropertyFactory#iconRotate the offset will be as if the rotated direction was up.
To update the symbol on the map use AnnotationManager.update(Annotation).
pointF - value for Float[]public java.lang.String getIconAnchor()
Part of the icon placed closest to the anchor.
public void setIconAnchor(java.lang.String value)
Part of the icon placed closest to the anchor.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Stringpublic java.lang.String getTextField()
Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options.
public void setTextField(java.lang.String value)
Value to use for a text label. If a plain `string` is provided, it will be treated as a `formatted` with default/inherited formatting options.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Stringpublic java.lang.String[] getTextFont()
Font stack to use for displaying text.
public void setTextFont(java.lang.String[] value)
Font stack to use for displaying text.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for String[]public java.lang.Float getTextSize()
Font size.
public void setTextSize(java.lang.Float value)
Font size.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.Float getTextMaxWidth()
The maximum line width for text wrapping.
public void setTextMaxWidth(java.lang.Float value)
The maximum line width for text wrapping.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.Float getTextLetterSpacing()
Text tracking amount.
public void setTextLetterSpacing(java.lang.Float value)
Text tracking amount.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.String getTextJustify()
Text justification options.
public void setTextJustify(java.lang.String value)
Text justification options.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Stringpublic java.lang.Float getTextRadialOffset()
Radial offset of text, in the direction of the symbol's anchor. Useful in combination with PropertyFactory#textVariableAnchor, which doesn't support the two-dimensional PropertyFactory#textOffset.
public void setTextRadialOffset(java.lang.Float value)
Radial offset of text, in the direction of the symbol's anchor. Useful in combination with PropertyFactory#textVariableAnchor, which doesn't support the two-dimensional PropertyFactory#textOffset.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.String getTextAnchor()
Part of the text placed closest to the anchor.
public void setTextAnchor(java.lang.String value)
Part of the text placed closest to the anchor.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Stringpublic java.lang.Float getTextRotate()
Rotates the text clockwise.
public void setTextRotate(java.lang.Float value)
Rotates the text clockwise.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.String getTextTransform()
Specifies how to capitalize text, similar to the CSS PropertyFactory#textTransform property.
public void setTextTransform(java.lang.String value)
Specifies how to capitalize text, similar to the CSS PropertyFactory#textTransform property.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Stringpublic android.graphics.PointF getTextOffset()
Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up.
public void setTextOffset(android.graphics.PointF pointF)
Offset distance of text from its anchor. Positive values indicate right and down, while negative values indicate left and up.
To update the symbol on the map use AnnotationManager.update(Annotation).
pointF - value for Float[]public java.lang.Float getIconOpacity()
The opacity at which the icon will be drawn.
public void setIconOpacity(java.lang.Float value)
The opacity at which the icon will be drawn.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic int getIconColorAsInt()
The color of the icon. This can only be used with sdf icons.
public java.lang.String getIconColor()
The color of the icon. This can only be used with sdf icons.
public void setIconColor(int color)
The color of the icon. This can only be used with sdf icons.
To update the symbol on the map use AnnotationManager.update(Annotation).
color - value for Stringpublic void setIconColor(java.lang.String color)
The color of the icon. This can only be used with sdf icons.
To update the symbol on the map use AnnotationManager.update(Annotation).
color - value for Stringpublic int getIconHaloColorAsInt()
The color of the icon's halo. Icon halos can only be used with SDF icons.
public java.lang.String getIconHaloColor()
The color of the icon's halo. Icon halos can only be used with SDF icons.
public void setIconHaloColor(int color)
The color of the icon's halo. Icon halos can only be used with SDF icons.
To update the symbol on the map use AnnotationManager.update(Annotation).
color - value for Stringpublic void setIconHaloColor(java.lang.String color)
The color of the icon's halo. Icon halos can only be used with SDF icons.
To update the symbol on the map use AnnotationManager.update(Annotation).
color - value for Stringpublic java.lang.Float getIconHaloWidth()
Distance of halo to the icon outline.
public void setIconHaloWidth(java.lang.Float value)
Distance of halo to the icon outline.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.Float getIconHaloBlur()
Fade out the halo towards the outside.
public void setIconHaloBlur(java.lang.Float value)
Fade out the halo towards the outside.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.Float getTextOpacity()
The opacity at which the text will be drawn.
public void setTextOpacity(java.lang.Float value)
The opacity at which the text will be drawn.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic int getTextColorAsInt()
The color with which the text will be drawn.
public java.lang.String getTextColor()
The color with which the text will be drawn.
public void setTextColor(int color)
The color with which the text will be drawn.
To update the symbol on the map use AnnotationManager.update(Annotation).
color - value for Stringpublic void setTextColor(java.lang.String color)
The color with which the text will be drawn.
To update the symbol on the map use AnnotationManager.update(Annotation).
color - value for Stringpublic int getTextHaloColorAsInt()
The color of the text's halo, which helps it stand out from backgrounds.
public java.lang.String getTextHaloColor()
The color of the text's halo, which helps it stand out from backgrounds.
public void setTextHaloColor(int color)
The color of the text's halo, which helps it stand out from backgrounds.
To update the symbol on the map use AnnotationManager.update(Annotation).
color - value for Stringpublic void setTextHaloColor(java.lang.String color)
The color of the text's halo, which helps it stand out from backgrounds.
To update the symbol on the map use AnnotationManager.update(Annotation).
color - value for Stringpublic java.lang.Float getTextHaloWidth()
Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
public void setTextHaloWidth(java.lang.Float value)
Distance of halo to the font outline. Max text halo width is 1/4 of the font-size.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Floatpublic java.lang.Float getTextHaloBlur()
The halo's fadeout distance towards the outside.
public void setTextHaloBlur(java.lang.Float value)
The halo's fadeout distance towards the outside.
To update the symbol on the map use AnnotationManager.update(Annotation).
value - constant property value for Float© 2015–2019 Mapbox. All rights reserved.