class anychart.core.annotations.HorizontalLine Improve this Doc
Extends: anychart.core.annotations.Base
Horizontal Line 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. |
| hoverStroke() | Hover stroke settings. |
| selectStroke() | Select stroke settings. |
| stroke() | Stroke settings. |
| Interactivity | |
| allowEdit() | Interactivity settings. |
| Size and Position | |
| hoverGap() | Hover gap settings. |
| valueAnchor() | Value 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.HorizontalLine - 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.
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.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| value | string | Color as a string. |
Returns:
anychart.core.annotations.HorizontalLine - 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
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.
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:
hoverMarkers
Setter for data hover markers.
Detailed description
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.HorizontalLine - Self instance for method chaining.hoverStroke
Getter for hover stroke settings.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Stroke - Hover stroke settings. See listing.
var currentAnnotationHoverStroke = annotation.hoverStroke();
Setter for 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.HorizontalLine - Self instance for method chaining.Try it:
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.HorizontalLine - Self instance for method chaining.Try it:
markers
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 |
|---|---|---|---|
| value | Object | boolean | null | string | false | Data markers settings. |
Returns:
anychart.core.annotations.HorizontalLine - Self instance for method chaining.selectMarkers
Setter for data select markers.
Detailed description
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.HorizontalLine - Self instance for method chaining.selectStroke
Getter for select stroke settings.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Stroke - Select stroke settings. See listing.
var currentAnnotationSelectStroke = annotation.selectStroke();
Setter for 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.HorizontalLine - Self instance for method chaining.Try it:
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.HorizontalLine - Self instance for method chaining.Try it:
stroke
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 currentAnnotationStroke = annotation.stroke();
Setter for annotations 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.HorizontalLine - Self instance for method chaining.Try it:
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 | 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.HorizontalLine - 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.horizontalLine(); var currentValueAnchor = annotation.valueAnchor();
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:
xScale
Getter for the X-scale.
Returns:
anychart.scales.Ordinal | anychart.scales.Linear | anychart.scales.Logarithmic | anychart.scales.StockScatterDateTime - Default scale value.Try it:
Setter for the X-scale.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.scales.Base | anychart.scales.StockScatterDateTime | Value to set |
Returns:
anychart.core.annotations.HorizontalLine - Self instance for method chaining.Try it:
yScale
Setter for the Y-scale.
Params:
| Name | Type | Description |
|---|---|---|
| value | anychart.scales.Base | Y-scale to set. |
Returns:
anychart.core.annotations.HorizontalLine - Self instance for method chaining.Try it: