class anychart.core.pert.Milestones Improve this Doc
Pert milestones settings collector.
Methods Overview
| Specific settings | |
| labels() | Labels settings. |
| shape() | Milestones shape. |
| Coloring | |
| color() | Color settings. |
| fill() | Fill settings. |
| stroke() | Stroke settings. |
| Interactivity | |
| hovered() | Hovered state settings. |
| normal() | Normal state settings. |
| selected() | Selected state settings. |
| tooltip() | Tooltip settings. |
| Size and Position | |
| size() | Milestones size settings |
Methods Description
color
Setter for the milestones color.
Detailed description
Note: color methods sets fill and stroke settings, which means it is not wise to pass
image fill here - stroke doesn't accept image fill.
Learn more about coloring.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | string | Color as a string. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
fill
Getter for milestones fill color.
Returns:
anychart.graphics.vector.Fill | function - Fill color.Try it:
Setter for milestones 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.pert.Milestones - Self instance for method chaining.Setter for the fill using function.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| fillFunction | function():anychart.graphics.vector.Fill | // return the fill from the default palette.
function() {
return this.sourceColor;
}; | 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.pert.Milestones - Self instance for method chaining.Try it:
Setter for the fill color with opacity. Fill as a string or an object.
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.pert.Milestones - Self instance for method chaining.Try it:
Setter for the 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.pert.Milestones - Self instance for method chaining.Try it:
Setter for the 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.pert.Milestones - Self instance for method chaining.Try it:
Setter for the image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
hovered
Getter for hovered state settings.
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Setter for hovered state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
labels
Setter for milestones data labels.
Detailed description
Sets milestones labels settings depending on parameter type:
- null/boolean - disable or enable milestones labels.
- object - sets milestones labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | false | Milestones data labels settings. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.normal
Getter for normal state settings.
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Setter for normal state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
selected
Getter for selected state settings.
Returns:
anychart.core.StateSettings - Selected state settingsTry it:
Setter for selected state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
shape
Getter for milestones shape.
Returns:
anychart.enums.MilestoneShape | string - The milestones shape.Try it:
Setter for milestones shape.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| shape | anychart.enums.MilestoneShape | string | 'circle' | Value to set. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
size
Setter for milestones size.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| size | number | string | '5%' | Value to set. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
stroke
Getter for milestones stroke.
Returns:
anychart.graphics.vector.Stroke - The milestones stroke.Try it:
Setter for tasks 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 fill() getter.
// this.iterator - series point iterator.
return strokeValue; // type anychart.graphics.vector.Stroke or anychart.graphics.vector.ColoredFill
} |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
Setter for milestones stroke.
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.pert.Milestones - Self instance for method chaining.Try it:
Setter for milestones stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
tooltip
Setter for milestones data tooltip.
Detailed description
Sets milestones tooltip settings depending on parameter type:
- null/boolean - disable or enable milestones tooltip.
- object - sets milestones tooltip settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Tooltip settings to set. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.