Package com.vaadin.flow.component.charts.model

Class PlotOptionsAreaspline

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.AbstractPlotOptions
com.vaadin.flow.component.charts.model.AreaOptions
com.vaadin.flow.component.charts.model.PlotOptionsAreaspline
All Implemented Interfaces:
Serializable
public class PlotOptionsAreaspline extends AreaOptions
See Also:

  • Constructor Details

    • PlotOptionsAreaspline

      public PlotOptionsAreaspline()

  • Method Details

    • getChartType

      public ChartType getChartType()
      Specified by:
      getChartType in class AreaOptions

    • getAllowPointSelect

      public Boolean getAllowPointSelect()
      Specified by:
      getAllowPointSelect in class AreaOptions
      See Also:

    • setAllowPointSelect

      public void setAllowPointSelect(Boolean allowPointSelect)
      Allow this series' points to be selected by clicking on the markers, bars or pie slices.

      Defaults to: false

      Specified by:
      setAllowPointSelect in class AreaOptions

    • getAnimation

      public Boolean getAnimation()
      Specified by:
      getAnimation in class AreaOptions
      See Also:

    • setAnimation

      public void setAnimation(Boolean animation)
      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, see ChartModel.setAnimation(Boolean)
      Specified by:
      setAnimation in class AreaOptions

    • getAnimationLimit

      public Number getAnimationLimit()
      Specified by:
      getAnimationLimit in class AreaOptions
      See Also:

    • setAnimationLimit

      public void setAnimationLimit(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. 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, set animationLimit to Infinity.
      Specified by:
      setAnimationLimit in class AreaOptions

    • getClassName

      public String getClassName()
      Specified by:
      getClassName in class AreaOptions
      See Also:

    • setClassName

      public void setClassName(String className)
      A class name to apply to the series' graphical elements.
      Specified by:
      setClassName in class AreaOptions

    • getClip

      public Boolean getClip()
      Specified by:
      getClip in class AreaOptions
      See Also:

    • setClip

      public void setClip(Boolean clip)
      Disable this option to allow series rendering in the whole plotting area. Note that clipping should be always enabled when chart.zoomType is set

      Defaults to true.

      Specified by:
      setClip in class AreaOptions

    • getColor

      public Color getColor()
      See Also:

    • setColor

      public void setColor(Color color)

      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.colors array.

      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}-series or .highcharts-series-{n} class, or individual classes given by the className option.

    • getColorIndex

      public Number getColorIndex()
      Specified by:
      getColorIndex in class AreaOptions
      See Also:

    • setColorIndex

      public void setColorIndex(Number colorIndex)
      Styled mode only. A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.
      Specified by:
      setColorIndex in class AreaOptions

    • getColorKey

      public String getColorKey()
      Specified by:
      getColorKey in class AreaOptions
      See Also:

    • setColorKey

      public void setColorKey(String colorKey)
      Determines what data value should be used to calculate point color if colorAxis is 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:
      setColorKey in class AreaOptions

    • getConnectEnds

      public Boolean getConnectEnds()
      See Also:

    • setConnectEnds

      public void setConnectEnds(Boolean connectEnds)
      Polar charts only. Whether to connect the ends of a line series plot across the extremes.

      Defaults to: true

    • getConnectNulls

      public Boolean getConnectNulls()
      Specified by:
      getConnectNulls in class AreaOptions
      See Also:

    • setConnectNulls

      public void setConnectNulls(Boolean connectNulls)
      Whether to connect a graph line across null points.

      Defaults to: false

      Specified by:
      setConnectNulls in class AreaOptions

    • getCrisp

      public Boolean getCrisp()
      Specified by:
      getCrisp in class AreaOptions
      See Also:

    • setCrisp

      public void setCrisp(Boolean crisp)
      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, setting crisp to false may look better, even though each column is rendered blurry.

      Defaults to true.

      Specified by:
      setCrisp in class AreaOptions

    • getCropThreshold

      public Number getCropThreshold()
      Specified by:
      getCropThreshold in class AreaOptions
      See Also:

    • setCropThreshold

      public void setCropThreshold(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. 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:
      setCropThreshold in class AreaOptions

    • getCursor

      public Cursor getCursor()
      Specified by:
      getCursor in class AreaOptions
      See Also:

    • setCursor

      public void setCursor(Cursor cursor)
      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:
      setCursor in class AreaOptions

    • getDashStyle

      public DashStyle getDashStyle()
      Specified by:
      getDashStyle in class AreaOptions
      See Also:

    • setDashStyle

      public void setDashStyle(DashStyle dashStyle)
      A name for the dash style to use for the graph. Applies only to series type having a graph, like line, spline, area and scatter in case it has a lineWidth. The value for the dashStyle include:
      • Solid
      • ShortDash
      • ShortDot
      • ShortDashDot
      • ShortDashDotDot
      • Dot
      • Dash
      • LongDash
      • DashDot
      • LongDashDot
      • LongDashDotDot

      Defaults to: Solid

      Specified by:
      setDashStyle in class AreaOptions

    • getDataLabels

      public DataLabels getDataLabels()
      See Also:

    • setDataLabels

      public void setDataLabels(DataLabels dataLabels)

      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-box and .highcharts-data-label class names (see example).

    • getDescription

      public String getDescription()
      Specified by:
      getDescription in class AreaOptions
      See Also:

    • setDescription

      public void setDescription(String description)

      Requires Accessibility module

      A description of the series to add to the screen reader information about the series.

      Defaults to: undefined

      Specified by:
      setDescription in class AreaOptions

    • getEnableMouseTracking

      public Boolean getEnableMouseTracking()
      Specified by:
      getEnableMouseTracking in class AreaOptions
      See Also:

    • setEnableMouseTracking

      public void setEnableMouseTracking(Boolean enableMouseTracking)
      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:
      setEnableMouseTracking in class AreaOptions

    • getExposeElementToA11y

      public Boolean getExposeElementToA11y()
      Specified by:
      getExposeElementToA11y in class AreaOptions
      See Also:

    • setExposeElementToA11y

      public void setExposeElementToA11y(Boolean exposeElementToA11y)

      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:
      setExposeElementToA11y in class AreaOptions

    • getFillColor

      public Color getFillColor()
      Specified by:
      getFillColor in class AreaOptions
      See Also:

    • setFillColor

      public void setFillColor(Color fillColor)
      Fill color or gradient for the area. When null, the series' color is used with the series' fillOpacity.
      Specified by:
      setFillColor in class AreaOptions

    • getFillOpacity

      public Number getFillOpacity()
      Specified by:
      getFillOpacity in class AreaOptions
      See Also:

    • setFillOpacity

      public void setFillOpacity(Number fillOpacity)
      Fill opacity for the area. When you set an explicit fillColor, the fillOpacity is not applied. Instead, you should define the opacity in the fillColor with an rgba color definition. The fillOpacity setting, also the default setting, overrides the alpha component of the color setting.

      Defaults to: 0.75

      Specified by:
      setFillOpacity in class AreaOptions

    • getFindNearestPointBy

      public Dimension getFindNearestPointBy()
      Specified by:
      getFindNearestPointBy in class AreaOptions
      See Also:

    • setFindNearestPointBy

      public void setFindNearestPointBy(Dimension findNearestPointBy)

      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:
      setFindNearestPointBy in class AreaOptions

    • getGetExtremesFromAll

      public Boolean getGetExtremesFromAll()
      Specified by:
      getGetExtremesFromAll in class AreaOptions
      See Also:

    • setGetExtremesFromAll

      public void setGetExtremesFromAll(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. By default, the Y axis adjusts to the min and max of the visible data. Cartesian series only.

      Defaults to: false

      Specified by:
      setGetExtremesFromAll in class AreaOptions

    • getKeys

      public String[] getKeys()
      Specified by:
      getKeys in class AreaOptions
      See Also:

    • setKeys

      public void setKeys(String... keys)
      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:
      setKeys in class AreaOptions

    • addKey

      public void addKey(String key)
      Adds key to the keys array
      Specified by:
      addKey in class AreaOptions
      Parameters:
      key - to add
      See Also:

    • removeKey

      public void removeKey(String key)
      Removes first occurrence of key in keys array
      Specified by:
      removeKey in class AreaOptions
      Parameters:
      key - to remove
      See Also:

    • getLineColor

      public Color getLineColor()
      Specified by:
      getLineColor in class AreaOptions
      See Also:

    • setLineColor

      public void setLineColor(Color lineColor)
      A separate color for the graph line. By default the line takes the color of the series, but the lineColor setting allows setting a separate color for the line without altering the fillColor.
      Specified by:
      setLineColor in class AreaOptions

    • getLineWidth

      public Number getLineWidth()
      Specified by:
      getLineWidth in class AreaOptions
      See Also:

    • setLineWidth

      public void setLineWidth(Number lineWidth)
      Pixel with of the graph line.

      Defaults to: 2

      Specified by:
      setLineWidth in class AreaOptions

    • getLinecap

      public String getLinecap()
      Specified by:
      getLinecap in class AreaOptions
      See Also:

    • setLinecap

      public void setLinecap(String linecap)
      The line cap used for line ends and line joins on the graph.

      Defaults to: round

      Specified by:
      setLinecap in class AreaOptions

    • getLinkedTo

      public String getLinkedTo()
      Specified by:
      getLinkedTo in class AreaOptions
      See Also:

    • setLinkedTo

      public void setLinkedTo(String linkedTo)
      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:
      setLinkedTo in class AreaOptions

    • getMarker

      public Marker getMarker()
      See Also:

    • setMarker

      public void setMarker(Marker marker)

      Options for the point markers of line-like series. Properties like fillColor, lineColor and lineWidth define 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-hover and .highcharts-point-select class names.

    • getNegativeColor

      public Color getNegativeColor()
      Specified by:
      getNegativeColor in class AreaOptions
      See Also:

    • setNegativeColor

      public void setNegativeColor(Color negativeColor)
      The color for the parts of the graph or points that are below the threshold.

      Defaults to: null

      Specified by:
      setNegativeColor in class AreaOptions

    • getNegativeFillColor

      public Color getNegativeFillColor()
      Specified by:
      getNegativeFillColor in class AreaOptions
      See Also:

    • setNegativeFillColor

      public void setNegativeFillColor(Color negativeFillColor)
      A separate color for the negative part of the area.
      Specified by:
      setNegativeFillColor in class AreaOptions

    • getOpacity

      public Number getOpacity()
      Specified by:
      getOpacity in class AreaOptions
      See Also:

    • setOpacity

      public void setOpacity(Number opacity)
      Opacity of a series parts: line, fill (e.g. area) and dataLabels.

      Defaults to 1.

      Specified by:
      setOpacity in class AreaOptions

    • getPointDescriptionFormatter

      public String getPointDescriptionFormatter()
      Specified by:
      getPointDescriptionFormatter in class AreaOptions

    • setPointDescriptionFormatter

      public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)
      Specified by:
      setPointDescriptionFormatter in class AreaOptions

    • getPointInterval

      public Number getPointInterval()
      Specified by:
      getPointInterval in class AreaOptions
      See Also:

    • setPointInterval

      public void setPointInterval(Number pointInterval)

      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 pointIntervalUnit to draw irregular intervals.

      Defaults to: 1

      Specified by:
      setPointInterval in class AreaOptions

    • getPointIntervalUnit

      public IntervalUnit getPointIntervalUnit()
      Specified by:
      getPointIntervalUnit in class AreaOptions
      See Also:

    • setPointIntervalUnit

      public void setPointIntervalUnit(IntervalUnit pointIntervalUnit)
      On datetime series, this allows for setting the pointInterval to irregular time units, day, month and year. 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 with pointInterval to draw weeks, quarters, 6 months, 10 years etc.
      Specified by:
      setPointIntervalUnit in class AreaOptions

    • getPointPlacement

      public PointPlacement getPointPlacement()
      Specified by:
      getPointPlacement in class AreaOptions
      See Also:

    • setPointPlacement

      public void setPointPlacement(PointPlacement pointPlacement)

      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 null in cartesian charts, "between" in polar charts.

      Specified by:
      setPointPlacement in class AreaOptions

    • getPointStart

      public Number getPointStart()
      Specified by:
      getPointStart in class AreaOptions
      See Also:

    • setPointStart

      public void setPointStart(Number pointStart)
      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:
      setPointStart in class AreaOptions

    • getSelected

      public Boolean getSelected()
      Specified by:
      getSelected in class AreaOptions
      See Also:

    • setSelected

      public void setSelected(Boolean selected)
      Whether to select the series initially. If showCheckbox is true, the checkbox next to the series name will be checked for a selected series.

      Defaults to: false

      Specified by:
      setSelected in class AreaOptions

    • getShadow

      public Boolean getShadow()
      Specified by:
      getShadow in class AreaOptions
      See Also:

    • setShadow

      public void setShadow(Boolean shadow)
      Whether to apply a drop shadow to the graph line. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

      Defaults to: false

      Specified by:
      setShadow in class AreaOptions

    • getShowCheckbox

      public Boolean getShowCheckbox()
      Specified by:
      getShowCheckbox in class AreaOptions
      See Also:

    • setShowCheckbox

      public void setShowCheckbox(Boolean showCheckbox)
      If true, a checkbox is displayed next to the legend item to allow selecting the series. The state of the checkbox is determined by the selected option.

      Defaults to: false

      Specified by:
      setShowCheckbox in class AreaOptions

    • getShowInLegend

      public Boolean getShowInLegend()
      Specified by:
      getShowInLegend in class AreaOptions
      See Also:

    • setShowInLegend

      public void setShowInLegend(Boolean showInLegend)
      Whether to display this particular series or series type in the legend. The default value is true for standalone series, false for linked series.

      Defaults to: true

      Specified by:
      setShowInLegend in class AreaOptions

    • getSkipKeyboardNavigation

      public Boolean getSkipKeyboardNavigation()
      Specified by:
      getSkipKeyboardNavigation in class AreaOptions
      See Also:

    • setSkipKeyboardNavigation

      public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
      If set to True, the accessibility module will skip past the points in this series for keyboard navigation.
      Specified by:
      setSkipKeyboardNavigation in class AreaOptions

    • getSoftThreshold

      public Boolean getSoftThreshold()
      See Also:

    • setSoftThreshold

      public void setSoftThreshold(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.

      For example, if softThreshold is false, a series of 0, 1, 2, 3 will make the Y axis show negative values according to the minPadding option. If softThreshold is true, the Y axis starts at 0.

      Defaults to: false

    • getStacking

      public Stacking getStacking()
      Specified by:
      getStacking in class AreaOptions
      See Also:

    • setStacking

      public void setStacking(Stacking stacking)
      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:
      setStacking in class AreaOptions

    • getStates

      public States getStates()
      Specified by:
      getStates in class AreaOptions
      See Also:

    • setStates

      public void setStates(States states)
      A wrapper object for all the series options in specific states.
      Specified by:
      setStates in class AreaOptions

    • getStickyTracking

      public Boolean getStickyTracking()
      Specified by:
      getStickyTracking in class AreaOptions
      See Also:

    • setStickyTracking

      public void setStickyTracking(Boolean stickyTracking)
      Sticky tracking of mouse events. When true, the mouseOut event on a series isn't triggered until the mouse moves over another series, or out of the plot area. When false, the mouseOut event on a series is triggered when the mouse leaves the area around the series' graph or markers. This also implies the tooltip. When stickyTracking is false and tooltip.shared is 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:
      setStickyTracking in class AreaOptions

    • getThreshold

      public Number getThreshold()
      See Also:

    • setThreshold

      public void setThreshold(Number threshold)
      The Y axis value to serve as the base for the area, for distinguishing between values above and below a threshold. If null, the area behaves like a line series with fill between the graph and the Y axis minimum.

      Defaults to: 0

    • getTooltip

      public SeriesTooltip getTooltip()
      Specified by:
      getTooltip in class AreaOptions
      See Also:

    • setTooltip

      public void setTooltip(SeriesTooltip tooltip)
      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:
      setTooltip in class AreaOptions

    • getTrackByArea

      public Boolean getTrackByArea()
      Specified by:
      getTrackByArea in class AreaOptions
      See Also:

    • setTrackByArea

      public void setTrackByArea(Boolean trackByArea)
      Whether the whole area or just the line should respond to mouseover tooltips and other mouse or touch events.

      Defaults to: false

      Specified by:
      setTrackByArea in class AreaOptions

    • getTurboThreshold

      public Number getTurboThreshold()
      Specified by:
      getTurboThreshold in class AreaOptions
      See Also:

    • setTurboThreshold

      public void setTurboThreshold(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. 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 to 0 disable.

      Defaults to: 1000

      Specified by:
      setTurboThreshold in class AreaOptions

    • getVisible

      public Boolean getVisible()
      Specified by:
      getVisible in class AreaOptions
      See Also:

    • setVisible

      public void setVisible(Boolean visible)
      Set the initial visibility of the series.

      Defaults to: true

      Specified by:
      setVisible in class AreaOptions

    • getZoneAxis

      public ZoneAxis getZoneAxis()
      Specified by:
      getZoneAxis in class AreaOptions
      See Also:

    • setZoneAxis

      public void setZoneAxis(ZoneAxis zoneAxis)
      Defines the Axis on which the zones are applied.

      Defaults to: y

      Specified by:
      setZoneAxis in class AreaOptions

    • getZones

      public Zones[] getZones()
      Specified by:
      getZones in class AreaOptions
      See Also:

    • setZones

      public void setZones(Zones... zones)

      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 zoneAxis option.

      In styled mode, the color zones are styled with the .highcharts-zone-{n} class, or custom classed from the className option (view live demo).

      Specified by:
      setZones in class AreaOptions

    • addZone

      public void addZone(Zones zone)
      Adds zone to the zones array
      Specified by:
      addZone in class AreaOptions
      Parameters:
      zone - to add
      See Also:

    • removeZone

      public void removeZone(Zones zone)
      Removes first occurrence of zone in zones array
      Specified by:
      removeZone in class AreaOptions
      Parameters:
      zone - to remove
      See Also:

    • getCompare

      public Compare getCompare()
      Specified by:
      getCompare in class AreaOptions
      See Also:

    • setCompare

      public void setCompare(Compare compare)
      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 whether compare is 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:
      setCompare in class AreaOptions

    • getCompareBase

      public Number getCompareBase()
      Specified by:
      getCompareBase in class AreaOptions
      See Also:

    • setCompareBase

      public void setCompareBase(Number compareBase)
      When compare is percent, this option dictates whether to use 0 or 100 as the base of comparison.

      Defaults to: 0

      Specified by:
      setCompareBase in class AreaOptions

    • getDataGrouping

      public DataGrouping getDataGrouping()
      Specified by:
      getDataGrouping in class AreaOptions
      See Also:

    • setDataGrouping

      public void setDataGrouping(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. Highstock by default applies data grouping when the points become closer than a certain pixel value, determined by the groupPixelWidth option.

      If data grouping is applied, the grouping information of grouped points can be read from the Point.dataGroup.

      Specified by:
      setDataGrouping in class AreaOptions

    • getGapSize

      public Number getGapSize()
      Specified by:
      getGapSize in class AreaOptions
      See Also:

    • setGapSize

      public void setGapSize(Number gapSize)

      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

      Specified by:
      setGapSize in class AreaOptions

    • getGapUnit

      public String getGapUnit()
      Specified by:
      getGapUnit in class AreaOptions
      See Also:

    • setGapUnit

      public void setGapUnit(String gapUnit)
      Together with gapSize, this option defines where to draw gaps in the graph.

      Defaults to: relative

      Specified by:
      setGapUnit in class AreaOptions

    • getLegendIndex

      public Number getLegendIndex()
      Specified by:
      getLegendIndex in class AreaOptions
      See Also:

    • setLegendIndex

      public void setLegendIndex(Number legendIndex)
      The sequential index of the series within the legend.

      Defaults to: 0

      Specified by:
      setLegendIndex in class AreaOptions

    • getNavigatorOptions

      public PlotOptionsSeries getNavigatorOptions()
      Specified by:
      getNavigatorOptions in class AreaOptions
      See Also:

    • setNavigatorOptions

      public void setNavigatorOptions(PlotOptionsSeries navigatorOptions)

      Options for the corresponding navigator series if showInNavigator is true for this series. Available options are the same as any series, documented at plotOptions and series.

      These options are merged with options in navigator.series, and will take precedence if the same option is defined both places.

      Defaults to: undefined

      Specified by:
      setNavigatorOptions in class AreaOptions

    • getPointRange

      public Number getPointRange()
      Specified by:
      getPointRange in class AreaOptions
      See Also:

    • setPointRange

      public void setPointRange(Number pointRange)
      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:
      setPointRange in class AreaOptions

    • getShowInNavigator

      public Boolean getShowInNavigator()
      Specified by:
      getShowInNavigator in class AreaOptions
      See Also:

    • setShowInNavigator

      public void setShowInNavigator(Boolean showInNavigator)
      Whether or not to show the series in the navigator. Takes precedence over navigator.baseSeries if defined.

      Defaults to: undefined

      Specified by:
      setShowInNavigator in class AreaOptions

    • setPointStart

      @Deprecated public void setPointStart(Date date)
      Deprecated.
      as of 4.0. Use setPointStart(Instant)
      Specified by:
      setPointStart in class AreaOptions

    • setPointStart

      public void setPointStart(Instant instant)
      Specified by:
      setPointStart in class AreaOptions
      See Also: