<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

[since Esri::ArcGISRuntime 100.0] enum class FontDecoration

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

The FontDecoration can be one of:

ConstantValueDescription
FontDecoration::LineThrough0Draw a line through the text.
FontDecoration::None1No decoration on the text.
FontDecoration::Underline2Underline the text.

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

[since 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:

ConstantValueDescription
FontStyle::Italic0Italic style applied (characters lean forwards, bottom left to top right: /).
FontStyle::Normal1No style applied.
FontStyle::Oblique2Oblique style applied (characters lean back, bottom right to top left: ).

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

[since Esri::ArcGISRuntime 100.0] enum class FontWeight

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

The FontWeight can be one of:

ConstantValueDescription
FontWeight::Bold0Font will be rendered bold.
FontWeight::Normal1Font will be rendered with its normal weight.

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

[since Esri::ArcGISRuntime 100.5] enum class GeometricEffectType

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

The GeometricEffectType can be one of:

ConstantValueDescription
GeometricEffectType::Unknown-1An unknown type.
GeometricEffectType::DashGeometricEffect0Dash geometric effect.

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

See also Esri::ArcGISRuntime::GeometricEffectType.

[since Esri::ArcGISRuntime 100.0] enum class HorizontalAlignment

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

The HorizontalAlignment can be one of:

ConstantValueDescription
HorizontalAlignment::Center0Text is center aligned.
HorizontalAlignment::Justify1Text is aligned along the left margin, and spacing is adjusted so that the text falls flush with both margins.
HorizontalAlignment::Left2Text is left aligned.
HorizontalAlignment::Right3Text is right aligned.

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

[since Esri::ArcGISRuntime 100.2] enum class RendererClassificationMethod

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

The RendererClassificationMethod can be one of:

ConstantValueDescription
RendererClassificationMethod::DefinedInterval0Defined interval classification.
RendererClassificationMethod::EqualInterval1Equal interval classification.
RendererClassificationMethod::GeometricalInterval2Geometrical interval classification.
RendererClassificationMethod::NaturalBreaks3Natural breaks classification.
RendererClassificationMethod::Quantile4Quantile classification.
RendererClassificationMethod::StandardDeviation5Standard deviation classification.
RendererClassificationMethod::Manual6Manual classification.

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

[since Esri::ArcGISRuntime 100.0] enum class RendererNormalizationType

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

The RendererNormalizationType can be one of:

ConstantValueDescription
RendererNormalizationType::ByField0Normalize the data by a field.
RendererNormalizationType::ByLog1Normalize the data by log.
RendererNormalizationType::ByPercentOfTotal2Normalize the data by the normalizationTotal.
RendererNormalizationType::None3No normalization is used.

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

[since Esri::ArcGISRuntime 100.0] enum class RendererType

Enumerates the type of renderer.

The RendererType can be one of:

ConstantValueDescription
RendererType::ClassBreaksRenderer0A class breaks renderer.
RendererType::DictionaryRenderer1A dictionary renderer.
RendererType::SimpleRenderer2A simple renderer.
RendererType::UniqueValueRenderer3A unique value renderer.
RendererType::UnsupportedRenderer4An unsupported renderer.
RendererType::HeatmapRenderer5A heatmap renderer.
RendererType::Unknown-1An unknown renderer.

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

[since Esri::ArcGISRuntime 100.0] enum class RotationType

Enumerates the list of possible rotation types.

Controls the origin and direction of rotation for a symbol.

The RotationType can be one of:

ConstantValueDescription
RotationType::Arithmetic0Rotation is from zero on the x-axis (east) with positive rotation counterclockwise.
RotationType::Geographic1Rotation is from zero on the y-axis (north) with positive rotation clockwise.

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

[since Esri::ArcGISRuntime 100.0] enum class SceneSymbolAnchorPosition

Enumerates the anchor position for scene symbols.

The SceneSymbolAnchorPosition can be one of:

ConstantValueDescription
SceneSymbolAnchorPosition::Top0The symbol is above its geographic location.
SceneSymbolAnchorPosition::Bottom1The symbol is below its geographic location.
SceneSymbolAnchorPosition::Center2The symbol is centered on its geographic location.
SceneSymbolAnchorPosition::Origin3The symbol's origin is positioned at its geographic location.

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

[since Esri::ArcGISRuntime 100.0] enum class SimpleFillSymbolStyle

Enumerates the fill style for simple fill symbols.

The SimpleFillSymbolStyle can be one of:

ConstantValueDescription
SimpleFillSymbolStyle::BackwardDiagonal0Backwards diagonal lines fill.
SimpleFillSymbolStyle::Cross1Horizontal/vertical lines fill.
SimpleFillSymbolStyle::DiagonalCross2Backwards/forwards diagonal lines fill.
SimpleFillSymbolStyle::ForwardDiagonal3Forwards diagonal lines fill.
SimpleFillSymbolStyle::Horizontal4Horizontal lines fill.
SimpleFillSymbolStyle::Null5No fill.
SimpleFillSymbolStyle::Solid6Solid fill.
SimpleFillSymbolStyle::Vertical7Vertical lines fill.

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

[since Esri::ArcGISRuntime 100.2] enum class SimpleLineSymbolMarkerPlacement

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

The SimpleLineSymbolMarkerPlacement can be one of:

ConstantValueDescription
SimpleLineSymbolMarkerPlacement::Begin0The Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle is applied to the beginning of the line symbol.
SimpleLineSymbolMarkerPlacement::End1The Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle is applied to the end of the line symbol.
SimpleLineSymbolMarkerPlacement::BeginAndEnd2The 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.

See also Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle.

[since 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:

ConstantValueDescription
SimpleLineSymbolMarkerStyle::None0Nothing is applied to either end of the line symbol.
SimpleLineSymbolMarkerStyle::Arrow1Arrow heads are applied to the one or both ends of the line symbol.

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

See also Esri::ArcGISRuntime::SimpleLineSymbolMarkerPlacement.

[since Esri::ArcGISRuntime 100.0] enum class SimpleLineSymbolStyle

Enumerates the line style for simple line symbols.

The SimpleLineSymbolStyle can be one of:

ConstantValueDescription
SimpleLineSymbolStyle::Dash0Repeating dash pattern.
SimpleLineSymbolStyle::DashDot1Repeating dash dot pattern.
SimpleLineSymbolStyle::DashDotDot2Repeating dash dot dot pattern.
SimpleLineSymbolStyle::Dot3Repeating dot pattern.
SimpleLineSymbolStyle::Null4Invisible line.
SimpleLineSymbolStyle::Solid5Solid line.
SimpleLineSymbolStyle::LongDash6Dash line with long dash.
SimpleLineSymbolStyle::LongDashDot7Dash dot line with long dash.
SimpleLineSymbolStyle::ShortDash8Dash line with short gaps.
SimpleLineSymbolStyle::ShortDashDot9Dash dot line with short gaps.
SimpleLineSymbolStyle::ShortDashDotDot10Dash dot dot line with short gaps.
SimpleLineSymbolStyle::ShortDot11Dot line with short gaps.

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

[since Esri::ArcGISRuntime 100.0] enum class SimpleMarkerSceneSymbolStyle

Enumerates the marker style for simple marker scene symbols.

The SimpleMarkerSceneSymbolStyle can be one of:

ConstantValueDescription
SimpleMarkerSceneSymbolStyle::Cone0The marker is a cone.
SimpleMarkerSceneSymbolStyle::Cube1The marker is a cube.
SimpleMarkerSceneSymbolStyle::Cylinder2The marker is a cylinder.
SimpleMarkerSceneSymbolStyle::Diamond3The marker is a diamond.
SimpleMarkerSceneSymbolStyle::Sphere4The marker is a sphere.
SimpleMarkerSceneSymbolStyle::Tetrahedron5The marker is a tetrahedron.

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

[since Esri::ArcGISRuntime 100.0] enum class SimpleMarkerSymbolStyle

Enumerates the marker style for simple marker symbols.

The SimpleMarkerSymbolStyle can be one of:

ConstantValueDescription
SimpleMarkerSymbolStyle::Circle0The marker is a circle.
SimpleMarkerSymbolStyle::Cross1The marker is a cross (+).
SimpleMarkerSymbolStyle::Diamond2The marker is a diamond.
SimpleMarkerSymbolStyle::Square3The marker is a square.
SimpleMarkerSymbolStyle::Triangle4The marker is a triangle.
SimpleMarkerSymbolStyle::X5The marker is a diagonal cross (X).

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

[since Esri::ArcGISRuntime 100.5] 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:

ConstantValueDescription
StrokeSymbolLayerCapStyle::Butt0Applying 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::Round1Applying 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::Square2Applying 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.

[since Esri::ArcGISRuntime 100.5] enum class StrokeSymbolLayerLineStyle3D

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

The StrokeSymbolLayerLineStyle3D can be one of:

ConstantValueDescription
StrokeSymbolLayerLineStyle3D::Tube0The 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::Strip1The 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.

[since Esri::ArcGISRuntime 100.5] enum class SymbolAnchorPlacementMode

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

The SymbolAnchorPlacementMode can be one of:

ConstantValueDescription
SymbolAnchorPlacementMode::Relative0Specify 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::Absolute1Specify 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.

[since Esri::ArcGISRuntime 100.0] 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:

ConstantValueDescription
SymbolAngleAlignment::Map0Symbol rotation is relative to the map and will be affected by the map's rotation.
SymbolAngleAlignment::Screen1Symbol 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.

[since Esri::ArcGISRuntime 100.5] enum class SymbolLayerType

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

The SymbolLayerType can be one of:

ConstantValueDescription
SymbolLayerType::Unknown-1An unknown value. This value typically indicates an error has occurred.
SymbolLayerType::SymbolLayer0The base symbol layer type.
SymbolLayerType::MarkerSymbolLayer1Marker symbol layer.
SymbolLayerType::VectorMarkerSymbolLayer2Vector marker symbol layer.
SymbolLayerType::StrokeSymbolLayer3Stroke symbol layer.
SymbolLayerType::SolidStrokeSymbolLayer4Solid stroke symbol layer.
SymbolLayerType::PictureMarkerSymbolLayer5Picture marker symbol layer.
SymbolLayerType::FillSymbolLayer6Fill symbol layer.
SymbolLayerType::SolidFillSymbolLayer7Solid fill symbol layer.
SymbolLayerType::PictureFillSymbolLayer8Picture fill symbol layer.
SymbolLayerType::HatchFillSymbolLayer9Hatch fill symbol layer.

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

See also Esri::ArcGISRuntime::SymbolLayerType.

[since Esri::ArcGISRuntime 100.5] enum class SymbolSizeUnits

The list of possible size units for symbols.

The SymbolSizeUnits can be one of:

ConstantValueDescription
SymbolSizeUnits::DIPs0Render 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::Meters1Render 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.

[since Esri::ArcGISRuntime 100.0] enum class SymbolStyleType

Enumerates the type of SymbolStyle.

The SymbolStyleType can be one of:

ConstantValueDescription
SymbolStyleType::DictionarySymbolStyle0A DictionarySymbolStyle.
SymbolStyleType::SymbolStyle1A SymbolStyle base type.
SymbolStyleType::Unknown-1Unknown SymbolStyle.

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

[since Esri::ArcGISRuntime 100.0] enum class SymbolType

Enumerates the type of symbol stored in a Symbol object.

The SymbolType can be one of:

ConstantValueDescription
SymbolType::SimpleFillSymbol0Simple fill symbol.
SymbolType::SimpleLineSymbol1Simple line symbol.
SymbolType::SimpleMarkerSymbol2Simple marker symbol.
SymbolType::PictureMarkerSymbol3Picture marker symbol.
SymbolType::TextSymbol4Text symbol.
SymbolType::SimpleMarkerSceneSymbol5Simple marker scene symbol.
SymbolType::ModelSceneSymbol6Model scene symbol.
SymbolType::DistanceCompositeSceneSymbol7Distance composite scene symbol.
SymbolType::UnsupportedSymbol8Unsupported symbol type.
SymbolType::CompositeSymbol9Composite symbol.
SymbolType::PictureFillSymbol10Picture fill symbol.
SymbolType::MultilayerPointSymbol11Multi-layer point symbol.
SymbolType::MultilayerPolylineSymbol12Multi-layer polyline symbol.
SymbolType::MultilayerPolygonSymbol13Multi-layer polygon symbol.
SymbolType::Unknown-1Unknown symbol type.

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

[since 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:

ConstantValueDescription
VerticalAlignment::Baseline0Text is aligned at the baseline.
VerticalAlignment::Bottom1Text is bottom aligned.
VerticalAlignment::Middle2Text is middle aligned.
VerticalAlignment::Top3Text is top aligned.

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.