class anychart.core.pert.Milestones Improve this Doc
Pert milestones settings collector.
Methods Overview
| Specific settings | |
| hoverLabels() | Labels settings in hover mode. |
| labels() | Labels settings. |
| selectLabels() | Labels settings in selected mode. |
| shape() | Milestones shape. |
| Coloring | |
| color() | Color settings. |
| fill() | Fill settings. |
| hoverFill() | Fill settings in hover mode. |
| hoverStroke() | Stroke settings in hover mode. |
| selectFill() | Fill settings for selected point. |
| selectStroke() | Stroke settings in selected state. |
| stroke() | Stroke settings. |
| Interactivity | |
| tooltip() | Tooltip settings. |
| Size and Position | |
| size() | Milestones size settings |
Methods Description
color
Getter for 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 |
|---|---|---|
| value | 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 - Current fill color.Try it:
Setter for milestones 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.pert.Milestones - Self instance for method chaining.Try it:
Setter for the fill using function.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| fillFunction | function | // 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 myFill; //anychart.graphics.vector.Fill
};. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
Milestones 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:
Linear gradient milestones 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:
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:
Image series 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:
hoverFill
Getter for milestones fill color in hover mode.
Returns:
anychart.graphics.vector.Fill | function - Current fill color.Try it:
Setter for milestones fill settings in hover mode 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.pert.Milestones - Self instance for method chaining.Try it:
Setter for the hover fill using function.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| fillFunction | function | // 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 myFill; //anychart.graphics.vector.Fill
};. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
Milestones fill color with opacity in hover mode. 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:
Linear gradient milestones fill in hover mode.
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:
Radial gradient milestones fill in hover mode.
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:
Image milestones fill in hover mode.
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:
hoverLabels
Getter for milestones hover data labels.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for milestones hover data labels.
Detailed description
Sets milestones hover labels settings depending on parameter type:
- null/boolean - disable or enable milestones hover labels.
- object - sets milestones hover labels settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | Object | boolean | null | false | Series data labels settings. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.hoverStroke
Getter for milestones stroke in the hover state.
Returns:
anychart.graphics.vector.Stroke - The milestones stroke in the hover state.Try it:
Setter for tasks hover 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 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 in the hover state.
Learn more about stroke settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. | |
| thickness | number | 1 | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. | |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
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 |
|---|---|---|---|
| value | Object | boolean | null | false | Milestones data labels settings. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.selectFill
Getter for the fill color for selected milestone.
Returns:
anychart.graphics.vector.Fill - Current fill color.Try it:
Setter for the fill settings for selected milestone using an array or a string.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| value | anychart.graphics.vector.Fill | {color: '#64b5f6'} | Color as an array or a string. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
Setter for the select fill using function.
Learn more about coloring.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| fillFunction | function | // 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 myFill; //anychart.graphics.vector.Fill
};. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.Try it:
Fill color with opacity for selected milestone. 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:
Linear gradient fill for selected milestone.
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:
Radial gradient fill for selected milestone.
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:
Image fill for selected milestone.
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:
selectLabels
Getter for milestones select data labels.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for milestones select data labels.
Detailed description
Setting selected labels settings depending on parameter type:
- null/boolean - disable or enable labels in selected state.
- object - sets selected labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| value | Object | boolean | null | Milestones data labels settings. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.selectStroke
Getter for milestones stroke in selected state.
Returns:
anychart.graphics.vector.Stroke - The milestones stroke in selected state.Try it:
Setter for tasks select 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 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 in selected state.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | function | null | Stroke settings. |
| thickness | number | Line thickness. |
| dashpattern | string | Controls the pattern of dashes and gaps used to stroke paths. |
| lineJoin | anychart.graphics.vector.StrokeLineJoin | Line join style. |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
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 |
|---|---|---|---|
| value | 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 |
|---|---|---|---|
| value | 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 | 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 | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | anychart.graphics.vector.StrokeLineCap | Line cap style. |
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 |
|---|---|---|---|
| value | Object | boolean | null | true | Tooltip settings. |
Returns:
anychart.core.pert.Milestones - Self instance for method chaining.