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 |
|---|---|---|---|
| enabled | boolean | true | Value to set. |
Returns:
anychart.core.ui.Outline - Self instance for method chaining.Try it:
fill
Getter for the fill.
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():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.Try it:
Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.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.
Detailed description
Note: If color is set as a string (e.g. 'red .5') it has a priority over opt_opacity, which
means: color set like this rect.fill('red 0.3', 0.7) will have 0.3 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.Image fill.
Learn more about coloring.
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 |
|---|---|---|---|
| offset | 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():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.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:
Setter for stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.ui.Outline - 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 |
|---|---|---|---|
| width | string | number | 0 | Width in pixel or percent. |
Returns:
anychart.core.ui.Outline - Self instance for method chaining.Try it: