class anychart.core.annotations.AndrewsPitchfork Improve this Doc
Extends: anychart.core.annotations.Base
Andrews Pitchfork annotation.
Methods Overview
Specific settings | |
getPlot() | Returns the plot on which the annotation is drawn. |
getType() | Returns annotation type. |
hoverMarkers() | Hover markers settings. |
markers() | Markers settings. |
selectMarkers() | Select markers settings. |
Axes and Scales | |
xScale() | X-scale settings |
yScale() | Y-scale settings |
Charts | |
getChart() | Returns the chart on which the annotation is drawn. |
Coloring | |
color() | Color settings. |
hoverStroke() | Hover stroke settings. |
selectStroke() | Select stroke settings. |
stroke() | Stroke settings. |
Size and Position | |
hoverGap() | Hover gap settings. |
secondValueAnchor() | Second value anchor settings |
secondXAnchor() | Second X anchor settings |
thirdValueAnchor() | Third value anchor settings |
thirdXAnchor() | Third X anchor settings |
valueAnchor() | Value anchor settings |
xAnchor() | X anchor settings |
Methods Description
color
Returns:
anychart.graphics.vector.Fill - The annotation color.var currentColor = annotation.color();
Learn more about coloring.
Params:
Name | Type | Description |
---|---|---|
value | anychart.graphics.vector.Fill | Color as an object or a string. |
Returns:
anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
getChart
Returns:
anychart.core.SeparateChart - Chart.Try it:
getPlot
Returns:
anychart.core.stock.Plot - Stock plot.Try it:
getType
Try it:
hoverGap
Returns:
number - The hover gap value.var currentHoverGap = annotation.hoverGap();
The contour size around annotation.
Params:
Name | Type | Description |
---|---|---|
value | * | Value to set. |
Returns:
anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
hoverMarkers
- null/boolean - disable or enable annotation hover markers.
- object - sets annotation hover markers settings.
- string - sets annotation hover markers type.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | boolean | null | string | false |
Data markers settings. |
Returns:
anychart.core.annotations.Base - Self instance for method chaining.hoverStroke
Returns:
anychart.graphics.vector.Stroke - Hover stroke settings.var currentAnnotationHoverStroke = annotation.hoverStroke();
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.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | 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.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
markers
- null/boolean - disable or enable annotation markers.
- object - sets annotation markers settings.
- string - sets annotation markers type.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | boolean | null | string | false |
Data markers settings. |
Returns:
anychart.core.annotations.Base - Self instance for method chaining.secondValueAnchor
Returns:
* - The second value anchor.var controller = chart.annotations(); var annotation = controller.andrewsPitchfork(); var currentSecondValueAnchor = annotation.secondValueAnchor();
Params:
Name | Type | Description |
---|---|---|
Second | * | value anchor to set. |
Returns:
anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
secondXAnchor
Returns:
* - The second X anchor.var controller = chart.annotations(); var annotation = controller.andrewsPitchfork(); var currentSecondXAnchor = annotation.secondXAnchor();
Params:
Name | Type | Description |
---|---|---|
Second | * | X anchor to set. |
Returns:
anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
selectMarkers
Returns:
anychart.core.ui.MarkersFactory - Markers instance.Try it:
- null/boolean - disable or enable annotation select markers.
- object - sets annotation select markers settings.
- string - sets annotation select markers type.
Params:
Name | Type | Default | Description |
---|---|---|---|
value | Object | boolean | null | string | false |
Data markers settings. |
Returns:
anychart.core.annotations.Base - Self instance for method chaining.selectStroke
Returns:
anychart.graphics.vector.Stroke - Select stroke settings.var currentAnnotationSelectStroke = annotation.selectStroke();
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.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | 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.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
stroke
Returns:
anychart.graphics.vector.Stroke - Stroke settings.var currentAnnotationStroke = annotation.stroke();
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.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
Params:
Name | Type | Default | Description |
---|---|---|---|
value | 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.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
thirdValueAnchor
Returns:
* - The second value anchor.var controller = chart.annotations(); var annotation = controller.andrewsPitchfork(); var currentThirdValueAnchor = annotation.thirdValueAnchor();
Params:
Name | Type | Description |
---|---|---|
Third | * | value anchor to set. |
Returns:
anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
thirdXAnchor
Returns:
* - The third X anchor.var controller = chart.annotations(); var annotation = controller.andrewsPitchfork(); var currentThirdXAnchor = annotation.thirdXAnchor();
Params:
Name | Type | Description |
---|---|---|
Third | * | X anchor to set. |
Returns:
anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
valueAnchor
Returns:
* - The value anchor.var controller = chart.annotations(); var annotation = controller.andrewsPitchfork(); var currentValueAnchor = annotation.valueAnchor();
Params:
Name | Type | Description |
---|---|---|
value | * | Value anchor to set. |
Returns:
anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
xAnchor
Returns:
* - The X anchor.var controller = chart.annotations(); var annotation = controller.andrewsPitchfork(); var currentXAnchor = annotation.xAnchor();
Params:
Name | Type | Description |
---|---|---|
value | * | X anchor to set. |
Returns:
anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.Try it:
xScale
Try it:
Params:
Name | Type | Description |
---|---|---|
value | anychart.scales.Base | anychart.scales.StockScatterDateTime | Value to set |
Returns:
anychart.core.annotations.Base - Self instance for method chaining.Try it:
yScale
Params:
Name | Type | Description |
---|---|---|
value | anychart.scales.Base | Y-scale to set. |
Returns:
anychart.core.annotations.Base - Self instance for method chaining.Try it: