Class PlotOptionsLine
- All Implemented Interfaces:
Serializable
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds key to the keys arrayvoidAdds zone to the zones arraygetClip()getColor()getCrisp()String[]getKeys()getStep()Zones[]getZones()voidRemoves first occurrence of key in keys arrayvoidremoveZone(Zones zone) Removes first occurrence of zone in zones arrayvoidsetAllowPointSelect(Boolean allowPointSelect) Allow this series' points to be selected by clicking on the markers, bars or pie slices.voidsetAnimation(Boolean animation) Enable or disable the initial animation when a series is displayed.voidsetAnimationLimit(Number animationLimit) For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high.voidsetClassName(String className) A class name to apply to the series' graphical elements.voidDisable this option to allow series rendering in the whole plotting area.voidThe main color or the series.voidsetColorIndex(Number colorIndex) Styled mode only.voidsetColorKey(String colorKey) Determines what data value should be used to calculate point color ifcolorAxisis used.voidsetCompare(Compare compare) Compare the values of the series against the first non-null, non-zero value in the visible range.voidsetCompareBase(Number compareBase) When compare ispercent, this option dictates whether to use 0 or 100 as the base of comparison.voidsetConnectEnds(Boolean connectEnds) Polar charts only.voidsetConnectNulls(Boolean connectNulls) Whether to connect a graph line across null points.voidWhen true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen.voidsetCropThreshold(Number cropThreshold) When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom.voidYou can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.voidsetDashStyle(DashStyle dashStyle) A name for the dash style to use for the graph.voidsetDataGrouping(DataGrouping dataGrouping) Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts.voidsetDataLabels(DataLabels dataLabels) Options for the series data labels, appearing next to each data point.voidsetDescription(String description) Requires Accessibility modulevoidsetEnableMouseTracking(Boolean enableMouseTracking) Enable or disable the mouse tracking for a specific series.voidsetExposeElementToA11y(Boolean exposeElementToA11y) By default, series are exposed to screen readers as regions.voidsetFindNearestPointBy(Dimension findNearestPointBy) Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series.voidsetGapSize(Number gapSize) Defines when to display a gap in the graph.voidsetGapUnit(String gapUnit) Together withgapSize, this option defines where to draw gaps in the graph.voidsetGetExtremesFromAll(Boolean getExtremesFromAll) Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis.voidAn array specifying which option maps to which key in the data point array.voidsetLegendIndex(Number legendIndex) The sequential index of the series within the legend.voidsetLinecap(String linecap) The line cap used for line ends and line joins on the graph.voidsetLineWidth(Number lineWidth) Pixel with of the graph line.voidsetLinkedTo(String linkedTo) The id of another series to link to.voidOptions for the point markers of line-like series.voidsetNavigatorOptions(PlotOptionsSeries navigatorOptions) Options for the corresponding navigator series ifshowInNavigatoristruefor this series.voidsetNegativeColor(Color negativeColor) The color for the parts of the graph or points that are below the threshold.voidsetOpacity(Number opacity) Opacity of a series parts: line, fill (e.g. area) and dataLabels.voidsetPointDescriptionFormatter(String _fn_pointDescriptionFormatter) voidsetPointInterval(Number pointInterval) If no x values are given for the points in a series, pointInterval defines the interval of the x values.voidsetPointIntervalUnit(IntervalUnit pointIntervalUnit) On datetime series, this allows for setting the pointInterval to irregular time units,day,monthandyear.voidsetPointPlacement(PointPlacement pointPlacement) Possible values:null,"on","between".voidsetPointRange(Number pointRange) The width of each point on the x axis.voidsetPointStart(Number pointStart) If no x values are given for the points in a series, pointStart defines on what value to start.voidsetPointStart(Instant instant) voidsetSelected(Boolean selected) Whether to select the series initially.voidWhether to apply a drop shadow to the graph line.voidsetShowCheckbox(Boolean showCheckbox) If true, a checkbox is displayed next to the legend item to allow selecting the series.voidsetShowInLegend(Boolean showInLegend) Whether to display this particular series or series type in the legend.voidsetShowInNavigator(Boolean showInNavigator) Whether or not to show the series in the navigator.voidsetSkipKeyboardNavigation(Boolean skipKeyboardNavigation) If set toTrue, the accessibility module will skip past the points in this series for keyboard navigation.voidsetSoftThreshold(Boolean softThreshold) When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.voidsetStacking(Stacking stacking) Whether to stack the values of each series on top of each other.voidA wrapper object for all the series options in specific states.voidWhether to apply steps to the line.voidsetStickyTracking(Boolean stickyTracking) Sticky tracking of mouse events.voidsetThreshold(Number threshold) The threshold, also called zero level or base level.voidsetTooltip(SeriesTooltip tooltip) A configuration object for the tooltip rendering of each single series.voidsetTurboThreshold(Number turboThreshold) When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed.voidsetVisible(Boolean visible) Set the initial visibility of the series.voidsetZoneAxis(ZoneAxis zoneAxis) Defines the Axis on which the zones are applied.voidAn array defining zones within a series.
-
Constructor Details
-
PlotOptionsLine
public PlotOptionsLine()
-
-
Method Details
-
getChartType
- Specified by:
getChartTypein classPointOptions
-
getAllowPointSelect
- Specified by:
getAllowPointSelectin classPointOptions- See Also:
-
setAllowPointSelect
Allow this series' points to be selected by clicking on the markers, bars or pie slices.Defaults to: false
- Specified by:
setAllowPointSelectin classPointOptions
-
getAnimation
- Specified by:
getAnimationin classPointOptions- See Also:
-
setAnimation
Enable or disable the initial animation when a series is displayed. Please note that this option only applies to the initial animation of the series itself. For other animations, seeChartModel.setAnimation(Boolean)- Specified by:
setAnimationin classPointOptions
-
getAnimationLimit
- Specified by:
getAnimationLimitin classPointOptions- See Also:
-
setAnimationLimit
For some series, there is a limit that shuts down initial animation by default when the total number of points in the chart is too high. For example, for a column chart and its derivatives, animation doesn't run if there is more than 250 points totally. To disable this cap, setanimationLimittoInfinity.- Specified by:
setAnimationLimitin classPointOptions
-
getClassName
- Specified by:
getClassNamein classPointOptions- See Also:
-
setClassName
A class name to apply to the series' graphical elements.- Specified by:
setClassNamein classPointOptions
-
getClip
- Specified by:
getClipin classPointOptions- See Also:
-
setClip
Disable this option to allow series rendering in the whole plotting area. Note that lipping should be always enabled when chart.zoomType is setDefaults to
false.- Specified by:
setClipin classPointOptions
-
getColor
- Specified by:
getColorin classPointOptions- See Also:
-
setColor
The main color or the series. In line type series it applies to the line and the point markers unless otherwise specified. In bar type series it applies to the bars unless a color is specified per point. The default value is pulled from the
options.colorsarray.In styled mode, the color can be defined by the colorIndex option. Also, the series color can be set with the
.highcharts-series,.highcharts-color-{n},.highcharts-{type}-seriesor.highcharts-series-{n}class, or individual classes given by theclassNameoption.- Specified by:
setColorin classPointOptions
-
getColorIndex
- Specified by:
getColorIndexin classPointOptions- See Also:
-
setColorIndex
Styled mode only. A specific color index to use for the series, so its graphic representations are given the class namehighcharts-color-{n}.- Specified by:
setColorIndexin classPointOptions
-
getColorKey
- Specified by:
getColorKeyin classPointOptions- See Also:
-
setColorKey
Determines what data value should be used to calculate point color ifcolorAxisis used. Requires to set min and max if some custom point property is used or if approximation for data grouping is set to'sum'.Defaults to
y.- Specified by:
setColorKeyin classPointOptions
-
getCrisp
- Specified by:
getCrispin classPointOptions- See Also:
-
setCrisp
When true, each point or column edge is rounded to its nearest pixel in order to render sharp on screen. In some cases, when there are a lot of densely packed columns, this leads to visible difference in column widths or distance between columns. In these cases, settingcrisptofalsemay look better, even though each column is rendered blurry.Defaults to
true.- Specified by:
setCrispin classPointOptions
-
getConnectEnds
- See Also:
-
setConnectEnds
Polar charts only. Whether to connect the ends of a line series plot across the extremes.Defaults to: true
-
getConnectNulls
- See Also:
-
setConnectNulls
Whether to connect a graph line across null points.Defaults to: false
-
getCropThreshold
- Specified by:
getCropThresholdin classPointOptions- See Also:
-
setCropThreshold
When the series contains less points than the crop threshold, all points are drawn, even if the points fall outside the visible plot area at the current zoom. The advantage of drawing all points (including markers and columns), is that animation is performed on updates. On the other hand, when the series contains more points than the crop threshold, the series data is cropped to only contain points that fall within the plot area. The advantage of cropping away invisible points is to increase performance on large series.Defaults to: 300
- Specified by:
setCropThresholdin classPointOptions
-
getCursor
- Specified by:
getCursorin classPointOptions- See Also:
-
setCursor
You can set the cursor to "pointer" if you have click events attached to the series, to signal to the user that the points and lines can be clicked.- Specified by:
setCursorin classPointOptions
-
getDashStyle
- Specified by:
getDashStylein classPointOptions- See Also:
-
setDashStyle
A name for the dash style to use for the graph. Applies only to series type having a graph, likeline,spline,areaandscatterin case it has alineWidth. The value for thedashStyleinclude:- Solid
- ShortDash
- ShortDot
- ShortDashDot
- ShortDashDotDot
- Dot
- Dash
- LongDash
- DashDot
- LongDashDot
- LongDashDotDot
Defaults to: Solid
- Specified by:
setDashStylein classPointOptions
-
getDataLabels
- Specified by:
getDataLabelsin classPointOptions- See Also:
-
setDataLabels
Options for the series data labels, appearing next to each data point.
In styled mode, the data labels can be styled wtih the
.highcharts-data-label-boxand.highcharts-data-labelclass names (see example).- Specified by:
setDataLabelsin classPointOptions
-
getDescription
- Specified by:
getDescriptionin classPointOptions- See Also:
-
setDescription
Requires Accessibility module
A description of the series to add to the screen reader information about the series.
Defaults to: undefined
- Specified by:
setDescriptionin classPointOptions
-
getEnableMouseTracking
- Specified by:
getEnableMouseTrackingin classPointOptions- See Also:
-
setEnableMouseTracking
Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on graphs and points. For large datasets it improves performance.Defaults to: true
- Specified by:
setEnableMouseTrackingin classPointOptions
-
getExposeElementToA11y
- Specified by:
getExposeElementToA11yin classPointOptions- See Also:
-
setExposeElementToA11y
By default, series are exposed to screen readers as regions. By enabling this option, the series element itself will be exposed in the same way as the data points. This is useful if the series is not used as a grouping entity in the chart, but you still want to attach a description to the series.
Requires the Accessibility module.
Defaults to: undefined
- Specified by:
setExposeElementToA11yin classPointOptions
-
getFindNearestPointBy
- Specified by:
getFindNearestPointByin classPointOptions- See Also:
-
setFindNearestPointBy
Determines whether the series should look for the nearest point in both dimensions or just the x-dimension when hovering the series. Defaults to
'xy'for scatter series and'x'for most other series. If the data has duplicate x-values, it is recommended to set this to'xy'to allow hovering over all points.Applies only to series types using nearest neighbor search (not direct hover) for tooltip.
- Specified by:
setFindNearestPointByin classPointOptions
-
getGetExtremesFromAll
- Specified by:
getGetExtremesFromAllin classPointOptions- See Also:
-
setGetExtremesFromAll
Whether to use the Y extremes of the total chart width or only the zoomed area when zooming in on parts of the X axis. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.Defaults to: false
- Specified by:
setGetExtremesFromAllin classPointOptions
-
getKeys
- Specified by:
getKeysin classPointOptions- See Also:
-
setKeys
An array specifying which option maps to which key in the data point array. This makes it convenient to work with unstructured data arrays from different sources.- Specified by:
setKeysin classPointOptions
-
addKey
Adds key to the keys array- Specified by:
addKeyin classPointOptions- Parameters:
key- to add- See Also:
-
removeKey
Removes first occurrence of key in keys array- Specified by:
removeKeyin classPointOptions- Parameters:
key- to remove- See Also:
-
getLineWidth
- Specified by:
getLineWidthin classPointOptions- See Also:
-
setLineWidth
Pixel with of the graph line.Defaults to: 2
- Specified by:
setLineWidthin classPointOptions
-
getLinecap
- See Also:
-
setLinecap
The line cap used for line ends and line joins on the graph.Defaults to: round
-
getLinkedTo
- Specified by:
getLinkedToin classPointOptions- See Also:
-
setLinkedTo
The id of another series to link to. Additionally, the value can be ":previous" to link to the previous series. When two series are linked, only the first one appears in the legend. Toggling the visibility of this also toggles the linked series.- Specified by:
setLinkedToin classPointOptions
-
getMarker
- Specified by:
getMarkerin classPointOptions- See Also:
-
setMarker
Options for the point markers of line-like series. Properties like
fillColor,lineColorandlineWidthdefine the visual appearance of the markers. Other series types, like column series, don't have markers, but have visual options on the series level instead.In styled mode, the markers can be styled with the
.highcharts-point,.highcharts-point-hoverand.highcharts-point-selectclass names.- Specified by:
setMarkerin classPointOptions
-
getNegativeColor
- Specified by:
getNegativeColorin classPointOptions- See Also:
-
setNegativeColor
The color for the parts of the graph or points that are below the threshold.Defaults to: null
- Specified by:
setNegativeColorin classPointOptions
-
getOpacity
- Specified by:
getOpacityin classPointOptions- See Also:
-
setOpacity
Opacity of a series parts: line, fill (e.g. area) and dataLabels.Defaults to
1.- Specified by:
setOpacityin classPointOptions
-
getPointDescriptionFormatter
- Specified by:
getPointDescriptionFormatterin classPointOptions
-
setPointDescriptionFormatter
- Specified by:
setPointDescriptionFormatterin classPointOptions
-
getPointInterval
- Specified by:
getPointIntervalin classPointOptions- See Also:
-
setPointInterval
If no x values are given for the points in a series, pointInterval defines the interval of the x values. For example, if a series contains one value every decade starting from year 0, set pointInterval to 10.
Since Highcharts 4.1, it can be combined with
pointIntervalUnitto draw irregular intervals.Defaults to: 1
- Specified by:
setPointIntervalin classPointOptions
-
getPointIntervalUnit
- Specified by:
getPointIntervalUnitin classPointOptions- See Also:
-
setPointIntervalUnit
On datetime series, this allows for setting the pointInterval to irregular time units,day,monthandyear. A day is usually the same as 24 hours, but pointIntervalUnit also takes the DST crossover into consideration when dealing with local time. Combine this option withpointIntervalto draw weeks, quarters, 6 months, 10 years etc.- Specified by:
setPointIntervalUnitin classPointOptions
-
getPointPlacement
- Specified by:
getPointPlacementin classPointOptions- See Also:
-
setPointPlacement
Possible values:
null,"on","between".In a column chart, when pointPlacement is
"on", the point will not create any padding of the X axis. In a polar column chart this means that the first column points directly north. If the pointPlacement is"between", the columns will be laid out between ticks. This is useful for example for visualising an amount between two points in time or in a certain sector of a polar chart.Since Highcharts 3.0.2, the point placement can also be numeric, where 0 is on the axis value, -0.5 is between this value and the previous, and 0.5 is between this value and the next. Unlike the textual options, numeric point placement options won't affect axis padding.
Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.
Defaults to
nullin cartesian charts,"between"in polar charts.- Specified by:
setPointPlacementin classPointOptions
-
getPointStart
- Specified by:
getPointStartin classPointOptions- See Also:
-
setPointStart
If no x values are given for the points in a series, pointStart defines on what value to start. For example, if a series contains one yearly value starting from 1945, set pointStart to 1945.Defaults to: 0
- Specified by:
setPointStartin classPointOptions
-
getSelected
- Specified by:
getSelectedin classPointOptions- See Also:
-
setSelected
Whether to select the series initially. IfshowCheckboxis true, the checkbox next to the series name will be checked for a selected series.Defaults to: false
- Specified by:
setSelectedin classPointOptions
-
getShadow
- Specified by:
getShadowin classPointOptions- See Also:
-
setShadow
Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containingcolor,offsetX,offsetY,opacityandwidth.Defaults to: false
- Specified by:
setShadowin classPointOptions
-
getShowCheckbox
- Specified by:
getShowCheckboxin classPointOptions- See Also:
-
setShowCheckbox
If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by theselectedoption.Defaults to: false
- Specified by:
setShowCheckboxin classPointOptions
-
getShowInLegend
- Specified by:
getShowInLegendin classPointOptions- See Also:
-
setShowInLegend
Whether to display this particular series or series type in the legend. The default value istruefor standalone series,falsefor linked series.Defaults to: true
- Specified by:
setShowInLegendin classPointOptions
-
getSoftThreshold
- Specified by:
getSoftThresholdin classPointOptions- See Also:
-
setSoftThreshold
When this is true, the series will not cause the Y axis to cross the zero plane (or threshold option) unless the data actually crosses the plane.
For example, if
softThresholdisfalse, a series of 0, 1, 2, 3 will make the Y axis show negative values according to theminPaddingoption. IfsoftThresholdistrue, the Y axis starts at 0.Defaults to: true
- Specified by:
setSoftThresholdin classPointOptions
-
getStacking
- Specified by:
getStackingin classPointOptions- See Also:
-
setStacking
Whether to stack the values of each series on top of each other. Possible values are null to disable, "normal" to stack by value or "percent". When stacking is enabled, data must be sorted in ascending X order.- Specified by:
setStackingin classPointOptions
-
getStates
- Specified by:
getStatesin classPointOptions- See Also:
-
setStates
A wrapper object for all the series options in specific states.- Specified by:
setStatesin classPointOptions
-
getStep
- See Also:
-
setStep
Whether to apply steps to the line. Possible values areleft,centerandright. Prior to 2.3.5, onlyleftwas supported.Defaults to: false
-
getStickyTracking
- Specified by:
getStickyTrackingin classPointOptions- See Also:
-
setStickyTracking
Sticky tracking of mouse events. When true, themouseOutevent on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, themouseOutevent on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. WhenstickyTrackingis false andtooltip.sharedis false, the tooltip will be hidden when moving the mouse between series. Defaults to true for line and area type series, but to false for columns, pies etc.Defaults to: true
- Specified by:
setStickyTrackingin classPointOptions
-
getThreshold
- Specified by:
getThresholdin classPointOptions- See Also:
-
setThreshold
The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.Defaults to: 0
- Specified by:
setThresholdin classPointOptions
-
getTooltip
- Specified by:
getTooltipin classPointOptions- See Also:
-
setTooltip
A configuration object for the tooltip rendering of each single series. Properties are inherited from tooltip, but only the following properties can be defined on a series level.- Specified by:
setTooltipin classPointOptions
-
getTurboThreshold
- Specified by:
getTurboThresholdin classPointOptions- See Also:
-
setTurboThreshold
When a series contains a data array that is longer than this, only one dimensional arrays of numbers, or two dimensional arrays with x and y values are allowed. Also, only the first point is tested, and the rest are assumed to be the same format. This saves expensive data checking and indexing in long series. Set it to0disable.Defaults to: 1000
- Specified by:
setTurboThresholdin classPointOptions
-
getVisible
- Specified by:
getVisiblein classPointOptions- See Also:
-
setVisible
Set the initial visibility of the series.Defaults to: true
- Specified by:
setVisiblein classPointOptions
-
getZoneAxis
- Specified by:
getZoneAxisin classPointOptions- See Also:
-
setZoneAxis
Defines the Axis on which the zones are applied.Defaults to: y
- Specified by:
setZoneAxisin classPointOptions
-
getZones
- Specified by:
getZonesin classPointOptions- See Also:
-
setZones
An array defining zones within a series. Zones can be applied to the X axis, Y axis or Z axis for bubbles, according to the
zoneAxisoption.In styled mode, the color zones are styled with the
.highcharts-zone-{n}class, or custom classed from theclassNameoption (view live demo).- Specified by:
setZonesin classPointOptions
-
addZone
Adds zone to the zones array- Specified by:
addZonein classPointOptions- Parameters:
zone- to add- See Also:
-
removeZone
Removes first occurrence of zone in zones array- Specified by:
removeZonein classPointOptions- Parameters:
zone- to remove- See Also:
-
getCompare
- Specified by:
getComparein classPointOptions- See Also:
-
setCompare
Compare the values of the series against the first non-null, non-zero value in the visible range. The y axis will show percentage or absolute change depending on whethercompareis set to"percent"or"value". When this is applied to multiple series, it allows comparing the development of the series against each other.Defaults to: undefined
- Specified by:
setComparein classPointOptions
-
getCompareBase
- Specified by:
getCompareBasein classPointOptions- See Also:
-
setCompareBase
When compare ispercent, this option dictates whether to use 0 or 100 as the base of comparison.Defaults to: 0
- Specified by:
setCompareBasein classPointOptions
-
getDataGrouping
- Specified by:
getDataGroupingin classPointOptions- See Also:
-
setDataGrouping
Data grouping is the concept of sampling the data values into larger blocks in order to ease readability and increase performance of the JavaScript charts. Highstock by default applies data grouping when the points become closer than a certain pixel value, determined by the
groupPixelWidthoption.If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup.
- Specified by:
setDataGroupingin classPointOptions
-
getGapSize
- See Also:
-
setGapSize
Defines when to display a gap in the graph. A gap size of 5 means that if the distance between two points is greater than five times that of the two closest points, the graph will be broken.
In practice, this option is most often used to visualize gaps in time series. In a stock chart, intraday data is available for daytime hours, while gaps will appear in nights and weekends.
Defaults to: 0
-
getGapUnit
- Specified by:
getGapUnitin classPointOptions- See Also:
-
setGapUnit
Together withgapSize, this option defines where to draw gaps in the graph.Defaults to: relative
- Specified by:
setGapUnitin classPointOptions
-
getLegendIndex
- Specified by:
getLegendIndexin classPointOptions- See Also:
-
setLegendIndex
The sequential index of the series within the legend.Defaults to: 0
- Specified by:
setLegendIndexin classPointOptions
-
getPointRange
- Specified by:
getPointRangein classPointOptions- See Also:
-
setPointRange
The width of each point on the x axis. For example in a column chart with one value each day, the pointRange would be 1 day (= 24 * 3600 * 1000 milliseconds). This is normally computed automatically, but this option can be used to override the automatic value.Defaults to: 0
- Specified by:
setPointRangein classPointOptions
-
setPointStart
- Specified by:
setPointStartin classPointOptions- See Also:
-