AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.ui.Outline Improve this Doc

Extends: anychart.core.Base

Outline class.

Methods Overview

Coloring
fill()Fill settings.
stroke()Stroke settings.
Interactivity
enabled()Outline state (enabled or disabled).
Size and Position
offset()Offset settings.
width()Width settings.

Methods Description

enabled

Getter for the outline enabled state.

Returns:

boolean - The outline state.
Setter for the outline enabled state.

Params:

NameTypeDefaultDescription
enabledboolean
true
Value to set.

Returns:

anychart.core.ui.Outline - Self instance for method chaining.

fill

Getter for the fill.
See listing
var fill = outline.fill();
Setter for the fill using a function. Learn more about coloring.

Params:

NameTypeDefaultDescription
functionanychart.graphics.vector.Fill | function():anychart.graphics.vector.Fill
// return the fill from the default palette.
function() {
  return this.sourceColor;
};
or Fill, or fill-function, which should look like this:
function() {
 //  this: {
 //  index : number  - the index of the current point
 //  sourceColor : anychart.graphics.vector.Fill - fill of the current point
 // }
 return fillValue; //anychart.graphics.vector.Fill
};

Returns:

anychart.core.ui.Outline - Self instance for method chaining.
Setter for fill settings using an array, an object or a string. Learn more about coloring.

Params:

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

Returns:

anychart.core.ui.Outline - Self instance for method chaining.
Fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.ui.Outline - 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.ui.Outline - Self instance for method chaining.
Radial gradient fill. Learn more about coloring.

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.ui.Outline - Self instance for method chaining.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.ui.Outline - Self instance for method chaining.

offset

Getter for the outline offset.

Returns:

string | number - Outline offset.
See listing
var offset = outline.offset();
Setter for the outline offset.

Params:

NameTypeDefaultDescription
offsetstring | number
0
Offset in pixel or percent.

Returns:

anychart.core.ui.Outline - Self instance for method chaining.

stroke

Getter for stroke settings.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
See listing
var stroke = outline.stroke();
Setter for the stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction():anychart.graphics.vector.Stroke|anychart.graphics.vector.ColoredFill
function() {
 return anychart.color.darken(this.sourceColor);
}
Function that looks like:
function(){
   // this.index - series index.
   // this.sourceColor - color returned by stroke() getter.
   // this.iterator - series point iterator.
   return strokeValue; // type anychart.graphics.vector.Fill or anychart.graphics.vector.Stroke
}

Returns:

anychart.core.map.series.Base - Self instance for method chaining.
Setter for stroke settings. Learn more about stroke settings.

Params:

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

Returns:

anychart.core.map.series.Base - Self instance for method chaining.
Setter for stroke using an object.

Params:

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

Returns:

anychart.core.ui.Outline - Self instance for method chaining.

width

Getter for the outline width.

Returns:

string | number - Outline width.
See listing
var width = outline.width();
Setter for the outline width.

Params:

NameTypeDefaultDescription
widthstring | number
0
Width in pixel or percent.

Returns:

anychart.core.ui.Outline - Self instance for method chaining.