AnyChart
API Reference
Still have questions?
Contact support
Top

class anychart.core.annotations.Ray Improve this Doc

Extends: anychart.core.annotations.Base

Ray 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
allowEdit()Interactivity settings.
hovered()Hovered state settings.
normal()Normal state settings.
select()Selects current annotation.
selected()Selected state settings.
Size and Position
hoverGap()Hover gap settings.
secondValueAnchor()Second value anchor settings
secondXAnchor()Second X anchor settings
valueAnchor()Value anchor settings
xAnchor()X anchor settings

Methods Description

allowEdit

Getter for an interactivity in the annotation.

Returns:

boolean - Interactivity settings.
See listing.
var allowEdit = annotation.allowEdit();
Setter for an interactivity in the annotation.

Params:

NameTypeDescription
value*Whether to disable the interactivity in the annotation. If set to false, the interactivity is disabled in the annotation.

Returns:

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

color

Getter for the annotation color.

Returns:

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

Params:

NameTypeDescription
colorstringColor as a string.

Returns:

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

getChart

Returns the chart on which the annotation is drawn.

getPlot

Returns the plot on which the annotation is drawn.

Returns:

anychart.core.stock.Plot - Stock plot.

getType

Returns annotation type.

Returns:

anychart.enums.AnnotationTypes | string - Annotation type

hoverGap

Getter for the hover gap.

Returns:

number - The hover gap value.
See listing.
var hoverGap = annotation.hoverGap();
Setter for the hover gap.
The contour size around annotation.

Params:

NameTypeDescription
value*Value to set.

Returns:

anychart.core.annotations.Ray - 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.annotations.Ray - Self instance for method chaining.

markers

Getter for data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.
Setter for data markers.

Params:

NameTypeDefaultDescription
settingsObject | boolean | null | string
false
Data markers settings.

Returns:

anychart.core.annotations.Ray - 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.annotations.Ray - Self instance for method chaining.

secondValueAnchor

Getter for the second value anchor.

Returns:

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

Params:

NameTypeDescription
value*Second value anchor to set.

Returns:

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

secondXAnchor

Getter for the second X anchor.

Returns:

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

Params:

NameTypeDescription
Second*X anchor to set.

Returns:

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

select

Selects current annotation.

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.annotations.Ray - Self instance for method chaining.

stroke

Getter for stroke settings.

Returns:

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

Params:

NameTypeDefaultDescription
coloranychart.graphics.vector.Stroke | anychart.graphics.vector.ColoredFill | string | null
Stroke settings.
thicknessnumber
1
Ray thickness.
dashpatternstring
Controls the pattern of dashes and gaps used to stroke paths.
lineJoinstring | anychart.graphics.vector.StrokeLineJoin
Ray join style.
lineCapstring | anychart.graphics.vector.StrokeLineCap
Ray cap style.

Returns:

anychart.core.annotations.Ray - Self instance for method chaining.
Setter for annotation stroke settings using an object.

Params:

NameTypeDescription
settingsObjectObject with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

valueAnchor

Getter for the value anchor.

Returns:

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

Params:

NameTypeDescription
value*Value anchor to set.

Returns:

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

xAnchor

Getter for the X anchor.

Returns:

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

Params:

NameTypeDescription
value*X anchor to set.

Returns:

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

xScale

Setter for the X-scale.

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | anychart.scales.StockScatterDateTime | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Value to set

Returns:

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

yScale

Getter for the Y-scale.

Returns:

anychart.scales.Base - Default scale value.
Setter for the Y-scale.

Params:

NameTypeDefaultDescription
settingsanychart.scales.Base | Object | anychart.enums.ScaleTypes | string
anychart.scales.Linear
Y-scale to set.

Returns:

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