Skip To Content ArcGIS for Developers Sign In Dashboard

StrokeSymbolLayer Class

class Esri::ArcGISRuntime::StrokeSymbolLayer

A StrokeSymbolLayer represents a symbol layer that, when applied to a polyline geometry, draws a stroke along that geometry. The StrokeSymbolLayer can also control drawing the outline of a polygon geometry. More...

Header: #include <StrokeSymbolLayer>
Since: Esri::ArcGISRuntime 100.5
Inherits: Esri::ArcGISRuntime::SymbolLayer
Inherited By:

Esri::ArcGISRuntime::SolidStrokeSymbolLayer

This class was introduced in Esri::ArcGISRuntime 100.5.

Public Functions

virtual ~StrokeSymbolLayer() override
Esri::ArcGISRuntime::StrokeSymbolLayerCapStyle capStyle() const
Esri::ArcGISRuntime::StrokeSymbolLayerLineStyle3D lineStyle3D() const
void setCapStyle(Esri::ArcGISRuntime::StrokeSymbolLayerCapStyle capStyle)
void setLineStyle3D(Esri::ArcGISRuntime::StrokeSymbolLayerLineStyle3D lineStyle3D)
void setWidth(double width)
double width() const

Detailed Description

Applied to a polyline geometry, the StrokeSymbolLayer will draw a segment of stroke adhering to the selected visual properties for each line segment. Similarly, as the outline of a polygon geometry, the StrokeSymbolLayer draws a stroke segment for each line segment of the polygon outline.

This symbol layer controls many common operations vital for working with strokes. Cap style and line style 3D are controllable on the StrokeSymbolLayer. These properties provide the ability to pick between various options for rendering strokes. Line style 3D applies only in 3D, but cap style and width have effects in both 2D and 3D.

Member Function Documentation

[override virtual] StrokeSymbolLayer::~StrokeSymbolLayer()

Destructor.

Esri::ArcGISRuntime::StrokeSymbolLayerCapStyle StrokeSymbolLayer::capStyle() const

Returns the cap style of the stroke symbol layer.

The default cap style is 'round,' meaning that the ends of the stroke are rounded off. Cap styles affect strokes in Map Views, as well as the 'strip' and 'tube' line styles in Scene Views.

See also setCapStyle().

Esri::ArcGISRuntime::StrokeSymbolLayerLineStyle3D StrokeSymbolLayer::lineStyle3D() const

Returns the 3D line style of the stroke symbol layer.

The default 3D line style is 'strip,' meaning that the 3D stroke is flat. 3D line style has no effect on strokes in Map Views, but does affect strokes in Scene Views.

See also setLineStyle3D().

void StrokeSymbolLayer::setCapStyle(Esri::ArcGISRuntime::StrokeSymbolLayerCapStyle capStyle)

Sets the cap style of the stroke symbol layer to capStyle.

The cap style controls the rendering of the ends (caps) of the stroke. Cap styles affect screen space 2D lines in Map Views, as well as the 'strip' and 'tube' line styles in Scene Views.

See also capStyle().

void StrokeSymbolLayer::setLineStyle3D(Esri::ArcGISRuntime::StrokeSymbolLayerLineStyle3D lineStyle3D)

Sets the 3D line style of the stroke symbol layer to lineStyle3D.

The 3D line style controls the rendering of the stroke in 3D. As a consequence of that, 3D line style has no effect on strokes in Map Views, but does affect strokes in Scene Views.

See also lineStyle3D().

void StrokeSymbolLayer::setWidth(double width)

Sets the width of the stroke symbol layer, in DIPs.

The input value can be any non-negative number. A larger width means a larger stroke.

When getting the width from a multilayer polyline symbol, the value reported is the largest width of all the symbol layers it contains. The symbol width is updated when its symbol layer widths change (if there is a new largest layer width). When setting a new width at the polyline symbol level, the width of the largest symbol layer is given the provided value, and all the smaller layers are sized proportionately. An individual symbol layer can be given a specific width without affecting the other layers.

See also width().

double StrokeSymbolLayer::width() const

Returns the width of the stroke symbol layer, in DIPs.

The return value may be any non-negative number (default is 0). A larger width means a larger stroke.

See also setWidth.


Feedback on this topic?