AnyChart
API Reference
Still have questions?
Contact support
Top
You are looking at an outdated v7 version of this document. Switch to the v8 version to see the up to date information.

class anychart.core.annotations.Rectangle Improve this Doc

Extends: anychart.core.annotations.Base

Rectangle 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.
fill()Fill settings.
hatchFill()Hatch fill settings.
hoverFill()Hover fill settings.
hoverHatchFill()Hover hatch fill settings.
hoverStroke()Hover stroke settings.
selectFill()Select fill settings.
selectHatchFill()Select hatch fill settings.
selectStroke()Select stroke settings.
stroke()Stroke settings.
Interactivity
allowEdit()Interactivity 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 currentAllowEdit = 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.Rectangle - 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
valuestringColor as a string.

Returns:

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

fill

Getter for the annotation fill color.

Returns:

anychart.graphics.vector.Fill - The annotation fill color.
See listing.
var currentFill = annotation.fill();
Setter for fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an array or a string.

Returns:

anychart.core.annotations.Rectangle - Self instance for method chaining.
Setter for fill settings using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction
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 fillValue; // type anychart.graphics.vector.Fill }.

Returns:

anychart.core.annotations.Rectangle - Self instance for method chaining.
Fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

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

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

anychart.core.annotations.Rectangle - 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

hatchFill

Getter for hatch fill settings.
See listing
var currentHatchFill = annotation.hatchFill();
Setter for hatch fill settings.

Params:

NameTypeDefaultDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
false
PatternFill or HatchFill instance or type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

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

hoverFill

Getter for the hover fill color.

Returns:

anychart.graphics.vector.Fill - The hover fill color.
See listing
var currentHoverFill = annotation.hoverFill();
Setter for hover fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an array or a string.

Returns:

anychart.core.annotations.Rectangle - Self instance for method chaining.
Setter for hover fill settings using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction
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 fillValue; // type anychart.graphics.vector.Fill }.

Returns:

anychart.core.annotations.Rectangle - Self instance for method chaining.
Hover fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.annotations.Rectangle - Self instance for method chaining.
Linear gradient hover 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.annotations.Rectangle - Self instance for method chaining.
Radial gradient hover 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.annotations.Rectangle - Self instance for method chaining.
Image hover fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

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:

NameTypeDescription
value*Value to set.

Returns:

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

hoverHatchFill

Getter for hover hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hover hatch fill settings.
See listing
var currentHoverHatchFill = annotation.hoverHatchFill();
Setter for hover hatch fill settings.

Params:

NameTypeDefaultDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
false
PatternFill or HatchFill instance or type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

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

hoverMarkers

Getter for data hover markers.

Returns:

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

Params:

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

Returns:

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

hoverStroke

Getter for hover stroke settings.

Returns:

anychart.graphics.vector.Stroke - Hover stroke settings.
See listing.
var currentHoverStroke = annotation.hoverStroke();
Setter for the hover stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction
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.Rectangle - Self instance for method chaining.
Setter for hover stroke settings. Learn more about stroke settings.

Params:

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

Returns:

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

markers

Getter for data markers.

Returns:

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

Params:

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

Returns:

anychart.core.annotations.Rectangle - 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.rectangle();
var currentSecondValueAnchor = annotation.secondValueAnchor();
Setter for the second value anchor.

Params:

NameTypeDescription
value*Second value anchor to set.

Returns:

anychart.core.annotations.Rectangle - 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.rectangle();
var currentSecondXAnchor = annotation.secondXAnchor();
Setter for the second X anchor.

Params:

NameTypeDescription
value*Second X anchor to set.

Returns:

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

selectFill

Getter for the select fill color.

Returns:

anychart.graphics.vector.Fill - The select fill color.
See listing
var currentSelectFill = annotation.selectFill();
Setter for select fill settings using an array or a string. Learn more about coloring.

Params:

NameTypeDescription
valueanychart.graphics.vector.FillColor as an array or a string.

Returns:

anychart.core.annotations.Rectangle - Self instance for method chaining.
Setter for select fill settings using function.

Params:

NameTypeDefaultDescription
fillFunctionfunction
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 fillValue; // type anychart.graphics.vector.Fill }.

Returns:

anychart.core.annotations.Rectangle - Self instance for method chaining.
Select fill color with opacity.

Params:

NameTypeDescription
colorstringColor as a string.
opacitynumberColor opacity.

Returns:

anychart.core.annotations.Rectangle - Self instance for method chaining.
Linear gradient select 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.annotations.Rectangle - Self instance for method chaining.
Radial gradient select 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.annotations.Rectangle - Self instance for method chaining.
Image select fill. Learn more about coloring.

Params:

NameTypeDescription
imageSettingsanychart.graphics.vector.FillObject with settings.

Returns:

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

selectHatchFill

Getter for select hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Select hatch fill settings.
See listing
var currentSelectHatchFill = annotation.selectHatchFill();
Setter for select hatch fill settings.

Params:

NameTypeDefaultDescription
patternFillOrTypeanychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function | anychart.graphics.vector.HatchFill.HatchFillType | string | boolean
false
PatternFill or HatchFill instance or type of hatch fill.
colorstring
Color.
thicknessnumber
Thickness.
sizenumber
Pattern size.

Returns:

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

selectMarkers

Getter for data select markers.

Returns:

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

Params:

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

Returns:

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

selectStroke

Getter for select stroke settings.

Returns:

anychart.graphics.vector.Stroke - Select stroke settings.
See listing.
var currentSelectStroke = annotation.selectStroke();
Setter for the select stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction
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.Rectangle - Self instance for method chaining.
Setter for select stroke settings. Learn more about stroke settings.

Params:

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

Returns:

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

stroke

Getter for annotation stroke settings.

Returns:

anychart.graphics.vector.Stroke - The current stroke settings.
See listing.
var currentAnnotationStroke = annotation.stroke();
Setter for the annotation stroke by function.

Params:

NameTypeDefaultDescription
strokeFunctionfunction
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.Rectangle - Self instance for method chaining.
Setter for annotation stroke settings. Learn more about stroke settings.

Params:

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

Returns:

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

valueAnchor

Getter for the value anchor.

Returns:

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

Params:

NameTypeDescription
value*Value anchor to set.

Returns:

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

xAnchor

Getter for the X anchor.

Returns:

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

Params:

NameTypeDescription
value*X anchor to set.

Returns:

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

xScale

Setter for the X-scale.

Params:

NameTypeDescription
valueanychart.scales.Base | anychart.scales.StockScatterDateTimeValue to set

Returns:

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

yScale

Getter for the Y-scale.

Returns:

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

Params:

NameTypeDescription
valueanychart.scales.BaseY-scale to set.

Returns:

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