<SymbolTypes.h> - Symbol Enums

Collection of Symbol enumerations. More...

Header: #include <SymbolTypes.h>

Types

enum class	FontDecoration { LineThrough, None, Underline }
enum class	FontStyle { Italic, Normal, Oblique }
enum class	FontWeight { Bold, Normal }
enum class	GeometricEffectType { Unknown, DashGeometricEffect }
enum class	HorizontalAlignment { Center, Justify, Left, Right }
enum class	RendererClassificationMethod { DefinedInterval, EqualInterval, GeometricalInterval, NaturalBreaks, Quantile, …, Manual }
enum class	RendererNormalizationType { ByField, ByLog, ByPercentOfTotal, None }
enum class	RendererType { ClassBreaksRenderer, DictionaryRenderer, SimpleRenderer, UniqueValueRenderer, UnsupportedRenderer, …, Unknown }
enum class	RotationType { Arithmetic, Geographic }
enum class	SceneSymbolAnchorPosition { Top, Bottom, Center, Origin }
enum class	SimpleFillSymbolStyle { BackwardDiagonal, Cross, DiagonalCross, ForwardDiagonal, Horizontal, …, Vertical }
enum class	SimpleLineSymbolMarkerPlacement { Begin, End, BeginAndEnd }
enum class	SimpleLineSymbolMarkerStyle { None, Arrow }
enum class	SimpleLineSymbolStyle { Dash, DashDot, DashDotDot, Dot, Null, …, ShortDot }
enum class	SimpleMarkerSceneSymbolStyle { Cone, Cube, Cylinder, Diamond, Sphere, Tetrahedron }
enum class	SimpleMarkerSymbolStyle { Circle, Cross, Diamond, Square, Triangle, X }
enum class	StrokeSymbolLayerCapStyle { Butt, Round, Square }
enum class	StrokeSymbolLayerLineStyle3D { Tube, Strip }
enum class	SymbolAnchorPlacementMode { Relative, Absolute }
enum class	SymbolAngleAlignment { Map, Screen }
enum class	SymbolLayerType { Unknown, SymbolLayer, MarkerSymbolLayer, VectorMarkerSymbolLayer, StrokeSymbolLayer, …, HatchFillSymbolLayer }
enum class	SymbolSizeUnits { DIPs, Meters }
enum class	SymbolStyleType { DictionarySymbolStyle, SymbolStyle, Unknown }
enum class	SymbolType { SimpleFillSymbol, SimpleLineSymbol, SimpleMarkerSymbol, PictureMarkerSymbol, TextSymbol, …, Unknown }
enum class	VerticalAlignment { Baseline, Bottom, Middle, Top }

Detailed Description

Type Documentation

enum class FontDecoration

Enumerates various font decorations that can be applied to text symbols.

The FontDecoration can be one of:

Constant	Value	Description
`FontDecoration::LineThrough`	`0`	Draw a line through the text.
`FontDecoration::None`	`1`	No decoration on the text.
`FontDecoration::Underline`	`2`	Underline the text.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class FontStyle

Enumerates various styles that can be applied to the font of a text symbol.

The FontStyle can be one of:

Constant	Value	Description
`FontStyle::Italic`	`0`	Italic style applied (characters lean forwards, bottom left to top right: /).
`FontStyle::Normal`	`1`	No style applied.
`FontStyle::Oblique`	`2`	Oblique style applied (characters lean back, bottom right to top left: ).

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class FontWeight

Enumerates the weight applied to the font of a text symbol.

The FontWeight can be one of:

Constant	Value	Description
`FontWeight::Bold`	`0`	Font will be rendered bold.
`FontWeight::Normal`	`1`	Font will be rendered with its normal weight.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class GeometricEffectType

Enumerates the type of geometric effect stored in a GeometricEffect object.

The GeometricEffectType can be one of:

Constant	Value	Description
`GeometricEffectType::Unknown`	`-1`	An unknown type.
`GeometricEffectType::DashGeometricEffect`	`0`	Dash geometric effect.

This enum was introduced or modified in Esri::ArcGISRuntime 100.5.

See also Esri::ArcGISRuntime::GeometricEffectType.

enum class HorizontalAlignment

Enumerates the text's horizontal alignment relative to the symbol's point coordinate.

The HorizontalAlignment can be one of:

Constant	Value	Description
`HorizontalAlignment::Center`	`0`	Text is center aligned.
`HorizontalAlignment::Justify`	`1`	Text is aligned along the left margin, and spacing is adjusted so that the text falls flush with both margins.
`HorizontalAlignment::Left`	`2`	Text is left aligned.
`HorizontalAlignment::Right`	`3`	Text is right aligned.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class RendererClassificationMethod

Enumerates the type of classification methods used to generate class breaks.

The RendererClassificationMethod can be one of:

Constant	Value	Description
`RendererClassificationMethod::DefinedInterval`	`0`	Defined interval classification.
`RendererClassificationMethod::EqualInterval`	`1`	Equal interval classification.
`RendererClassificationMethod::GeometricalInterval`	`2`	Geometrical interval classification.
`RendererClassificationMethod::NaturalBreaks`	`3`	Natural breaks classification.
`RendererClassificationMethod::Quantile`	`4`	Quantile classification.
`RendererClassificationMethod::StandardDeviation`	`5`	Standard deviation classification.
`RendererClassificationMethod::Manual`	`6`	Manual classification.

This enum was introduced or modified in Esri::ArcGISRuntime 100.2.

enum class RendererNormalizationType

Enumerates the type of normalization used in a class breaks renderer.

The RendererNormalizationType can be one of:

Constant	Value	Description
`RendererNormalizationType::ByField`	`0`	Normalize the data by a field.
`RendererNormalizationType::ByLog`	`1`	Normalize the data by log.
`RendererNormalizationType::ByPercentOfTotal`	`2`	Normalize the data by the normalizationTotal.
`RendererNormalizationType::None`	`3`	No normalization is used.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class RendererType

Enumerates the type of renderer.

The RendererType can be one of:

Constant	Value	Description
`RendererType::ClassBreaksRenderer`	`0`	A class breaks renderer.
`RendererType::DictionaryRenderer`	`1`	A dictionary renderer.
`RendererType::SimpleRenderer`	`2`	A simple renderer.
`RendererType::UniqueValueRenderer`	`3`	A unique value renderer.
`RendererType::UnsupportedRenderer`	`4`	An unsupported renderer.
`RendererType::HeatmapRenderer`	`5`	A heatmap renderer.
`RendererType::Unknown`	`-1`	An unknown renderer.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class RotationType

Enumerates the type of rotation applied to symbols.

The RotationType can be one of:

Constant	Value	Description
`RotationType::Arithmetic`	`0`	Rotation is from zero on the x-axis (east) with positive rotation counterclockwise.
`RotationType::Geographic`	`1`	Rotation is from zero on the y-axis (north) with positive rotation clockwise.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SceneSymbolAnchorPosition

Enumerates the anchor position for scene symbols.

The SceneSymbolAnchorPosition can be one of:

Constant	Value	Description
`SceneSymbolAnchorPosition::Top`	`0`	The symbol is above its geographic location.
`SceneSymbolAnchorPosition::Bottom`	`1`	The symbol is below its geographic location.
`SceneSymbolAnchorPosition::Center`	`2`	The symbol is centered on its geographic location.
`SceneSymbolAnchorPosition::Origin`	`3`	The symbol's origin is positioned at its geographic location.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SimpleFillSymbolStyle

Enumerates the fill style for simple fill symbols.

The SimpleFillSymbolStyle can be one of:

Constant	Value	Description
`SimpleFillSymbolStyle::BackwardDiagonal`	`0`	Backwards diagonal lines fill.
`SimpleFillSymbolStyle::Cross`	`1`	Horizontal/vertical lines fill.
`SimpleFillSymbolStyle::DiagonalCross`	`2`	Backwards/forwards diagonal lines fill.
`SimpleFillSymbolStyle::ForwardDiagonal`	`3`	Forwards diagonal lines fill.
`SimpleFillSymbolStyle::Horizontal`	`4`	Horizontal lines fill.
`SimpleFillSymbolStyle::Null`	`5`	No fill.
`SimpleFillSymbolStyle::Solid`	`6`	Solid fill.
`SimpleFillSymbolStyle::Vertical`	`7`	Vertical lines fill.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SimpleLineSymbolMarkerPlacement

Enumerates the locations a Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle can be applied to a Esri::ArcGISRuntime::SimpleLineSymbol.

The SimpleLineSymbolMarkerPlacement can be one of:

Constant	Value	Description
`SimpleLineSymbolMarkerPlacement::Begin`	`0`	The Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle is applied to the beginning of the line symbol.
`SimpleLineSymbolMarkerPlacement::End`	`1`	The Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle is applied to the end of the line symbol.
`SimpleLineSymbolMarkerPlacement::BeginAndEnd`	`2`	The Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle is applied to the beginning and end of the line symbol.

This enum was introduced or modified in Esri::ArcGISRuntime 100.2.

enum class SimpleLineSymbolMarkerStyle

Enumerates the type of marker styles which can be applied to the ends of a Esri::ArcGISRuntime::SimpleLineSymbol.

The SimpleLineSymbolMarkerStyle can be one of:

Constant	Value	Description
`SimpleLineSymbolMarkerStyle::None`	`0`	Nothing is applied to either end of the line symbol.
`SimpleLineSymbolMarkerStyle::Arrow`	`1`	Arrow heads are applied to the one or both ends of the line symbol.

This enum was introduced or modified in Esri::ArcGISRuntime 100.2.

enum class SimpleLineSymbolStyle

Enumerates the line style for simple line symbols.

The SimpleLineSymbolStyle can be one of:

Constant	Value	Description
`SimpleLineSymbolStyle::Dash`	`0`	Repeating dash pattern.
`SimpleLineSymbolStyle::DashDot`	`1`	Repeating dash dot pattern.
`SimpleLineSymbolStyle::DashDotDot`	`2`	Repeating dash dot dot pattern.
`SimpleLineSymbolStyle::Dot`	`3`	Repeating dot pattern.
`SimpleLineSymbolStyle::Null`	`4`	Invisible line.
`SimpleLineSymbolStyle::Solid`	`5`	Solid line.
`SimpleLineSymbolStyle::LongDash`	`6`	Dash line with long dash.
`SimpleLineSymbolStyle::LongDashDot`	`7`	Dash dot line with long dash.
`SimpleLineSymbolStyle::ShortDash`	`8`	Dash line with short gaps.
`SimpleLineSymbolStyle::ShortDashDot`	`9`	Dash dot line with short gaps.
`SimpleLineSymbolStyle::ShortDashDotDot`	`10`	Dash dot dot line with short gaps.
`SimpleLineSymbolStyle::ShortDot`	`11`	Dot line with short gaps.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SimpleMarkerSceneSymbolStyle

Enumerates the marker style for simple marker scene symbols.

The SimpleMarkerSceneSymbolStyle can be one of:

Constant	Value	Description
`SimpleMarkerSceneSymbolStyle::Cone`	`0`	The marker is a cone.
`SimpleMarkerSceneSymbolStyle::Cube`	`1`	The marker is a cube.
`SimpleMarkerSceneSymbolStyle::Cylinder`	`2`	The marker is a cylinder.
`SimpleMarkerSceneSymbolStyle::Diamond`	`3`	The marker is a diamond.
`SimpleMarkerSceneSymbolStyle::Sphere`	`4`	The marker is a sphere.
`SimpleMarkerSceneSymbolStyle::Tetrahedron`	`5`	The marker is a tetrahedron.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SimpleMarkerSymbolStyle

Enumerates the marker style for simple marker symbols.

The SimpleMarkerSymbolStyle can be one of:

Constant	Value	Description
`SimpleMarkerSymbolStyle::Circle`	`0`	The marker is a circle.
`SimpleMarkerSymbolStyle::Cross`	`1`	The marker is a cross (+).
`SimpleMarkerSymbolStyle::Diamond`	`2`	The marker is a diamond.
`SimpleMarkerSymbolStyle::Square`	`3`	The marker is a square.
`SimpleMarkerSymbolStyle::Triangle`	`4`	The marker is a triangle.
`SimpleMarkerSymbolStyle::X`	`5`	The marker is a diagonal cross (X).

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class StrokeSymbolLayerCapStyle

Enumerates the list of possible cap styles.

The cap style describes the way that line symbol layers will terminate when combined with a geometry. The term "cap" refers to the end of the line. The options here control the shape that cap will take.

The StrokeSymbolLayerCapStyle can be one of:

Constant	Value	Description
`StrokeSymbolLayerCapStyle::Butt`	`0`	Applying the "butt" cap style will terminate the line ending exactly where the geometry ends. The end cap will be squared off. That is, two 90 degree angles form a butted ending to the symbol. In dynamic rendering mode, caps are always rendered with the `StrokeSymbolLayerCapStyle::Butt` style.
`StrokeSymbolLayerCapStyle::Round`	`1`	Applying the "round" cap style will terminate the line ending with a semicircle of radius equal to the stroke width. That semicircle will be centered at the line endpoint.
`StrokeSymbolLayerCapStyle::Square`	`2`	Applying the "square" cap style will extend the termination of the line ending past the end of the geometry. The end cap will be squared off. That is, two 90 degree angles form a squared ending to the symbol.

This enum was introduced or modified in Esri::ArcGISRuntime 100.5.

See also Esri::ArcGISRuntime::StrokeSymbolLayerCapStyle.

enum class StrokeSymbolLayerLineStyle3D

Enumerates the type of line styles in a Esri::ArcGISRuntime::StrokeSymbolLayer.

The StrokeSymbolLayerLineStyle3D can be one of:

Constant	Value	Description
`StrokeSymbolLayerLineStyle3D::Tube`	`0`	The tube style causes the stroke to appear as a 3D tube. A "tube" here refers to a solid circular cylinder, following the given geometry.
`StrokeSymbolLayerLineStyle3D::Strip`	`1`	The strip style causes the stroke to appear as a flat strip of surface. Note that the cap style for this line is always `StrokeSymbolLayerCapStyle::Butt`. A "strip" here refers to a flat 2D surface with more significant width than a line, though it is presented in 3D. Only the `StrokeSymbolLayerLineStyle3D::Strip` style is supported in static rendering mode.

This enum was introduced or modified in Esri::ArcGISRuntime 100.5.

See also Esri::ArcGISRuntime::StrokeSymbolLayerLineStyle3D.

enum class SymbolAnchorPlacementMode

Enumerates the type of placement modes in a Esri::ArcGISRuntime::SymbolAnchor.

The SymbolAnchorPlacementMode can be one of:

Constant	Value	Description
`SymbolAnchorPlacementMode::Relative`	`0`	Specify anchor with relative values. This mode causes anchor values to be interpreted as percentages relative to the origin of the symbol. Percentage values must be expressed as fractions between [`0`, `1`]. A 50% (.5) x-anchor, for example, moves the symbol layer anchor in the positive-x direction an amount equal to 50% of the symbol layer size.
`SymbolAnchorPlacementMode::Absolute`	`1`	Specify anchor with absolute values. This mode causes anchor values to be interpreted as absolute units (DIPs) rather than percentages.

This enum was introduced or modified in Esri::ArcGISRuntime 100.5.

See also Esri::ArcGISRuntime::SymbolAnchorPlacementMode.

enum class SymbolAngleAlignment

Enumerates whether the rotation of a marker symbol is relative to the map or the screen.

Note: This enumeration is only applicable for 2D and is not supported in 3D.

The SymbolAngleAlignment can be one of:

Constant	Value	Description
`SymbolAngleAlignment::Map`	`0`	Symbol rotation is relative to the map and will be affected by the map's rotation.
`SymbolAngleAlignment::Screen`	`1`	Symbol rotation is relative to the screen and will not be affected by the map's rotation.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SymbolLayerType

Enumerates the type of symbol layer stored in a SymbolLayer object.

The SymbolLayerType can be one of:

Constant	Value	Description
`SymbolLayerType::Unknown`	`-1`	An unknown value. This value typically indicates an error has occurred.
`SymbolLayerType::SymbolLayer`	`0`	The base symbol layer type.
`SymbolLayerType::MarkerSymbolLayer`	`1`	Marker symbol layer.
`SymbolLayerType::VectorMarkerSymbolLayer`	`2`	Vector marker symbol layer.
`SymbolLayerType::StrokeSymbolLayer`	`3`	Stroke symbol layer.
`SymbolLayerType::SolidStrokeSymbolLayer`	`4`	Solid stroke symbol layer.
`SymbolLayerType::PictureMarkerSymbolLayer`	`5`	Picture marker symbol layer.
`SymbolLayerType::FillSymbolLayer`	`6`	Fill symbol layer.
`SymbolLayerType::SolidFillSymbolLayer`	`7`	Solid fill symbol layer.
`SymbolLayerType::PictureFillSymbolLayer`	`8`	Picture fill symbol layer.
`SymbolLayerType::HatchFillSymbolLayer`	`9`	Hatch fill symbol layer.

This enum was introduced or modified in Esri::ArcGISRuntime 100.5.

See also Esri::ArcGISRuntime::SymbolLayerType.

enum class SymbolSizeUnits

The list of possible size units for symbols.

The SymbolSizeUnits can be one of:

Constant	Value	Description
`SymbolSizeUnits::DIPs`	`0`	Render the affected symbol by interpreting the size values as DIPs. Symbols in this mode remain the same size on the screen even as the display is zoomed in or out.
`SymbolSizeUnits::Meters`	`1`	Render the affected symbol by interpreting the size values as meters. Symbols in this mode remain the same world space size even if the display is zoomed in or out.

This enum was introduced or modified in Esri::ArcGISRuntime 100.5.

See also Esri::ArcGISRuntime::SymbolSizeUnits.

enum class SymbolStyleType

Enumerates the type of SymbolStyle.

The SymbolStyleType can be one of:

Constant	Value	Description
`SymbolStyleType::DictionarySymbolStyle`	`0`	A DictionarySymbolStyle.
`SymbolStyleType::SymbolStyle`	`1`	A SymbolStyle base type.
`SymbolStyleType::Unknown`	`-1`	Unknown SymbolStyle.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class SymbolType

Enumerates the type of symbol stored in a Symbol object.

The SymbolType can be one of:

Constant	Value	Description
`SymbolType::SimpleFillSymbol`	`0`	Simple fill symbol.
`SymbolType::SimpleLineSymbol`	`1`	Simple line symbol.
`SymbolType::SimpleMarkerSymbol`	`2`	Simple marker symbol.
`SymbolType::PictureMarkerSymbol`	`3`	Picture marker symbol.
`SymbolType::TextSymbol`	`4`	Text symbol.
`SymbolType::SimpleMarkerSceneSymbol`	`5`	Simple marker scene symbol.
`SymbolType::ModelSceneSymbol`	`6`	Model scene symbol.
`SymbolType::DistanceCompositeSceneSymbol`	`7`	Distance composite scene symbol.
`SymbolType::UnsupportedSymbol`	`8`	Unsupported symbol type.
`SymbolType::CompositeSymbol`	`9`	Composite symbol.
`SymbolType::PictureFillSymbol`	`10`	Picture fill symbol.
`SymbolType::MultilayerPointSymbol`	`11`	Multi-layer point symbol.
`SymbolType::MultilayerPolylineSymbol`	`12`	Multi-layer polyline symbol.
`SymbolType::MultilayerPolygonSymbol`	`13`	Multi-layer polygon symbol.
`SymbolType::Unknown`	`-1`	Unknown symbol type.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.

enum class VerticalAlignment

Enumerates the text's vertical alignment relative to the symbol's point coordinate.

The VerticalAlignment can be one of:

Constant	Value	Description
`VerticalAlignment::Baseline`	`0`	Text is aligned at the baseline.
`VerticalAlignment::Bottom`	`1`	Text is bottom aligned.
`VerticalAlignment::Middle`	`2`	Text is middle aligned.
`VerticalAlignment::Top`	`3`	Text is top aligned.

This enum was introduced or modified in Esri::ArcGISRuntime 100.0.