class anychart.core.pert.Tasks Improve this Doc
Pert tasks settings collector.
Methods Overview
| Specific settings | |
| lowerLabels() | Lower labels settings. |
| upperLabels() | Upper labels settings. |
| Coloring | |
| color() | Color settings. |
| dummyFill() | Fill settings. |
| dummyStroke() | Stroke settings. |
| fill() | Fill settings. |
| stroke() | Stroke settings. |
| Interactivity | |
| hovered() | Hovered state settings. |
| normal() | Normal state settings. |
| selected() | Selected state settings. |
| tooltip() | Tooltip settings. |
Methods Description
color
Setter for tasks 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.Tasks - Self instance for method chaining.Try it:
dummyFill
Getter for the dummy fill color.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Fill - Fill color.Try it:
Setter for the dummy 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.Tasks - Self instance for method chaining.Try it:
Setter for dummy fill settings using 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.Tasks - Self instance for method chaining.Try it:
Dummy 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.pert.Tasks - Self instance for method chaining.Linear gradient dummy 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.Tasks - Self instance for method chaining.Radial gradient dummy 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.Tasks - Self instance for method chaining.Image dummy fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.pert.Tasks - Self instance for method chaining.dummyStroke
Getter for tasks dummy stroke.
Returns:
anychart.graphics.vector.Stroke - The milestones stroke.Try it:
Setter for tasks dummy 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.Tasks - Self instance for method chaining.Try it:
Setter for tasks dummy 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.Tasks - 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.pert.Tasks - Self instance for method chaining.Try it:
fill
Getter for the fill color.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Fill - The tasks fill color.Try it:
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.Tasks - Self instance for method chaining.Try it:
Setter for fill settings using a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Color as a string. |
Returns:
anychart.core.pert.Tasks - Self instance for method chaining.Try it:
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.pert.Tasks - Self instance for method chaining.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.Tasks - Self instance for method chaining.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.Tasks - 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.pert.Tasks - Self instance for method chaining.hovered
Setter for hovered state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.pert.Tasks - Self instance for method chaining.Try it:
lowerLabels
Getter for the lower labels settings.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for the lower labels settings.
Detailed description
Sets lower labels settings depending on parameter type:
- null/boolean - disable or enable lower labels.
- object - sets lower labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Labels settings to set. |
Returns:
anychart.core.pert.Tasks - Self instance for method chaining.normal
Setter for normal state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.pert.Tasks - Self instance for method chaining.Try it:
selected
Getter for selected state settings.
Returns:
anychart.core.pert.Tasks - Selected state settingsTry it:
Setter for selected state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.pert.Tasks - Self instance for method chaining.Try it:
stroke
Getter for tasks stroke settings.
Returns:
anychart.graphics.vector.Stroke - The tasks stroke settings.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.Tasks - Self instance for method chaining.Try it:
Setter for tasks 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.pert.Tasks - Self instance for method chaining.Try it:
Setter for tasks stroke using an object.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | Stroke settings from anychart.graphics.vector.Stroke. |
Returns:
anychart.core.pert.Tasks - Self instance for method chaining.Try it:
tooltip
Setter for tasks data tooltip.
Detailed description
Sets tasks tooltip settings depending on parameter type:
- null/boolean - disable or enable tasks tooltip.
- object - sets tasks tooltip settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| settings | Object | boolean | null | true | Tooltip settings. |
Returns:
anychart.core.pert.Tasks - Self instance for method chaining.upperLabels
Getter for the upper labels settings.
Returns:
anychart.core.ui.LabelsFactory - Labels instance.Try it:
Setter for the upper labels settings.
Detailed description
Sets upper labels settings depending on parameter type:
- null/boolean - disable or enable upper labels.
- object - sets upper labels settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | boolean | null | Labels settings to set. |
Returns:
anychart.core.pert.Tasks - Self instance for method chaining.