SimpleLineSymbol Class
A line symbol based on simple patterns. More...
| Header: | #include <SimpleLineSymbol.h> |
| Since: | Esri::ArcGISRuntime 100.0 |
| Inherits: | Esri::ArcGISRuntime::LineSymbol |
Public Functions
| SimpleLineSymbol(Esri::ArcGISRuntime::SimpleLineSymbolStyle style, const QColor &color, float width, Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle markerStyle, Esri::ArcGISRuntime::SimpleLineSymbolMarkerPlacement markerPlacement, QObject *parent = nullptr) | |
| SimpleLineSymbol(Esri::ArcGISRuntime::SimpleLineSymbolStyle style, const QColor &color, float width, QObject *parent = nullptr) | |
| SimpleLineSymbol(QObject *parent = nullptr) | |
| virtual | ~SimpleLineSymbol() override |
| Esri::ArcGISRuntime::SimpleLineSymbolMarkerPlacement | markerPlacement() const |
| Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle | markerStyle() const |
| void | setMarkerPlacement(Esri::ArcGISRuntime::SimpleLineSymbolMarkerPlacement markerPlacement) |
| void | setMarkerStyle(Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle markerStyle) |
| void | setStyle(Esri::ArcGISRuntime::SimpleLineSymbolStyle style) |
| Esri::ArcGISRuntime::SimpleLineSymbolStyle | style() const |
| Esri::ArcGISRuntime::MultilayerPolylineSymbol * | toMultilayerSymbol(QObject *parent = nullptr) const |
| bool | operator==(const Esri::ArcGISRuntime::SimpleLineSymbol &other) const |
Detailed Description
Symbols describe how graphics and features look on a map. Different symbols are used with different geometry types. Instances of this class represent simple line symbols. Line symbols are used to display graphics and features which are based on polyline geometries. Simple line symbols display predefined line style patterns such as solid, dash, dot, and so on.
Example:
Create a SimpleLineSymbol and set its style, color, and width:
SimpleLineSymbol* simpleLineSymbol = new SimpleLineSymbol(SimpleLineSymbolStyle::Dash, QColor(Qt::green), 2.0, this);
Member Function Documentation
[since Esri::ArcGISRuntime 100.2] SimpleLineSymbol::SimpleLineSymbol (Esri::ArcGISRuntime::SimpleLineSymbolStyle style, const QColor &color, float width, Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle markerStyle , Esri::ArcGISRuntime::SimpleLineSymbolMarkerPlacement markerPlacement , QObject *parent = nullptr)
Constructs a line symbol providing its style, color, width, markerStyle, markerPlacement, and optional parent.
Note: The SimpleLineSymbolMarkerStyle::Arrow marker style is not supported in 3D scenes with GraphicsRenderingMode::Dynamic graphics rendering mode. It will not render correctly.
This function was introduced in Esri::ArcGISRuntime 100.2.
SimpleLineSymbol::SimpleLineSymbol (Esri::ArcGISRuntime::SimpleLineSymbolStyle style, const QColor &color, float width, QObject *parent = nullptr)
Constructs a line symbol providing its style, color, width, and optional parent.
SimpleLineSymbol::SimpleLineSymbol (QObject *parent = nullptr)
Default constructor with an optional parent.
[override virtual] SimpleLineSymbol::~SimpleLineSymbol ()
Destructor.
[since Esri::ArcGISRuntime 100.2] Esri::ArcGISRuntime::SimpleLineSymbolMarkerPlacement SimpleLineSymbol::markerPlacement () const
Returns the marker placement, which determines which ends the markerStyle is applied to.
This function was introduced in Esri::ArcGISRuntime 100.2.
See also setMarkerPlacement().
[since Esri::ArcGISRuntime 100.2] Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle SimpleLineSymbol::markerStyle () const
Returns the end marker style of the line, which is applied to the ends of the line symbol.
This function was introduced in Esri::ArcGISRuntime 100.2.
See also setMarkerStyle().
[since Esri::ArcGISRuntime 100.2] void SimpleLineSymbol::setMarkerPlacement (Esri::ArcGISRuntime::SimpleLineSymbolMarkerPlacement markerPlacement )
Sets the marker placement, which determines to which ends the markerStyle is applied, to markerPlacement.
This function was introduced in Esri::ArcGISRuntime 100.2.
See also markerPlacement().
[since Esri::ArcGISRuntime 100.2] void SimpleLineSymbol::setMarkerStyle (Esri::ArcGISRuntime::SimpleLineSymbolMarkerStyle markerStyle )
Sets the end marker style of the line, which is applied to the ends of the line symbol, to markerStyle.
Note: The SimpleLineSymbolMarkerStyle::Arrow marker style is not supported in 3D scenes with GraphicsRenderingMode::Dynamic graphics rendering mode. It will not render correctly.
This function was introduced in Esri::ArcGISRuntime 100.2.
See also markerStyle().
void SimpleLineSymbol::setStyle (Esri::ArcGISRuntime::SimpleLineSymbolStyle style)
Sets the style of the line.
See also style().
Esri::ArcGISRuntime::SimpleLineSymbolStyle SimpleLineSymbol::style() const
Returns the style of the line.
See also setStyle().
[since Esri::ArcGISRuntime 100.5] Esri::ArcGISRuntime::MultilayerPolylineSymbol *SimpleLineSymbol::toMultilayerSymbol (QObject *parent = nullptr) const
Returns Multilayer polyline symbol generated from simple line symbol with optional parent.
This helper method exports this symbol to MultilayerPolylineSymbol with SolidStrokeSymbolLayer and predefined collection of DashGeometricEffect.
Note: if no parent is specified, this SimpleLineSymbol will be the parent of the MultilayerPolylineSymbol.
This function was introduced in Esri::ArcGISRuntime 100.5.
[since Esri::ArcGISRuntime 200.1] bool SimpleLineSymbol::operator==(const Esri::ArcGISRuntime::SimpleLineSymbol &other) const
Equivalency operator.
Returns true if this object and other are equivalent.
This function was introduced in Esri::ArcGISRuntime 200.1.