class anychart.core.annotations.HorizontalRange Improve this Doc
Extends: anychart.core.annotations.Base
HorizontalRange 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. |
| 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. |
| secondValueAnchor() | Second value anchor settings |
| top() | Top bound settings. |
| valueAnchor() | Value anchor settings |
| width() | Width settings. |
| zIndex() | Z-index of the element. |
Methods Description
allowEdit
Getter for an interactivity in the annotation.
Returns:
boolean - Interactivity settings. See listing.
var allowEdit = 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.HorizontalRange - Self instance for method chaining.Try it:
bottom
Getter for element bottom bound settings.
Returns:
number | string | undefined - Element's bottom bound setting.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.HorizontalRange - Returns self for method chaining.Try it:
bounds
Getter for element bounds settings.
Returns:
anychart.core.utils.Bounds - Bounds of the element.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.HorizontalRange - Self instance for method chaining.Try it:
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.HorizontalRange - 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 |
|---|---|---|
| color | string | Color as a string. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
enabled
Getter for the element state (enabled or disabled).
Returns:
boolean - Element state.Try it:
Setter for the element enabled state.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | true | Enabled state to set. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining. Example.
if (!element.enabled()) element.enabled(true);
Try it:
fill
Getter for the annotation fill color.
Detailed description
This method can be used as getter only if the value has been previously set.
Returns:
anychart.graphics.vector.Fill - The annotation fill color. See listing.
var controller = chart.annotations(); var annotation = controller.horizontalRange(); var fill = annotation.fill();
Setter for fill settings using an array, an object or a string.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| color | anychart.graphics.vector.Fill | Array.<(anychart.graphics.vector.GradientKey|string)> | Color as an array, an object or a string. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Setter for fill settings using function.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| fillFunction | function():anychart.graphics.vector.Fill | 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.HorizontalRange - Self instance for method chaining.Try it:
Fill color with opacity.
Detailed description
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 (0 to 1). |
Returns:
anychart.core.annotations.HorizontalRange - 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.HorizontalRange - 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.HorizontalRange - Self instance for method chaining.Try it:
Image fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| imageSettings | anychart.graphics.vector.Fill | Object with settings. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
getChart
Returns the chart on which the annotation is drawn.
Returns:
anychart.core.SeparateChart - Chart.Try it:
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
Returns the plot on which the annotation is drawn.
Returns:
anychart.core.stock.Plot - Stock plot.Try it:
getType
hatchFill
Getter for hatch fill settings.
Returns:
anychart.graphics.vector.PatternFill | anychart.graphics.vector.HatchFill | function - Hatch fill settings. See listing
var controller = chart.annotations(); var annotation = controller.horizontalRange(); var hatchFill = annotation.hatchFill();
Setter for hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| type | anychart.graphics.vector.HatchFill.HatchFillType | string | false | Type of hatch fill. |
| color | string | Color. | |
| thickness | number | Thickness. | |
| size | number | Pattern size. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
Setter for hatch fill settings using function.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| hatchFillFunction | function | HatchFill function. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
Setter for hatch fill settings using pattern fill.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| patternFill | anychart.graphics.vector.PatternFill | Pattern fill to set. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
Setter for hatch fill settings using an instance.
Learn more about coloring.
Params:
| Name | Type | Description |
|---|---|---|
| settings | anychart.graphics.vector.HatchFill | Hatch fill instance. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
Setter for hatch fill using boolean.
Learn more about hatch fill settings.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| enabled | boolean | false | Whether to enable hatch fill or no. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
height
Getter for element height settings.
Returns:
number | string | undefined - Element's height setting.Setter for element height setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Height settings for the element. |
Returns:
anychart.core.annotations.HorizontalRange - Returns self for method chaining.Try it:
hoverGap
Getter for the hover gap.
Returns:
number - The hover gap value. See listing.
var hoverGap = 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.HorizontalRange - Self instance for method chaining.Try it:
hovered
Getter for hovered state settings.
Returns:
anychart.core.StateSettings - Hovered state settingsTry it:
Setter for hovered state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
left
Getter for element left bound settings.
Returns:
number | string | undefined - Element's left bound setting.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.HorizontalRange - Returns self 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 |
|---|---|---|---|
| settings | Object | boolean | null | string | false | Data markers settings. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.maxHeight
Getter for the maximum height.
Returns:
number | string | null - Element's maximum height.Setter for the maximum height.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | string | null | null | Maximum height to set. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
maxWidth
Getter for the maximum width.
Returns:
number | string | null - Element's maximum width.Setter for the maximum width.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Maximum width to set. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
minHeight
Getter for the minimum height.
Returns:
number | string | null - Element's minimum 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.HorizontalRange - Self instance for method chaining.Try it:
minWidth
Getter for the minimum width.
Returns:
number | string | null - Element's minimum 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.HorizontalRange - Self instance for method chaining.Try it:
normal
Getter for normal state settings.
Returns:
anychart.core.StateSettings - Normal state settings.Try it:
Setter for normal state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
right
Getter for element right bound settings.
Returns:
number | string | undefined - Element's right bound setting.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.HorizontalRange - Returns self 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.horizontalRange(); var secondValueAnchor = annotation.secondValueAnchor();
Setter for the second value anchor.
Params:
| Name | Type | Description |
|---|---|---|
| value | * | Second value anchor to set. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
select
Selects current annotation.
Try it:
selected
Getter for selected state settings.
Returns:
anychart.core.StateSettings - Selected state settingsTry it:
Setter for selected state settings.
Params:
| Name | Type | Description |
|---|---|---|
| settings | Object | State settings to set. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
stroke
Getter for annotation 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 controller = chart.annotations(); var annotation = controller.horizontalRange(); var stroke = annotation.stroke();
Setter for the annotation 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
} |
Returns:
anychart.core.annotations.HorizontalRange - 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 | string | anychart.graphics.vector.StrokeLineJoin | Line join style. | |
| lineCap | string | anychart.graphics.vector.StrokeLineCap | Line cap style. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
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.HorizontalRange - Self instance for method chaining.Try it:
top
Getter for element top bound settings.
Returns:
number | string | undefined - Element's top bound setting.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.HorizontalRange - Returns self for method chaining.Try it:
valueAnchor
Getter for the value anchor.
Returns:
* - The value anchor. See listing.
var controller = chart.annotations(); var annotation = controller.horizontalRange(); var valueAnchor = annotation.valueAnchor();
Setter for the value anchor.
Params:
| Name | Type | Description |
|---|---|---|
| value | * | Value anchor to set. |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
width
Getter for element width settings.
Returns:
number | string | undefined - Element's width setting.Setter for element width setting.
Params:
| Name | Type | Default | Description |
|---|---|---|---|
| width | number | string | null | null | Width settings for the element. |
Returns:
anychart.core.annotations.HorizontalRange - Returns self 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 | Default | Description |
|---|---|---|---|
| settings | anychart.scales.Base | anychart.scales.StockScatterDateTime | Object | anychart.enums.ScaleTypes | string | anychart.scales.Linear | Value to set |
Returns:
anychart.core.annotations.HorizontalRange - Self instance for method chaining.Try it:
yScale
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.HorizontalRange - Self instance for method chaining.Try it:
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.HorizontalRange - Self instance for method chaining.Try it: