Class: ArrowStyle

H.map.ArrowStyle

new H.map.ArrowStyle (opt_options)

This class represents style attributes for arrows to be rendered along a polyline. An instance of ArrowStyle is always treated as immutable to avoid inconsistencies and must not modified.

Name Type Description
opt_options H.map.ArrowStyle | H.map.ArrowStyle.Options optional

An object containing initialization options

Methods

equals (other)boolean

This method checks value-equality between the given object and an instance of ArrowStyle provided by the caller.

Name Type Description
other H.map.ArrowStyle | H.map.ArrowStyle.Options

The arrow style object with which to compare the given object

Returns:
Type Description
boolean true if the objects are value-equal, otherwise false

Type Definitions

H.map.ArrowStyle.Options Object

An object containing arrow style initialization options.

Properties:
Name Type Argument Description
fillColor string <optional>

The CSS color value used to fill the arrow shapes. If omitted or if it evaluates to false, the default color "rgba(255, 255, 255, 0.75)" is used.

width number <optional>

The width of the arrow shape. The value is taken as a factor of the width of the line, where the arrow description is applied. If omitted or the value is <= 0, it defaults to 1.2.

length number <optional>

The length of the arrow shapes. The value is taken as a factor of the width of the line at the end of which the arrow is drawn. If omitted or the value is <= 0, it defaults to 1.6.

frequency number <optional>

The frequency of arrow shapes. The value is taken as factor of the length of the arrow. A value of 1 results in gapless arrows. If omitted or the value is false, it defaults to 5.