class anychart.core.annotations.HorizontalLine Improve this Doc

Horizontal Line 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
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.
enabled()	Element state (enabled or disabled).
hovered()	Hovered state settings.
normal()	Normal state settings.
select()	Selects current annotation.
selected()	Selected state settings.
Size and Position
bottom()	Bottom bound settings.
bounds()	Bounds settings.
getPixelBounds()	Returns pixel bounds.
height()	Height settings.
hoverGap()	Hover gap settings.
left()	Left bound settings.
maxHeight()	Maximum height.
maxWidth()	Maximum width.
minHeight()	Minimum height.
minWidth()	Minimum width.
right()	Right bound settings.
top()	Top bound settings.
valueAnchor()	Value anchor settings
width()	Width settings.
zIndex()	Z-index of the element.

Methods Description

allowEdit

allowEdit()Since version 7.11.0

Getter for an interactivity in the annotation.

Returns:

boolean - Interactivity settings.

See listing.

var allowEdit = 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.HorizontalLine - Self instance for method chaining.

Try it:

Usage sample

bottom

bottom()

Getter for element bottom bound settings.

Returns:

number | string | undefined - Element's bottom bound setting.

bottom(bottom)

Setter for element bottom bound settings.

Params:

Name	Type	Default	Description
bottom	number \| string \| null	null	Bottom bound settings for the element.

Returns:

anychart.core.annotations.HorizontalLine - Returns self for method chaining.

Try it:

Usage sample

bounds

bounds()

Getter for element bounds settings.

Returns:

anychart.core.utils.Bounds - Bounds of the element.

bounds(bounds)

Setter for bounds of the element using one parameter.

Params:

Name	Type	Description
bounds	anychart.utils.RectObj \| anychart.math.Rect \| anychart.core.utils.Bounds	Bounds of element.

Returns:

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

Try it:

Usage sample

bounds(x, y, width, height)

Setter for element bounds settings.

Params:

Name	Type	Default	Description
x	number \| string	null	X-coordinate.
y	number \| string	null	Y-coordinate.
width	number \| string	null	Width.
height	number \| string	null	Height.

Returns:

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

See listing.

var color = annotation.color();

color(color)Since version 7.11.0

Setter for the annotation color.

Detailed description

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
color	string	Color as a string.

Returns:

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

Try it:

Usage sample

enabled

enabled()

Getter for the element state (enabled or disabled).

Returns:

boolean - Element state.

Try it:

Usage sample

enabled(enabled)

Setter for the element enabled state.

Params:

Name	Type	Default	Description
enabled	boolean	true	Enabled state to set.

Returns:

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

Example.

if (!element.enabled())
   element.enabled(true);

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

getPixelBounds

getPixelBounds()

Returns pixel bounds of the element due to parent bounds and self bounds settings.

Returns:

anychart.math.Rect - Pixel bounds of the element.

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

height

height()

Getter for element height settings.

Returns:

number | string | undefined - Element's height setting.

height(height)

Setter for element height setting.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Height settings for the element.

Returns:

anychart.core.annotations.HorizontalLine - Returns self 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.

See listing.

var hoverGap = 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.HorizontalLine - Self instance for method chaining.

Try it:

Usage sample

hovered

hovered()Since version 8.0.0

Getter for hovered state settings.

Returns:

anychart.core.StateSettings - Hovered state settings

Try it:

Usage sample

hovered(settings)Since version 8.0.0

Setter for hovered state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

left

left()

Getter for element left bound settings.

Returns:

number | string | undefined - Element's left bound setting.

left(left)

Setter for element left bound settings.

Params:

Name	Type	Default	Description
left	number \| string \| null	null	Left bound setting for the element.

Returns:

anychart.core.annotations.HorizontalLine - Returns self 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(settings)Since version 7.11.0

Setter for data markers.

Detailed description

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
settings	Object \| boolean \| null \| string	false	Data markers settings.

Returns:

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

Try it:

maxHeight

maxHeight()

Getter for the maximum height.

Returns:

number | string | null - Element's maximum height.

maxHeight(height)

Setter for the maximum height.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Maximum height to set.

Returns:

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

Try it:

Usage sample

maxWidth

maxWidth()

Getter for the maximum width.

Returns:

number | string | null - Element's maximum width.

maxWidth(width)

Setter for the maximum width.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Maximum width to set.

Returns:

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

Try it:

Usage sample

minHeight

minHeight()

Getter for the minimum height.

Returns:

number | string | null - Element's minimum height.

minHeight(height)

Setter for the minimum height.

Detailed description

The method sets a minimum height of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
height	number \| string \| null	null	Minimum height to set.

Returns:

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

Try it:

Usage sample

minWidth

minWidth()

Getter for the minimum width.

Returns:

number | string | null - Element's minimum width.

minWidth(width)

Setter for the minimum width.

Detailed description

The method sets a minimum width of elements, that will be to remain after a resize of element.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Minimum width to set.

Returns:

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

Try it:

Usage sample

normal

normal()Since version 8.0.0

Getter for normal state settings.

Returns:

anychart.core.StateSettings - Normal state settings.

Try it:

Usage sample

normal(settings)Since version 8.0.0

Setter for normal state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

right

right()

Getter for element right bound settings.

Returns:

number | string | undefined - Element's right bound setting.

right(right)

Setter for element right bound setting.

Params:

Name	Type	Default	Description
right	number \| string \| null	null	Right bound setting for the element.

Returns:

anychart.core.annotations.HorizontalLine - Returns self for method chaining.

Try it:

Usage sample

select

select()Since version 7.11.0

Selects current annotation.

Try it:

Usage sample

selected

selected()Since version 8.0.0

Getter for selected state settings.

Returns:

anychart.core.StateSettings - Selected state settings

Try it:

Usage sample

selected(settings)Since version 8.0.0

Setter for selected state settings.

Params:

Name	Type	Description
settings	Object	State settings to set.

Returns:

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

Try it:

Usage sample

stroke

stroke()Since version 7.11.0

Getter for stroke settings.

Detailed description

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

Returns:

anychart.graphics.vector.Stroke - Stroke settings.

See listing.

var stroke = annotation.stroke();

stroke(strokeFunction)Since version 7.11.0

Setter for annotations stroke by function.

Params:

Name	Type	Default	Description
strokeFunction	function():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 }

Name

Type

Default

Description

strokeFunction

function():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.HorizontalLine - Self instance for method chaining.

Try it:

Usage sample

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

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 \| null		Stroke settings.
thickness	number	1	Line thickness.
dashpattern	string		Controls the pattern of dashes and gaps used to stroke paths.
lineJoin	string \| anychart.graphics.vector.StrokeLineJoin		Line join style.
lineCap	string \| anychart.graphics.vector.StrokeLineCap		Line cap style.

Returns:

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

Try it:

Usage sample

stroke(settings)Since version 7.11.0

Setter for annotation stroke settings using an object.

Params:

Name	Type	Description
settings	Object	Object with stroke settings from anychart.graphics.vector.Stroke

Returns:

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

Try it:

Usage sample

top

top()

Getter for element top bound settings.

Returns:

number | string | undefined - Element's top bound setting.

top(top)

Setter for element top bound settings.

Params:

Name	Type	Default	Description
top	number \| string \| null	null	Top bound setting for the element.

Returns:

anychart.core.annotations.HorizontalLine - Returns self for method chaining.

Try it:

Usage sample

valueAnchor

valueAnchor()Since version 7.11.0

Getter for the value anchor.

Returns:

* - The value anchor.

See listing.

var controller = chart.annotations();
var annotation = controller.horizontalLine();
var valueAnchor = 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.HorizontalLine - Self instance for method chaining.

Try it:

Usage sample

width

width()

Getter for element width settings.

Returns:

number | string | undefined - Element's width setting.

width(width)

Setter for element width setting.

Params:

Name	Type	Default	Description
width	number \| string \| null	null	Width settings for the element.

Returns:

anychart.core.annotations.HorizontalLine - Returns self for method chaining.

Try it:

Usage sample

yScale

yScale()Since version 7.11.0

Getter for the Y-scale.

Returns:

anychart.scales.Base - Default scale value.

Try it:

Usage sample

yScale(settings)Since version 7.11.0

Setter for the Y-scale.

Params:

Name	Type	Default	Description
settings	anychart.scales.Base \| Object \| anychart.enums.ScaleTypes \| string	anychart.scales.Linear	Y-scale to set.

Returns:

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

Try it:

Usage sample

zIndex

zIndex()

Getter for the Z-index of the element.

Returns:

number - Z-index.

Try it:

Usage sample

zIndex(zIndex)

Setter for the Z-index of the element.

Detailed description

The bigger the index - the higher the element position is.

Params:

Name	Type	Default	Description
zIndex	number	0	Value to set.

Returns:

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

Try it:

Usage sample