<SymbolTypes.h> - Symbol Enums

Collection of Symbol enumerations. More...

Header: #include <SymbolTypes.h>

Types

enum class ColorMixMode { Multiply, Replace, Tint }
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, …, MaterialFillSymbolLayer }
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 200.5] enum class ColorMixMode

Specifies how the color is applied to the underlying geometry color/texture.

The ColorMixMode can be one of:

ConstantValueDescription
ColorMixMode::Multiply0Multiplies geometry/texture color value with the color value. The result is a darker color. Multiplying with white keeps the geometry color the same.
ColorMixMode::Replace1Removes the geometry/texture color and applies the color.
ColorMixMode::Tint2Applies the color to the de-saturated geometry/texture color.

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

[since Esri::ArcGISRuntime 100.0] enum class FontDecoration

The list of possible font decorations.

Enum to represent decoration of font supported by ArcGIS Server.

The FontDecoration can be one of:

ConstantValueDescription
FontDecoration::LineThrough0A line is drawn through the text.
FontDecoration::None1No decoration is made to the text.
FontDecoration::Underline2The text is underlined.

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

[since Esri::ArcGISRuntime 100.0] enum class FontStyle

The list of possible font styles.

Enum to represent style of font supported by ArcGIS Server.

The FontStyle can be one of:

ConstantValueDescription
FontStyle::Italic0The text is italicized.
FontStyle::Normal1No alteration is made to the text.
FontStyle::Oblique2The text is obliqued.

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

[since Esri::ArcGISRuntime 100.0] enum class FontWeight

The list of possible font weights.

Enum to represent weight of font supported by ArcGIS Server.

The FontWeight can be one of:

ConstantValueDescription
FontWeight::Bold0The text is made bold.
FontWeight::Normal1No alteration is made to the text.

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

[since Esri::ArcGISRuntime 100.5] enum class GeometricEffectType

The list of possible geometric effects for symbol layers.

It describes the geometric effects that can be applied to the symbol layers. For instance defining dash pattern for a line layer.

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

The list of possible horizontal alignments.

Specifies how a text symbol should be horizontally aligned.

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

The list of possible rotation types.

Controls the origin and direction of rotation for a symbol.

The RotationType can be one of:

ConstantValueDescription
RotationType::Arithmetic0The symbol is rotated from East in a counterclockwise direction where East is the 0 degrees axis.
RotationType::Geographic1The symbol is rotated from North in a clockwise direction where North is the 0 degrees axis.

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

[since Esri::ArcGISRuntime 100.0] enum class SceneSymbolAnchorPosition

The list of possible scene symbol anchor placements.

This is used to determine the position of the scene marker symbol.

The SceneSymbolAnchorPosition can be one of:

ConstantValueDescription
SceneSymbolAnchorPosition::Top0The top of the symbol is the anchor point.
SceneSymbolAnchorPosition::Bottom1The bottom of the symbol is the anchor point.
SceneSymbolAnchorPosition::Center2The center of the symbol is the anchor point.
SceneSymbolAnchorPosition::Origin3The origin of the symbol is the anchor point.

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

[since Esri::ArcGISRuntime 100.0] enum class SimpleFillSymbolStyle

The list of possible simple fill symbol styles.

This is used to determine the style of the simple fill symbol.

The SimpleFillSymbolStyle can be one of:

ConstantValueDescription
SimpleFillSymbolStyle::BackwardDiagonal0Fills with backward diagonal lines.
SimpleFillSymbolStyle::Cross1Fills with horizontal and vertical lines.
SimpleFillSymbolStyle::DiagonalCross2Fills with forward and backward diagonal lines.
SimpleFillSymbolStyle::ForwardDiagonal3Fills with forward diagonal lines.
SimpleFillSymbolStyle::Horizontal4Fills with horizontal lines.
SimpleFillSymbolStyle::Null5No fill.
SimpleFillSymbolStyle::Solid6Solid fill.
SimpleFillSymbolStyle::Vertical7Fills with vertical lines.

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

[since Esri::ArcGISRuntime 100.2] enum class SimpleLineSymbolMarkerPlacement

The list of possible marker placements on a simple line symbol.

Controls the placement of markers on a simple line symbol, if any.

The SimpleLineSymbolMarkerPlacement can be one of:

ConstantValueDescription
SimpleLineSymbolMarkerPlacement::Begin0A marker is placed at the beginning of the simple line symbol.
SimpleLineSymbolMarkerPlacement::End1A marker is placed at the end of the simple line symbol.
SimpleLineSymbolMarkerPlacement::BeginAndEnd2A marker is placed at both the beginning and end of the simple 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

The list of possible marker styles to place on a simple line symbol.

Controls the style of marker placed at the end of a simple line symbol, if any.

The SimpleLineSymbolMarkerStyle can be one of:

ConstantValueDescription
SimpleLineSymbolMarkerStyle::None0No markers are placed at the end of the simple line symbol.
SimpleLineSymbolMarkerStyle::Arrow1Arrow marker(s) placed at the beginning, end, or beginning and end of the simple line symbol depending on the associated value of SimpleLineSymbolMarkerPlacement.

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

The list of possible 3D line styles.

The 3D line style describes the way that line symbol layers will render in 3D. The property refers to the rendering style of a 3D stroke layer. In a scene view, changing this property will change the fundamental appearance of the stroke layer.

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.

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

See also Esri::ArcGISRuntime::StrokeSymbolLayerLineStyle3D.

[since Esri::ArcGISRuntime 100.5] enum class SymbolAnchorPlacementMode

The list of possible symbol anchor placement modes.

SymbolAnchorPlacementMode enumerates the ways in which symbol anchor values may be specified. Different placement modes control how anchor values are interpreted.

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

The list of possible symbol angle alignment types.

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

Marker symbol alignment when map is rotated.

The SymbolAngleAlignment can be one of:

ConstantValueDescription
SymbolAngleAlignment::Map0Marker top edge always aligned with map north.
SymbolAngleAlignment::Screen1Marker top edge always aligned with screen top edge.

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.
SymbolLayerType::MaterialFillSymbolLayer10Material 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.

It describes the size units that can be applied to the symbols. For instance using DIPs for ModelSceneSymbol.

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 screen space size no matter the camera's distance from the symbol itself.
SymbolSizeUnits::Meters1Render the affected symbol by interpreting the size values as meters. Symbols in this mode remain the same world space size no matter the camera's distance from the symbol itself.

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::MultilayerMeshSymbol14Multilayer Mesh 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

The list of possible vertical alignments.

Specifies how a text symbol should be vertically aligned.

The VerticalAlignment can be one of:

ConstantValueDescription
VerticalAlignment::Baseline0Baseline alignment.
VerticalAlignment::Bottom1The text is bottom aligned.
VerticalAlignment::Middle2The text is middle aligned.
VerticalAlignment::Top3The text 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.