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

Class PlotOptionsTimeline

    • Constructor Detail

      • PlotOptionsTimeline

        public PlotOptionsTimeline()

    • Method Detail

      • 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

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

      • setClassName

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

      • setClip

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

        Defaults to true.

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

      • setColorByPoint

        public void setColorByPoint​(Boolean colorByPoint)
        Defaults to true

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

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

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

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

      • 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

      • 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

      • 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

      • setIgnoreHiddenPoint

        public void setIgnoreHiddenPoint​(Boolean ignoreHiddenPoint)
        Defaults to true

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

      • addKey

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

      • removeKey

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

      • setLegendType

        public void setLegendType​(String legendType)
        Defaults to point.

      • setLinecap

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

        Defaults to: round

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

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

      • setOpacity

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

        Defaults to 1.

      • getPointDescriptionFormatter

        public String getPointDescriptionFormatter()

      • setPointDescriptionFormatter

        public void setPointDescriptionFormatter​(String _fn_pointDescriptionFormatter)

      • 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

      • 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

      • 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

      • 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

      • setSkipKeyboardNavigation

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

      • setStates

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

      • 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

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

      • setVisible

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

        Defaults to: true

      • 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

      • setGapUnit

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

        Defaults to: relative

      • setLegendIndex

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

        Defaults to: 0

      • 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

      • 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

      • 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