class anychart.core.annotations.Rectangle Improve this Doc

var currentAllowEdit = annotation.allowEdit();

allowEdit(value)Since version 7.11.0

Setter for an interactivity in the annotation.

Params:

Name	Type	Description
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.

Try it:

Usage sample

color

color()Since version 7.11.0

Getter for the annotation color.

Returns:

string - The annotation color.

var color = annotation.color();

color(value)Since version 7.11.0

Setter for the annotation color.

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.

Params:

Name	Type	Description
value	string	Color as a string.

Returns:

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

Try it:

Usage sample

fill

fill()

Getter for the annotation fill color.

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Fill - The annotation fill color.

var currentFill = annotation.fill();

fill(value)

Setter for fill settings using an array or 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.annotations.Rectangle - Self instance for method chaining.

Try it:

fill(fillFunction)

Setter for fill settings using function.

Params:

Name	Type	Default	Description
fillFunction	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 fillValue; // type anychart.graphics.vector.Fill }`.

Returns:

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

Try it:

Usage sample

fill(color, opacity)

Fill color with opacity.

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

Try it:

Usage sample

fill(keys, angle, mode, opacity)

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

Try it:

Usage sample

fill(keys, cx, cy, mode, opacity, fx, fy)

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

Try it:

Usage sample

fill(imageSettings)

Image fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

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

Try it:

Usage sample

getChart

getChart()Since version 7.11.0

Returns the chart on which the annotation is drawn.

Returns:

anychart.core.SeparateChart - Chart.

Try it:

Usage sample

getPlot

getPlot()Since version 7.11.0

Returns the plot on which the annotation is drawn.

Returns:

anychart.core.stock.Plot - Stock plot.

Try it:

Usage sample

getType

getType()Since version 7.11.0

Returns annotation type.

Returns:

anychart.enums.AnnotationTypes | string - Annotation type

Try it:

Usage sample

hatchFill

hatchFill()

Getter for hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings.

var currentHatchFill = annotation.hatchFill();

hatchFill(patternFillOrType, color, thickness, size)

Setter for hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrType	anychart.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.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

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

Try it:

Usage sample

hoverFill

hoverFill()

Getter for the hover fill color.

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Fill - The hover fill color.

var currentHoverFill = annotation.hoverFill();

hoverFill(value)

Setter for hover fill settings using an array or 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.annotations.Rectangle - Self instance for method chaining.

Try it:

hoverFill(fillFunction)

Setter for hover fill settings using function.

Params:

Name	Type	Default	Description
fillFunction	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 fillValue; // type anychart.graphics.vector.Fill }`.

Returns:

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

Try it:

Usage sample

hoverFill(color, opacity)

Hover fill color with opacity.

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

Try it:

Usage sample

hoverFill(keys, angle, mode, opacity)

Linear gradient hover 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.annotations.Rectangle - Self instance for method chaining.

Try it:

Usage sample

hoverFill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient hover 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.annotations.Rectangle - Self instance for method chaining.

Try it:

Usage sample

hoverFill(imageSettings)

Image hover fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

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

Try it:

Usage sample

hoverGap

hoverGap()Since version 7.11.0

Getter for the hover gap.

Returns:

number - The hover gap value.

var currentHoverGap = annotation.hoverGap();

hoverGap(value)Since version 7.11.0

Setter for the hover gap.
The contour size around annotation.

Params:

Name	Type	Description
value	*	Value to set.

Returns:

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

Try it:

Usage sample

hoverHatchFill

hoverHatchFill()

Getter for hover hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hover hatch fill settings.

var currentHoverHatchFill = annotation.hoverHatchFill();

hoverHatchFill(patternFillOrType, color, thickness, size)

Setter for hover hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrType	anychart.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.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

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

Try it:

Usage sample

hoverMarkers

hoverMarkers()Since version 7.11.0

Getter for data hover markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

hoverMarkers(value)Since version 7.11.0

Setter for data hover markers.

Sets chart markers settings depending on parameter type:

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

Try it:

hoverStroke

hoverStroke()Since version 7.11.0

Getter for hover stroke settings.

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Stroke - Hover stroke settings.

var currentHoverStroke = annotation.hoverStroke();

hoverStroke(strokeFunction)Since version 7.11.0

Setter for the hover 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.Rectangle - Self instance for method chaining.

Try it:

Usage sample

hoverStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.11.0

Setter for hover 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.Rectangle - Self instance for method chaining.

Try it:

Usage sample

markers

markers()Since version 7.11.0

Getter for data markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

markers(value)Since version 7.11.0

Setter for data markers.

Sets chart markers settings depending on parameter type:

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

Try it:

secondValueAnchor

secondValueAnchor()Since version 7.11.0

Getter for the second value anchor.

Returns:

* - The second value anchor.

var controller = chart.annotations();
var annotation = controller.rectangle();
var currentSecondValueAnchor = annotation.secondValueAnchor();

secondValueAnchor(value)Since version 7.11.0

Setter for the second value anchor.

Params:

Name	Type	Description
value	*	Second value anchor to set.

Returns:

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

Try it:

Usage sample

secondXAnchor

secondXAnchor()Since version 7.11.0

Getter for the second X anchor.

Returns:

* - The second X anchor.

var controller = chart.annotations();
var annotation = controller.rectangle();
var currentSecondXAnchor = annotation.secondXAnchor();

secondXAnchor(value)Since version 7.11.0

Setter for the second X anchor.

Params:

Name	Type	Description
value	*	Second X anchor to set.

Returns:

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

Try it:

Usage sample

selectFill

selectFill()

Getter for the select fill color.

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Fill - The select fill color.

var currentSelectFill = annotation.selectFill();

selectFill(value)

Setter for select fill settings using an array or 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.annotations.Rectangle - Self instance for method chaining.

Try it:

selectFill(fillFunction)

Setter for select fill settings using function.

Params:

Name	Type	Default	Description
fillFunction	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 fillValue; // type anychart.graphics.vector.Fill }`.

Returns:

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

Try it:

Usage sample

selectFill(color, opacity)

Select fill color with opacity.

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

Try it:

Usage sample

selectFill(keys, angle, mode, opacity)

Linear gradient select 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.annotations.Rectangle - Self instance for method chaining.

Try it:

Usage sample

selectFill(keys, cx, cy, mode, opacity, fx, fy)

Radial gradient select 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.annotations.Rectangle - Self instance for method chaining.

Try it:

Usage sample

selectFill(imageSettings)

Image select fill. Learn more about coloring.

Params:

Name	Type	Description
imageSettings	anychart.graphics.vector.Fill	Object with settings.

Returns:

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

Try it:

Usage sample

selectHatchFill

selectHatchFill()

Getter for select hatch fill settings.

Returns:

anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Select hatch fill settings.

var currentSelectHatchFill = annotation.selectHatchFill();

selectHatchFill(patternFillOrType, color, thickness, size)

Setter for select hatch fill settings.

Params:

Name	Type	Default	Description
patternFillOrType	anychart.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.
color	string		Color.
thickness	number		Thickness.
size	number		Pattern size.

Returns:

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

Try it:

Usage sample

selectMarkers

selectMarkers()Since version 7.11.0

Getter for data select markers.

Returns:

anychart.core.ui.MarkersFactory - Markers instance.

Try it:

Usage sample

selectMarkers(value)Since version 7.11.0

Setter for data select markers.

Sets chart markers settings depending on parameter type:

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

Try it:

selectStroke

selectStroke()Since version 7.11.0

Getter for select stroke settings.

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Stroke - Select stroke settings.

var currentSelectStroke = annotation.selectStroke();

selectStroke(strokeFunction)Since version 7.11.0

Setter for the select 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.Rectangle - Self instance for method chaining.

Try it:

Usage sample

selectStroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.11.0

Setter for select 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.Rectangle - Self instance for method chaining.

Try it:

Usage sample

stroke

stroke()Since version 7.11.0

Getter for annotation stroke settings.

This method can be used as getter only if the value has been previously set.

Returns:

anychart.graphics.vector.Stroke - The current stroke settings.

var currentAnnotationStroke = annotation.stroke();

stroke(strokeFunction)Since version 7.11.0

Setter for the annotation 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.Rectangle - Self instance for method chaining.

Try it:

Usage sample

stroke(color, thickness, dashpattern, lineJoin, lineCap)Since version 7.11.0

Setter for annotation 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.Rectangle - Self instance for method chaining.

Try it:

Usage sample

valueAnchor

valueAnchor()Since version 7.11.0

Getter for the value anchor.

Returns:

* - The value anchor.

var controller = chart.annotations();
var annotation = controller.rectangle();
var currentValueAnchor = annotation.valueAnchor();

valueAnchor(value)Since version 7.11.0

Setter for the value anchor.

Params:

Name	Type	Description
value	*	Value anchor to set.

Returns:

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

Try it:

Usage sample

xAnchor

xAnchor()Since version 7.11.0

Getter for the X anchor.

Returns:

* - The X anchor.