AnyChart
API Reference
Still have questions?
Contact support
Top

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

Getter for the milestones color.

Returns:

string - The milestones color.
Setter for the milestones color.

Params:

NameTypeDescription
colorstringColor as a string.

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.

fill

Getter for milestones fill color.

Returns:

anychart.graphics.vector.Fill | function - Fill color.
Setter for milestones 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.pert.Milestones - Self instance for method chaining.
Setter for the fill using function. Learn more about coloring.

Params:

NameTypeDefaultDescription
fillFunctionfunction():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.
Setter for the fill color with opacity. Fill as a string or an object.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.
Setter for the 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.pert.Milestones - Self instance for method chaining.
Setter for the 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.pert.Milestones - Self instance for method chaining.
Setter for the image fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings
Setter for hovered state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.

labels

Getter for milestones data labels.

Returns:

anychart.core.ui.LabelsFactory - Labels instance.
Setter for milestones data labels.

Params:

NameTypeDefaultDescription
settingsObject | 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.
Setter for normal state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings
Setter for selected state settings.

Params:

NameTypeDescription
settingsObjectState settings to set.

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.

shape

Getter for milestones shape.

Returns:

anychart.enums.MilestoneShape | string - The milestones shape.
Setter for milestones shape.

Params:

NameTypeDefaultDescription
shapeanychart.enums.MilestoneShape | string
'circle'
Value to set.

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.

size

Getter for milestones size.

Returns:

number | string - The milestones size.
Setter for milestones size.

Params:

NameTypeDefaultDescription
sizenumber | string
'5%'
Value to set.

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.

stroke

Getter for milestones stroke.

Returns:

anychart.graphics.vector.Stroke - The milestones stroke.
Setter for tasks 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 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.
Setter for milestones stroke. Learn more about stroke settings.

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | 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.pert.Milestones - Self instance for method chaining.
Setter for milestones stroke using an object.

Params:

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

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.

tooltip

Getter for milestones data tooltip.

Returns:

anychart.core.ui.Tooltip - Tooltip instance.
Setter for milestones data tooltip.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null
true
Tooltip settings to set.

Returns:

anychart.core.pert.Milestones - Self instance for method chaining.