arcgis-maps-kotlin/com.arcgismaps.mapping.symbology/TextSymbol

TextSymbol

Defines how text is displayed using characteristics such as font, size, color, and position. To display text in a MapView or SceneView, create a TextSymbol. Specify whether a string or attribute value is displayed by the TextSymbol.text. Define the appearance and position of the text using TextSymbol.color, TextSymbol.size, TextSymbol.fontStyle, or TextSymbol.verticalAlignment, for example. Position the text by applying it to a Graphic based on any type of geometry - point, multipoint, polyline, or polygon. Add the graphic to the GraphicsOverlay.graphics collection and add the GraphicsOverlay to the MapView or SceneView collection of graphics overlays.

TextSymbol is also used to define the appearance of layer and grid based labels:

Layers such as FeatureLayer, ArcGISSceneLayer, or DynamicEntityLayer contain label definitions that specify how labels are displayed. You can use LabelDefinition.textSymbol to define a label appearance within a scale range. To display these labels, add a collection of these label definitions to a layer.
MapView can display a coordinate system grid with specific label styles at different resolutions. You can define the appearance of these labels using Grid.setTextSymbol(Int, Symbol).

Since

200.1.0

Constructors

TextSymbol

fun TextSymbol()

Creates a text symbol with default values. The default values are:

TextSymbol

fun TextSymbol(text: String, color: Color, size: Float, horizontalAlignment: HorizontalAlignment, verticalAlignment: VerticalAlignment)

Creates a text symbol with the given size, text, and color along with the horizontal and vertical alignment relative to the mid-point of this symbol.

Properties

backgroundColor

var backgroundColor: Color

The color for the text symbol background. The default value is transparent.

color

var color: Color

The color for the text symbol. The default value is black.

fontDecoration

var fontDecoration: FontDecoration

The type of font decoration for the text symbol. The default value is FontDecoration.None. FontDecoration.None if an error occurs.

fontFamily

var fontFamily: String

The font family of the text symbol. This can be as specific as 'arial' or as generic as 'sans-serif', for example.

fontStyle

var fontStyle: FontStyle

The font style of the text symbol. The default value is FontStyle.Normal. Returns FontStyle.Normal if an error occurs.

fontWeight

var fontWeight: FontWeight

The font weight of the text symbol. Font weight describes how thick or thin characters in text are displayed. The default value is FontWeight.Normal. Returns FontWeight.Normal if an error occurs.

haloColor

var haloColor: Color?

The color for the halo around the text symbol. The default value is transparent.

haloWidth

var haloWidth: Float

The size of the halo around the text symbol in device-independent pixels (DIPs). The default value is 0.0.

horizontalAlignment

var horizontalAlignment: HorizontalAlignment

The horizontal alignment of the text symbol relative to the symbol's mid-point location. The default value is HorizontalAlignment.Center. Returns HorizontalAlignment.Center if an error occurs.

kerningEnabled

var kerningEnabled: Boolean

If kerning needs to be enabled. It is disabled by default. Determines whether to adjust the spacing between characters in the text string.

outlineColor

var outlineColor: Color?

The color for the text symbol outline.

outlineWidth

var outlineWidth: Float

The width of the text symbol outline in device-independent pixels (DIPs). The default value is 0.0.

size

var size: Float

The font size of the text symbol. The default value is 8.0.

text

var text: String

The text of the text symbol. The default value is an empty string.

verticalAlignment

var verticalAlignment: VerticalAlignment

The vertical alignment of the text symbol relative to the symbol's mid-point location. The default value is VerticalAlignment.Middle. Returns VerticalAlignment.Middle if an error occurs.

Inherited properties

angle

var angle: Float

The angle (in degrees) that the marker symbol is rotated by. The marker symbol can be rotated relative to the map or the screen, depending on the MarkerSymbol.angleAlignment.

angleAlignment

var angleAlignment: SymbolAngleAlignment

Indicates whether the marker symbol is rotated relative to the screen or map. If the value is SymbolAngleAlignment.Map, the marker symbol is rotated relative to the map and will be affected by the map's rotation. If the value is SymbolAngleAlignment.Screen, the marker symbol is rotated relative to the user's screen and is unaffected by the map's rotation.

leaderOffsetX

var leaderOffsetX: Float

The callout's leader offset X relative to the marker symbol.

leaderOffsetY

var leaderOffsetY: Float

The callout's leader offset Y relative to the marker symbol.

offsetX

var offsetX: Float

The offset X of the marker symbol relative to the graphic or feature's point geometry.

offsetY

var offsetY: Float

The offset Y of the marker symbol relative to the graphic or feature's point geometry.

Functions

clone

open override fun clone(): TextSymbol

Clones the TextSymbol.

equals

open operator override fun equals(other: Any?): Boolean

Inherited functions

createSwatch

suspend fun createSwatch(screenScale: Float, width: Float? = null, height: Float? = null, backgroundColor: Color = Color.transparent): Result<BitmapDrawable>

Creates a swatch of the symbol. This method will scale the symbol up or down in order to fit it in to the desired width and height of the swatch.

suspend fun createSwatch(screenScale: Float, width: Float, height: Float, geometry: Geometry, backgroundColor: Color = Color.transparent): Result<BitmapDrawable>

Creates a swatch of the symbol.

hashCode

open override fun hashCode(): Int

toJson

open override fun toJson(): String

Convert an object to JSON string.

TextSymbol

Since

See also

Constructors

Properties

Inherited properties

Functions

Inherited functions