LinesSettings

Type class

LinesSettings is a class which defines the default settings for all MapLine objects.

Example

```js var map = AmCharts.makeChart("mapdiv",{ ... linesSettings: { arrowAlpha: 0.5 } });```

Sources

This information about LinesSettings is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

LinesSettings does not extend any other symbol.

LinesSettings is not extended by any other symbol.

Properties

#accessibleLabel

Type string

Text which screen readers will read if user rolls-over the line or sets focus using tab key (this is possible only if tabIndex property of LinesSettings or individual line is set to some number). Text is added as aria-label tag. Note - not all screen readers and browsers support this.

#alpha

Type numberDefault 1

Opacity of the line.

#arc

Type numberDefault 0

Using this setting you can make lines to be curved, or actually to make them look like arcs. Note, there is one limitation - this works well with two-point lines only. You can also set arc for MapLine individually.

#arrow

Type stringDefault none

Position of the arrows. Possible values are "start", "end", "middle", "both" and "none".

#arrowAlpha

Type numberDefault 1

Opacity of the arrows.

#arrowColor

Type color

Arrow color. Will use line color if not set.

#arrowSize

Type numberDefault 10

Size of the arrows.

#balloonText

Type stringDefault [[title]]

Text which is displayed in a roll-over balloon. You can use the following tags: title, description, value and percent.

To disable the balloons, set it to an empty string.

#bringForwardOnHover

Type booleanDefault true

Specifies if line should change it's z-index to the most top when user hovers it.

#color

Type colorDefault #990000

Line color.

#dashLength

Type numberDefault 0

Length of a dash. 0 means line is not dashed.

#descriptionWindowBottom

Type number

Distance from the bottom side of map container to the description window. In case it is not set (also if descriptionWindowTop is not set), window will be placed near the mouse pointer.

#descriptionWindowHeight

Type number

Height of a description window.

#descriptionWindowLeft

Type number

Distance from the left side of map container to the description window. In case it is not set (also if descriptionWindowRight is not set), window will be placed near the mouse pointer.

#descriptionWindowRight

Type number

Distance from the right side of map container to the description window. In case it is not set (also if descriptionWindowLeft is not set), window will be placed near the mouse pointer.

#descriptionWindowTop

Type number

Distance from the top side of map container to the description window. In case it is not set (also if descriptionWindowBottom is not set), window will be placed near the mouse pointer.

#descriptionWindowWidth

Type numberDefault 250

Width of a description window.

#tabIndex

Type number

In case you set it to some number, the map will set focus on lines (one by one) when user clicks tab key. When a focus is set, screen readers like NVDA Screen reader will read label which is set using accessibleLabel property of LinesSettings or individual line. If area is clickable, pressing Enter/Return while focus is set will select the line. Note, not all browsers and readers support this.

#thickness

Type numberDefault 1

Line thickness.

Methods

LinesSettings does not have any methods.

Events

LinesSettings does not have any events.