Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • ComplexStrokedLineStyle

Overview

Properties

Optional decorations

decorations: Decoration[]

The decorations to be painted along the line.

A decoration is a Pattern that is painted once at a specific position along the line.

This property is optional. If it is omitted, no decorations will be painted along the line.

Optional fallback

fallback: Pattern

The pattern that is painted if no decoration or regular pattern can be painted. This can happen if a line is too curved, or if there is not enough space to paint the regular pattern.

Some patterns influence whether the fallback pattern is painted or not, and where it is painted. For more information, see the combineWithFallback and combineWithRegular pattern wrappers.

see

combineWithFallback

see

combineWithRegular

Optional regular

regular: Pattern | null

The pattern that is repeated along the line. A regular pattern is painted where no decoration is painted, because decorations have priority over the regular pattern.

If there is not enough space to place the regular pattern, the fallback pattern is painted.

Some patterns influence whether the fallback pattern is painted or not, and where it is painted. For more information, see the combineWithFallback and combineWithRegular pattern wrappers.

see

combineWithRegular

Optional sharpAngleThreshold

sharpAngleThreshold: number

The threshold that is used to determine if angles are sharp or not. It is interpreted as an angle in degrees between two line segments. In the context of complex stroking, sharp corners are handled differently than non-sharp corners.

In general, a non-sharp corner is handled as if there were no corner at all. This means that any stroke can just be painted along the corner. As a side-effect, strokes may be deformed. This deformation will be small for corners that are close to 180 degrees wide, meaning for line segments that are almost parallel. The deformation can become quite large for sharper corners though, so take care when you adjust this value.

On the other hand, when a corner is considered sharp, strokes will not be deformed, but they may be dropped instead.

This setting is useful when complex strokes use a uniform shape and color, for example. When you are painting an airspace border using a rectangular stroke along the length of the line, you can set the threshold to 0, for instance.

The value should always be in the [0, 180] degrees range. The default value is 155 degrees.

Note that this setting is only supported on a WebGLMap. On a non-WebGLMap, this threshold is ignored.

default

155

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method