AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.utils.UnboundRegionsSettings Improve this Doc

Class for using in maps. Class is settings for regions that isn't linked to any series.
Learn more about the unbound regions.

Methods Overview

Coloring
fill()Fill settings.
stroke()Stroke settings.
Interactivity
enabled()Element state (enabled or disabled).

Methods Description

enabled

Getter for the element enabled state.

Returns:

boolean - Element state.
Setter for the element enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Enabled state to set.

Returns:

anychart.core.utils.UnboundRegionsSettings - Self instance for method chaining.

fill

Getter for the fill color.

Returns:

anychart.graphics.vector.Fill - Fill color.
Sets fill settings using an array, an object or a string. Learn more about coloring.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)>
'#F7F7F7'
Color as an array, an object or a string.

Returns:

anychart.core.utils.UnboundRegionsSettings - Self instance for method chaining.
Fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.utils.UnboundRegionsSettings - Self instance for method chaining.
Linear gradient fill. Learn more about coloring.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Gradient keys.
anglenumberGradient angle.
modeboolean | anychart.graphics.vector.Rect | ObjectGradient mode.
opacitynumberGradient opacity.

Returns:

anychart.core.utils.UnboundRegionsSettings - Self instance for method chaining.

Params:

NameTypeDescription
keysArray.<(anychart.graphics.vector.GradientKey|string)>Color-stop gradient keys.
cxnumberX ratio of center radial gradient.
cynumberY ratio of center radial gradient.
modeanychart.graphics.math.RectIf defined then userSpaceOnUse mode, else objectBoundingBox.
opacitynumberOpacity of the gradient.
fxnumberX ratio of focal point.
fynumberY ratio of focal point.

Returns:

anychart.core.utils.UnboundRegionsSettings - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.utils.UnboundRegionsSettings - Self instance for method chaining.

stroke

Getter for stroke for unbounded regions.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
Setter for stroke for unbounded regions.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
'#e0e0e0'
Stroke color.
thicknessnumber
1
Line thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Line joint style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.utils.UnboundRegionsSettings - Self instance for method chaining.
Setter for stroke using an object.

Params:

NameTypeDescription
settingsObjectStroke settings from anychart.graphics.vector.Stroke.

Returns:

anychart.core.utils.UnboundRegionsSettings - Self instance for method chaining.