Top

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.
markers()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.
stroke()Stroke settings.
Interactivity
hovered()Hovered state settings.
normal()Normal state settings.
selected()Selected state 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

Getter for the annotation color.

Returns:

string - The annotation color.
See listing.
var color = annotation.color();
Setter for the annotation color.

Params:

Name Type Description
value string Color as a string.

Returns:

anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.

Try it:

getChart

Returns the chart on which the annotation is drawn.

Returns:

anychart.core.SeparateChart - Chart.

Try it:

getPlot

Returns the plot on which the annotation is drawn.

Returns:

anychart.core.stock.Plot - Stock plot.

Try it:

getType

Returns annotation type.

Returns:

anychart.enums.AnnotationTypes string - Annotation type

Try it:

hoverGap

Getter for the hover gap.

Returns:

number - The hover gap value.
See listing.
var currentHoverGap = annotation.hoverGap();
Setter for the hover gap.
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:

hovered

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Setter for hovered state settings.

Params:

Name Type Description
value Object State settings to set.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

markers

Getter for data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Setter for data markers.

Params:

Name Type Default Description
value Object | boolean | null | string
false
Data markers settings.

Returns:

anychart.core.annotations.Base - 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
value Object State settings to set.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

secondValueAnchor

Getter for the second value anchor.

Returns:

* - The second value anchor.
See listing.
var controller = chart.annotations();
var annotation = controller.andrewsPitchfork();
var currentSecondValueAnchor = annotation.secondValueAnchor();
Setter for the second value anchor.

Params:

Name Type Description
Second * value anchor to set.

Returns:

anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.

Try it:

secondXAnchor

Getter for the second X anchor.

Returns:

* - The second X anchor.
See listing.
var controller = chart.annotations();
var annotation = controller.andrewsPitchfork();
var currentSecondXAnchor = annotation.secondXAnchor();
Setter for the second X anchor.

Params:

Name Type Description
Second * X anchor to set.

Returns:

anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.

Try it:

selected

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Setter for selected state settings.

Params:

Name Type Description
value Object State settings to set.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

stroke

Getter for stroke settings.

Returns:

anychart.graphics.vector.Stroke - Stroke settings.
See listing.
var currentAnnotationStroke = annotation.stroke();
Setter for annotations 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.annotations.AndrewsPitchfork - Self instance for method chaining.

Try it:

Setter for annotations stroke settings. 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.annotations.AndrewsPitchfork - Self instance for method chaining.

Try it:

thirdValueAnchor

Getter for the third value anchor.

Returns:

* - The second value anchor.
See listing.
var controller = chart.annotations();
var annotation = controller.andrewsPitchfork();
var currentThirdValueAnchor = annotation.thirdValueAnchor();
Setter for the third value anchor.

Params:

Name Type Description
Third * value anchor to set.

Returns:

anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.

Try it:

thirdXAnchor

Getter for the third X anchor.

Returns:

* - The third X anchor.
See listing.
var controller = chart.annotations();
var annotation = controller.andrewsPitchfork();
var currentThirdXAnchor = annotation.thirdXAnchor();
Setter for the third X anchor.

Params:

Name Type Description
Third * X anchor to set.

Returns:

anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.

Try it:

valueAnchor

Getter for the value anchor.

Returns:

* - The value anchor.
See listing.
var controller = chart.annotations();
var annotation = controller.andrewsPitchfork();
var currentValueAnchor = annotation.valueAnchor();
Setter for the value anchor.

Params:

Name Type Description
value * Value anchor to set.

Returns:

anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.

Try it:

xAnchor

Getter for the X anchor.

Returns:

* - The X anchor.
See listing.
var controller = chart.annotations();
var annotation = controller.andrewsPitchfork();
var currentXAnchor = annotation.xAnchor();
Setter for the X anchor.

Params:

Name Type Description
value * X anchor to set.

Returns:

anychart.core.annotations.AndrewsPitchfork - Self instance for method chaining.

Try it:

xScale

Setter for the X-scale.

Params:

Name Type Description
value anychart.scales.Base | anychart.scales.StockScatterDateTime | Object | anychart.enums.ScaleTypes Value to set

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it:

yScale

Getter for the Y-scale.

Returns:

anychart.scales.Base - Default scale value.

Try it:

Setter for the Y-scale.

Params:

Name Type Description
value anychart.scales.Base | Object | anychart.enums.ScaleTypes Y-scale to set.

Returns:

anychart.core.annotations.Base - Self instance for method chaining.

Try it: