Top

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.
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.
fill()Fill settings.
hatchFill()Hatch fill settings.
stroke()Stroke settings.
Interactivity
allowEdit()Interactivity settings.
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
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:

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

Try it:

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

Try it:

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:

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.
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:

Fill color with 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:

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:

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:

Params:

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

Returns:

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

hatchFill

Getter for hatch fill settings.
See listing
var currentHatchFill = annotation.hatchFill();
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:

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.Base - 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.rectangle();
var currentSecondValueAnchor = annotation.secondValueAnchor();
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:

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:

Name Type Description
value * Second X anchor to set.

Returns:

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

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:

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:

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:

Name Type Description
value * Value anchor to set.

Returns:

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

Params:

Name Type Description
value * X anchor to set.

Returns:

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