ArcGIS Developers

DashGeometricEffect QML Type

A Geometric effect object that transforms the representation of a line using a pattern of dashes and gaps. More...

Import Statement: import Esri.ArcGISRuntime 100.10
Since: Esri.ArcGISRuntime 100.5




Detailed Description

Defining dash and gap distances

Transforms the representation of a line using a pattern of dashes and gaps. Dashes are the symbolized portion of the stroke and gaps are the unsymbolized portion. A vector of dash and gap distances (DIP values greater than 0) provides a template to be repeated throughout the line. A basic template consists of two distance values: the first defines the length of each dash and the second defines the length of each gap. More complex effects can be created by defining a template of multiple dashes and gaps. Template values are read as dash distance followed by gap distance throughout the pattern. Templates that contain an odd number of values will maintain the dash-gap pattern by restarting at the beginning of the template. A template of '3 2 1', for example, will be rendered as '3(dash) 2(gap) 1(dash) 3(gap) 2(dash) 1(gap) ...'. The default template is an empty vector, which renders a solid line.

The gaps in a dash effect can be lost when a small gap is defined while a round or square cap style is applied. Because the cap style is applied to both ends of a dash, they can overlap over short distances and fill the gap. A butt style cap ends the stroke abruptly, so will not exhibit the issue. (This behavior is consistent with ArcGIS Pro.)

Property Documentation

dashTemplate : list<double>

A list of values that defines dashes and gaps for the geometric effect.

See also Defining dash and gap distances.

Signal Documentation


Emitted when the dashTemplate property changes.

Note: The corresponding handler is onDashTemplateChanged.

Feedback on this topic?