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

Class OhlcOptions

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.AbstractPlotOptions
com.vaadin.flow.component.charts.model.OhlcOptions
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
PlotOptionsCandlestick, PlotOptionsOhlc
public abstract class OhlcOptions extends AbstractPlotOptions
See Also:

  • Constructor Details

    • OhlcOptions

      public OhlcOptions()

  • Method Details

    • getChartType

      public abstract ChartType getChartType()
      Overrides:
      getChartType in class AbstractPlotOptions

    • getAllowPointSelect

      public abstract Boolean getAllowPointSelect()
      See Also:

    • setAllowPointSelect

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

    • getAnimation

      public abstract Boolean getAnimation()
      See Also:

    • setAnimation

      public abstract void setAnimation(Boolean animation)

      Enable or disable the initial animation when a series is displayed. The animation can also be set as a configuration object. Please note that this option only applies to the initial animation of the series itself.

      Due to poor performance, animation is disabled in old IE browsers for column charts and polar charts.

    • getAnimationLimit

      public abstract Number getAnimationLimit()
      See Also:

    • setAnimationLimit

      public abstract 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.

    • getClassName

      public abstract String getClassName()
      See Also:

    • setClassName

      public abstract void setClassName(String className)
      A class name to apply to the series' graphical elements.

    • getClip

      public abstract Boolean getClip()
      See Also:

    • setClip

      public abstract void setClip(Boolean clip)
      Disable this option to allow series rendering in the whole plotting area.

    • getColorByPoint

      public abstract Boolean getColorByPoint()
      See Also:

    • setColorByPoint

      public abstract void setColorByPoint(Boolean colorByPoint)
      When using automatic point colors pulled from the global colors or series-specific plotOptions.column.colors collections, this option determines whether the chart should receive one color per series or one color per point.

      In styled mode, the colors or series.colors arrays are not supported, and instead this option gives the points individual color class names on the form highcharts-color-{n}.

    • getColorIndex

      public abstract Number getColorIndex()
      See Also:

    • setColorIndex

      public abstract void setColorIndex(Number colorIndex)
      A specific color index to use for the series, so its graphic representations are given the class name highcharts-color-{n}.

    • getColorKey

      public abstract String getColorKey()
      See Also:

    • setColorKey

      public abstract 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'.

    • getColors

      public abstract Color[] getColors()
      See Also:

    • setColors

      public abstract void setColors(Color... colors)
      A series specific or series type specific color set to apply instead of the theme colors.

    • addColor

      public abstract void addColor(Color color)
      Adds color to the colors array
      Parameters:
      color - to add
      See Also:

    • removeColor

      public abstract void removeColor(Color color)
      Removes first occurrence of color in colors array
      Parameters:
      color - to remove
      See Also:

    • getCompareBase

      public abstract Number getCompareBase()
      See Also:

    • setCompareBase

      public abstract void setCompareBase(Number compareBase)
      This option dictates whether to use 0 or 100 as the base of comparison.

    • getCropThreshold

      public abstract Number getCropThreshold()
      See Also:

    • setCropThreshold

      public abstract void setCropThreshold(Number cropThreshold)
      When the series contains less points than the crop threshold, all points are drawn, event 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. .

    • getCursor

      public abstract Cursor getCursor()
      See Also:

    • setCursor

      public abstract 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.

    • getDataGrouping

      public abstract DataGrouping getDataGrouping()
      See Also:

    • setDataGrouping

      public abstract 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. By default data grouping is applied when the points become closer than a certain pixel value, determined by the groupPixelWidth option.
      Parameters:
      dataGrouping -

    • getDescription

      public abstract String getDescription()
      See Also:

    • setDescription

      public abstract void setDescription(String description)
      A description of the series to add to the screen reader information about the series.

    • getEnableMouseTracking

      public abstract Boolean getEnableMouseTracking()
      See Also:

    • setEnableMouseTracking

      public abstract 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. When using shared tooltips (default in stock charts), mouse tracking is not required. For large datasets it improves performance.

    • getExposeElementToA11y

      public abstract Boolean getExposeElementToA11y()
      See Also:

    • setExposeElementToA11y

      public abstract 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.

    • getFindNearestPointBy

      public abstract Dimension getFindNearestPointBy()
      See Also:

    • setFindNearestPointBy

      public abstract 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.

    • getGapUnit

      public abstract String getGapUnit()
      See Also:

    • setGapUnit

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

    • getGetExtremesFromAll

      public abstract Boolean getGetExtremesFromAll()
      See Also:

    • setGetExtremesFromAll

      public abstract 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.

    • getGroupPadding

      public abstract Number getGroupPadding()
      See Also:

    • setGroupPadding

      public abstract void setGroupPadding(Number groupPadding)
      Padding between each value groups, in x axis units.

    • getGrouping

      public abstract Boolean getGrouping()
      See Also:

    • setGrouping

      public abstract void setGrouping(Boolean grouping)
      Whether to group non-stacked columns or to let them render independent of each other. Non-grouped columns will be laid out individually and overlap each other.

    • getKeys

      public abstract String[] getKeys()
      See Also:

    • setKeys

      public abstract 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.

    • addKey

      public abstract void addKey(String key)
      Adds key to the keys array
      Parameters:
      key - to add
      See Also:

    • removeKey

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

    • getLegendIndex

      public abstract Number getLegendIndex()
      See Also:

    • setLegendIndex

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

    • getLineWidth

      public abstract Number getLineWidth()
      See Also:

    • setLineWidth

      public abstract void setLineWidth(Number lineWidth)
      The pixel width of the candlestick line/border.

    • getLinkedTo

      public abstract String getLinkedTo()
      See Also:

    • setLinkedTo

      public abstract 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.

    • getMaxPointWidth

      public abstract Number getMaxPointWidth()
      See Also:

    • setMaxPointWidth

      public abstract void setMaxPointWidth(Number maxPointWidth)
      The maximum allowed pixel width for a column, translated to the height of a bar in a bar chart. This prevents the columns from becoming too wide when there is a small number of points in the chart.

    • getMinPointLength

      public abstract Number getMinPointLength()
      See Also:

    • setMinPointLength

      public abstract void setMinPointLength(Number minPointLength)
      The minimal height for a column or width for a bar. By default, 0 values are not shown. To visualize a 0 (or close to zero) point, set the minimal point length to a pixel value like 3. In stacked column charts, minPointLength might not be respected for tightly packed values.

    • getNavigatorOptions

      public abstract PlotOptionsSeries getNavigatorOptions()
      See Also:

    • setNavigatorOptions

      public abstract void setNavigatorOptions(PlotOptionsSeries navigatorOptions)
      Options for the corresponding navigator series if showInNavigator is true for this series.

    • getOpacity

      public abstract Number getOpacity()
      See Also:

    • setOpacity

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

    • getPointDescriptionFormatter

      public abstract String getPointDescriptionFormatter()

    • setPointDescriptionFormatter

      public abstract void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

    • getPointInterval

      public abstract Number getPointInterval()
      See Also:

    • setPointInterval

      public abstract void setPointInterval(Number pointInterval)

      If no x values are given for the points in a series, pointInterval defines the interval of the x values in milliseconds. For example, if a series contains one value each day, set pointInterval to 24 * 3600 * 1000.

      It can be combined with pointIntervalUnit to draw irregular intervals.

    • getPointIntervalUnit

      public abstract IntervalUnit getPointIntervalUnit()
      See Also:

    • setPointIntervalUnit

      public abstract 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.

    • getPointPadding

      public abstract Number getPointPadding()
      See Also:

    • setPointPadding

      public abstract void setPointPadding(Number pointPadding)
      Padding between each column or bar, in x axis units.

    • getPointPlacement

      public abstract PointPlacement getPointPlacement()
      See Also:

    • setPointPlacement

      public abstract 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.

      Note that pointPlacement needs a pointRange to work. For column series this is computed, but for line-type series it needs to be set.

    • getPointRange

      public abstract Number getPointRange()
      See Also:

    • setPointRange

      public abstract 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. In a series on a categorized axis the pointRange is 1 by default.

    • getPointStart

      public abstract Number getPointStart()
      See Also:

    • setPointStart

      public abstract void setPointStart(Number pointStart)
      If no x values are given for the points in a series, pointStart defines on what value to start. On a datetime X axis, the number will be given as milliseconds since 1970-01-01, for example Date.UTC(2011, 0, 1).

    • getPointWidth

      public abstract Number getPointWidth()
      See Also:

    • setPointWidth

      public abstract void setPointWidth(Number pointWidth)
      A pixel value specifying a fixed width for each column or bar. When null, the width is calculated from the pointPadding and groupPadding.

    • getSelected

      public abstract Boolean getSelected()
      See Also:

    • setSelected

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

    • getShadow

      public abstract Boolean getShadow()
      See Also:

    • setShadow

      public abstract void setShadow(Boolean shadow)
      Whether to apply a drop shadow to the graph line.

    • getShowCheckbox

      public abstract Boolean getShowCheckbox()
      See Also:

    • setShowCheckbox

      public abstract 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.

    • getShowInLegend

      public abstract Boolean getShowInLegend()
      See Also:

    • setShowInLegend

      public abstract 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.

    • getShowInNavigator

      public abstract Boolean getShowInNavigator()
      See Also:

    • setShowInNavigator

      public abstract void setShowInNavigator(Boolean showInNavigator)
      Whether or not to show the series in the navigator.

    • getSkipKeyboardNavigation

      public abstract Boolean getSkipKeyboardNavigation()
      See Also:

    • setSkipKeyboardNavigation

      public abstract void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)
      Whether or not to skip past the points in this series for keyboard navigation.

    • getSoftThreshold

      public abstract Boolean getSoftThreshold()
      See Also:

    • setSoftThreshold

      public abstract void setSoftThreshold(Boolean softThreshold)

      When this is true, the series will not cause the Y axis to cross the zero plane 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.

    • getStates

      public abstract States getStates()
      See Also:

    • setStates

      public abstract void setStates(States states)
      A wrapper object for all the series options in specific states.

    • getStickyTracking

      public abstract Boolean getStickyTracking()
      See Also:

    • setStickyTracking

      public abstract 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 not shared. When stickyTracking is false, the tooltip will be hidden when moving the mouse between series.

    • getThreshold

      public abstract Number getThreshold()
      See Also:

    • setThreshold

      public abstract void setThreshold(Number threshold)
      The threshold, also called zero level or base level. For line type series this is only used in conjunction with negativeColor.

    • getTooltip

      public abstract SeriesTooltip getTooltip()
      See Also:

    • setTooltip

      public abstract void setTooltip(SeriesTooltip tooltip)
      A configuration object for the tooltip rendering of each single series.

    • getTurboThreshold

      public abstract Number getTurboThreshold()
      See Also:

    • setTurboThreshold

      public abstract 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.

    • getUpColor

      public abstract Color getUpColor()
      See Also:

    • setUpColor

      public abstract void setUpColor(Color upColor)
      Line color for up points.

    • getVisible

      public abstract Boolean getVisible()
      See Also:

    • setVisible

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

    • getZoneAxis

      public abstract ZoneAxis getZoneAxis()
      See Also:

    • setZoneAxis

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

    • getZones

      public abstract Zones[] getZones()
      See Also:

    • setZones

      public abstract 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.

    • addZone

      public abstract void addZone(Zones zone)
      Adds zone to the zones array
      Parameters:
      zone - to add
      See Also:

    • removeZone

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

    • setPointStart

      @Deprecated public abstract void setPointStart(Date date)
      Deprecated.
      as of 4.0. Use setPointStart(Instant)

    • setPointStart

      public abstract void setPointStart(Instant instant)
      See Also: