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:

Name Type Default Description
value boolean
true
Value to set.

Returns:

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

Try it:

fill

Getter for the fill.

Returns:

anychart.graphics.vector.Fill function - Fill color.
See listing
var fill = outline.fill();
Setter for the fill using a function. Learn more about coloring.

Params:

Name Type Default Description
function anychart.graphics.vector.Fill | function
// 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 myFill; //anychart.graphics.vector.Fill
};

Returns:

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

Try it:

Setter for fill settings using an array or a string. Learn more about coloring.

Params:

Name Type Description
value anychart.graphics.vector.Fill Color as an array or a string.

Returns:

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

Params:

Name Type Description
color string Color as a string.
opacity number Color opacity.

Returns:

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

Try it:

Linear gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Gradient keys.
angle number Gradient angle.
mode boolean | anychart.graphics.vector.Rect | Object Gradient mode.
opacity number Gradient opacity.

Returns:

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

Try it:

Radial gradient fill. Learn more about coloring.

Params:

Name Type Description
keys Array.<(anychart.graphics.vector.GradientKey|string)> Color-stop gradient keys.
cx number X ratio of center radial gradient.
cy number Y ratio of center radial gradient.
mode anychart.graphics.math.Rect If defined then userSpaceOnUse mode, else objectBoundingBox.
opacity number Opacity of the gradient.
fx number X ratio of focal point.
fy number Y ratio of focal point.

Returns:

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

Params:

Name Type Description
imageSettings anychart.graphics.vector.Fill Object with settings.

Returns:

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

Try it:

offset

Getter for the outline offset.

Returns:

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

Params:

Name Type Default Description
value string | number
0
Offset in pixel or percent.

Returns:

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

Try it:

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:

Name Type Default Description
strokeFunction function
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.

Try it:

Setter for stroke settings. Learn more about stroke settings.

Params:

Name Type Default Description
color anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thickness number
1
Line thickness.
dashpattern string
Controls the pattern of dashes and gaps used to stroke paths.
lineJoin string | anychart.graphics.vector.StrokeLineJoin
Line join style.
lineCap string | anychart.graphics.vector.StrokeLineCap
Line cap style.

Returns:

anychart.core.map.series.Base - Self instance for method chaining.

Try it:

width

Getter for the outline width.

Returns:

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

Params:

Name Type Default Description
value string | number
0
Width in pixel or percent.

Returns:

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

Try it: