Class PlotOptionsCandlestick

Constructor Detail

• PlotOptionsCandlestick

  public PlotOptionsCandlestick()

Method Detail

• getChartType

  public ChartType getChartType()

  Specified by:

  getChartType in class OhlcOptions

• getAllowPointSelect

  public Boolean getAllowPointSelect()

  Specified by:

  getAllowPointSelect in class OhlcOptions

  See Also:

  setAllowPointSelect(Boolean)

• setAllowPointSelect

  public void setAllowPointSelect(Boolean allowPointSelect)

  Allow this series' points to be selected by clicking on the markers or bars.

  Defaults to: false

  Specified by:

  setAllowPointSelect in class OhlcOptions

• getAnimation

  public Boolean getAnimation()

  Specified by:

  getAnimation in class OhlcOptions

  See Also:

  setAnimation(Boolean)

• 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 OhlcOptions

• getAnimationLimit

  public Number getAnimationLimit()

  Specified by:

  getAnimationLimit in class OhlcOptions

  See Also:

  setAnimationLimit(Number)

• 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 OhlcOptions

• getClassName

  public String getClassName()

  Specified by:

  getClassName in class OhlcOptions

  See Also:

  setClassName(String)

• setClassName

  public void setClassName(String className)

  A class name to apply to the series' graphical elements.

  Specified by:

  setClassName in class OhlcOptions

• getColorIndex

  public Number getColorIndex()

  Specified by:

  getColorIndex in class OhlcOptions

  See Also:

  setColorIndex(Number)

• 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 OhlcOptions

• getCompareBase

  public Number getCompareBase()

  Specified by:

  getCompareBase in class OhlcOptions

  See Also:

  setCompareBase(Number)

• 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 OhlcOptions

• getCropThreshold

  public Number getCropThreshold()

  Specified by:

  getCropThreshold in class OhlcOptions

  See Also:

  setCropThreshold(Number)

• setCropThreshold

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

  Defaults to: 50

  Specified by:

  setCropThreshold in class OhlcOptions

• getCursor

  public Cursor getCursor()

  Specified by:

  getCursor in class OhlcOptions

  See Also:

  setCursor(Cursor)

• 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 OhlcOptions

• getDataGrouping

  public DataGrouping getDataGrouping()

  Specified by:

  getDataGrouping in class OhlcOptions

  See Also:

  setDataGrouping(DataGrouping)

• setDataGrouping

  public void setDataGrouping(DataGrouping dataGrouping)

  Description copied from class: OhlcOptions

  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.

  Specified by:

  setDataGrouping in class OhlcOptions

• getDescription

  public String getDescription()

  Specified by:

  getDescription in class OhlcOptions

  See Also:

  setDescription(String)

• 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 OhlcOptions

• getEnableMouseTracking

  public Boolean getEnableMouseTracking()

  Specified by:

  getEnableMouseTracking in class OhlcOptions

  See Also:

  setEnableMouseTracking(Boolean)

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

  Defaults to: true

  Specified by:

  setEnableMouseTracking in class OhlcOptions

• getExposeElementToA11y

  public Boolean getExposeElementToA11y()

  Specified by:

  getExposeElementToA11y in class OhlcOptions

  See Also:

  setExposeElementToA11y(Boolean)

• 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 OhlcOptions

• getFindNearestPointBy

  public Dimension getFindNearestPointBy()

  Specified by:

  getFindNearestPointBy in class OhlcOptions

  See Also:

  setFindNearestPointBy(Dimension)

• 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 OhlcOptions

• getGapUnit

  public String getGapUnit()

  Specified by:

  getGapUnit in class OhlcOptions

  See Also:

  setGapUnit(String)

• 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 OhlcOptions

• getGetExtremesFromAll

  public Boolean getGetExtremesFromAll()

  Specified by:

  getGetExtremesFromAll in class OhlcOptions

  See Also:

  setGetExtremesFromAll(Boolean)

• 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 OhlcOptions

• getGroupPadding

  public Number getGroupPadding()

  Specified by:

  getGroupPadding in class OhlcOptions

  See Also:

  setGroupPadding(Number)

• setGroupPadding

  public void setGroupPadding(Number groupPadding)

  Padding between each value groups, in x axis units.

  Defaults to: 0.2

  Specified by:

  setGroupPadding in class OhlcOptions

• getGrouping

  public Boolean getGrouping()

  Specified by:

  getGrouping in class OhlcOptions

  See Also:

  setGrouping(Boolean)

• setGrouping

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

  Defaults to: true

  Specified by:

  setGrouping in class OhlcOptions

• getKeys

  public String[] getKeys()

  Specified by:

  getKeys in class OhlcOptions

  See Also:

  setKeys(String...)

• 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 OhlcOptions

• addKey

  public void addKey(String key)

  Adds key to the keys array

  Specified by:

  addKey in class OhlcOptions

  Parameters:

  key - to add

  See Also:

  setKeys(String...)

• removeKey

  public void removeKey(String key)

  Removes first occurrence of key in keys array

  Specified by:

  removeKey in class OhlcOptions

  Parameters:

  key - to remove

  See Also:

  setKeys(String...)

• getLegendIndex

  public Number getLegendIndex()

  Specified by:

  getLegendIndex in class OhlcOptions

  See Also:

  setLegendIndex(Number)

• setLegendIndex

  public void setLegendIndex(Number legendIndex)

  The sequential index of the series within the legend.

  Defaults to: 0

  Specified by:

  setLegendIndex in class OhlcOptions

• getLinkedTo

  public String getLinkedTo()

  Specified by:

  getLinkedTo in class OhlcOptions

  See Also:

  setLinkedTo(String)

• 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 OhlcOptions

• getMaxPointWidth

  public Number getMaxPointWidth()

  Specified by:

  getMaxPointWidth in class OhlcOptions

  See Also:

  setMaxPointWidth(Number)

• setMaxPointWidth

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

  Defaults to: null

  Specified by:

  setMaxPointWidth in class OhlcOptions

• getMinPointLength

  public Number getMinPointLength()

  Specified by:

  getMinPointLength in class OhlcOptions

  See Also:

  setMinPointLength(Number)

• setMinPointLength

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

  Defaults to: 0

  Specified by:

  setMinPointLength in class OhlcOptions

• getNavigatorOptions

  public PlotOptionsSeries getNavigatorOptions()

  Specified by:

  getNavigatorOptions in class OhlcOptions

  See Also:

  setNavigatorOptions(PlotOptionsSeries)

• 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 OhlcOptions

• isNegativeColor

  public boolean isNegativeColor()

  See Also:

  setNegativeColor(boolean)

• setNegativeColor

  public void setNegativeColor(boolean negativeColor)

  Enable or disable the color for parts of the graph that are bellow getThreshold(). A negative color is applied by setting this option to true combined with the .highcharts-negative class name.

• getPointDescriptionFormatter

  public String getPointDescriptionFormatter()

  Specified by:

  getPointDescriptionFormatter in class OhlcOptions

• setPointDescriptionFormatter

  public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

  Specified by:

  setPointDescriptionFormatter in class OhlcOptions

• getPointInterval

  public Number getPointInterval()

  Specified by:

  getPointInterval in class OhlcOptions

  See Also:

  setPointInterval(Number)

• 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 in milliseconds. For example, if a series contains one value each day, set pointInterval to 24 * 3600 * 1000.

  Since Highstock 2.1, it can be combined with pointIntervalUnit to draw irregular intervals.

  Defaults to: 1

  Specified by:

  setPointInterval in class OhlcOptions

• getPointIntervalUnit

  public IntervalUnit getPointIntervalUnit()

  Specified by:

  getPointIntervalUnit in class OhlcOptions

  See Also:

  setPointIntervalUnit(IntervalUnit)

• 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 OhlcOptions

• getPointPadding

  public Number getPointPadding()

  Specified by:

  getPointPadding in class OhlcOptions

  See Also:

  setPointPadding(Number)

• setPointPadding

  public void setPointPadding(Number pointPadding)

  Padding between each column or bar, in x axis units.

  Defaults to: 0.1

  Specified by:

  setPointPadding in class OhlcOptions

• getPointPlacement

  public PointPlacement getPointPlacement()

  Specified by:

  getPointPlacement in class OhlcOptions

  See Also:

  setPointPlacement(PointPlacement)

• 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.

  Defaults to: null

  Specified by:

  setPointPlacement in class OhlcOptions

• getPointRange

  public Number getPointRange()

  Specified by:

  getPointRange in class OhlcOptions

  See Also:

  setPointRange(Number)

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

  Defaults to: null

  Specified by:

  setPointRange in class OhlcOptions

• getPointStart

  public Number getPointStart()

  Specified by:

  getPointStart in class OhlcOptions

  See Also:

  setPointStart(Number)

• 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. On a datetime X axis, the number will be given as milliseconds since 1970-01-01, for example Date.UTC(2011, 0, 1).

  Defaults to: 0

  Specified by:

  setPointStart in class OhlcOptions

• getPointWidth

  public Number getPointWidth()

  Specified by:

  getPointWidth in class OhlcOptions

  See Also:

  setPointWidth(Number)

• setPointWidth

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

  Defaults to: null

  Specified by:

  setPointWidth in class OhlcOptions

• getSelected

  public Boolean getSelected()

  Specified by:

  getSelected in class OhlcOptions

  See Also:

  setSelected(Boolean)

• setSelected

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

  Defaults to: false

  Specified by:

  setSelected in class OhlcOptions

• getShadow

  public Boolean getShadow()

  Specified by:

  getShadow in class OhlcOptions

  See Also:

  setShadow(Boolean)

• setShadow

  public void setShadow(Boolean shadow)

  Whether to apply a drop shadow to the graph line. Since 1.1.7 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width.

  Defaults to: false

  Specified by:

  setShadow in class OhlcOptions

• getShowCheckbox

  public Boolean getShowCheckbox()

  Specified by:

  getShowCheckbox in class OhlcOptions

  See Also:

  setShowCheckbox(Boolean)

• 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 OhlcOptions

• getShowInLegend

  public Boolean getShowInLegend()

  Specified by:

  getShowInLegend in class OhlcOptions

  See Also:

  setShowInLegend(Boolean)

• 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 OhlcOptions

• getShowInNavigator

  public Boolean getShowInNavigator()

  Specified by:

  getShowInNavigator in class OhlcOptions

  See Also:

  setShowInNavigator(Boolean)

• 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 OhlcOptions

• getSkipKeyboardNavigation

  public Boolean getSkipKeyboardNavigation()

  Specified by:

  getSkipKeyboardNavigation in class OhlcOptions

  See Also:

  setSkipKeyboardNavigation(Boolean)

• 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 OhlcOptions

• getSoftThreshold

  public Boolean getSoftThreshold()

  Specified by:

  getSoftThreshold in class OhlcOptions

  See Also:

  setSoftThreshold(Boolean)

• 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

  Specified by:

  setSoftThreshold in class OhlcOptions

• getStates

  public States getStates()

  Specified by:

  getStates in class OhlcOptions

  See Also:

  setStates(States)

• setStates

  public void setStates(States states)

  A wrapper object for all the series options in specific states.

  Specified by:

  setStates in class OhlcOptions

• getStickyTracking

  public Boolean getStickyTracking()

  Specified by:

  getStickyTracking in class OhlcOptions

  See Also:

  setStickyTracking(Boolean)

• 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 not shared. When stickyTracking 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, candlesticks etc.

  Defaults to: true

  Specified by:

  setStickyTracking in class OhlcOptions

• getThreshold

  public Number getThreshold()

  Specified by:

  getThreshold in class OhlcOptions

  See Also:

  setThreshold(Number)

• setThreshold

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

  Defaults to: 0

  Specified by:

  setThreshold in class OhlcOptions

• getTooltip

  public SeriesTooltip getTooltip()

  Specified by:

  getTooltip in class OhlcOptions

  See Also:

  setTooltip(SeriesTooltip)

• 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 OhlcOptions

• getTurboThreshold

  public Number getTurboThreshold()

  Specified by:

  getTurboThreshold in class OhlcOptions

  See Also:

  setTurboThreshold(Number)

• 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 OhlcOptions

• getVisible

  public Boolean getVisible()

  Specified by:

  getVisible in class OhlcOptions

  See Also:

  setVisible(Boolean)

• setVisible

  public void setVisible(Boolean visible)

  Set the initial visibility of the series.

  Defaults to: true

  Specified by:

  setVisible in class OhlcOptions

• getZoneAxis

  public ZoneAxis getZoneAxis()

  Specified by:

  getZoneAxis in class OhlcOptions

  See Also:

  setZoneAxis(ZoneAxis)

• setZoneAxis

  public void setZoneAxis(ZoneAxis zoneAxis)

  Defines the Axis on which the zones are applied.

  Defaults to: y

  Specified by:

  setZoneAxis in class OhlcOptions

• getZones

  public Zones[] getZones()

  Specified by:

  getZones in class OhlcOptions

  See Also:

  setZones(Zones...)

• 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 OhlcOptions

• addZone

  public void addZone(Zones zone)

  Adds zone to the zones array

  Specified by:

  addZone in class OhlcOptions

  Parameters:

  zone - to add

  See Also:

  setZones(Zones...)

• removeZone

  public void removeZone(Zones zone)

  Removes first occurrence of zone in zones array

  Specified by:

  removeZone in class OhlcOptions

  Parameters:

  zone - to remove

  See Also:

  setZones(Zones...)

• setPointStart

  @Deprecated
  public void setPointStart(Date date)

  Deprecated. as of 4.0. Use setPointStart(Instant)

  Specified by:

  setPointStart in class OhlcOptions

• setPointStart

  public void setPointStart(Instant instant)

  Specified by:

  setPointStart in class OhlcOptions

  See Also:

  setPointStart(Number)