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

Class PlotOptionsPie

    • Constructor Detail

      • PlotOptionsPie

        public PlotOptionsPie()

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

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

      • setCenter

        public void setCenter(String[] center)

        The center of the pie chart relative to the plot area. Can be percentages or pixel values. The default behaviour (as of 3.0) is to center the pie so that all slices and data labels are within the plot area. As a consequence, the pie may actually jump around in a chart with dynamic values, as the data labels move. In that case, the center should be explicitly set, for example to ["50%", "50%"].

        Defaults to: [null, null]

      • setClassName

        public void setClassName(String className)

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

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

      • setDataLabels

        public void setDataLabels(DataLabels dataLabels)

      • setDepth

        public void setDepth(Number depth)

        The thickness of a 3D pie. Requires highcharts-3d.js

        Defaults to: 0

      • 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

      • setEndAngle

        public void setEndAngle(Number endAngle)

        The end angle of the pie in degrees where 0 is top and 90 is right. Defaults to startAngle plus 360.

        Defaults to: null

      • 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

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

      • 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

      • setIgnoreHiddenPoint

        public void setIgnoreHiddenPoint(Boolean ignoreHiddenPoint)

        Equivalent to chart.ignoreHiddenSeries, this option tells whether the series shall be redrawn as if the hidden point were null.

        The default value changed from false to true with Highcharts 3.0.

        Defaults to: true

      • setInnerSize

        public void setInnerSize(String innerSize)

        The size of the inner diameter for the pie. A size greater than 0 renders a donut chart. Can be a percentage or pixel value. Percentages are relative to the pie size. Pixel values are given as integers.

        Note: in Highcharts < 4.1.2, the percentage was relative to the plot area, not the pie size.

        Defaults to: 0

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

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

      • setMinSize

        public void setMinSize(Number minSize)

        The minimum size for a pie in response to auto margins. The pie will try to shrink to make room for data labels in side the plot area, but only to this size.

        Defaults to: 80

      • 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

      • setShowInLegend

        public void setShowInLegend(Boolean showInLegend)

        Whether to display this particular series or series type in the legend. Since 2.1, pies are not shown in the legend by default.

        Defaults to: false

      • setSize

        public void setSize(String size)

        The diameter of the pie relative to the plot area. Can be a percentage or pixel value. Pixel values are given as integers. The default behaviour (as of 3.0) is to scale to the plot area and give room for data labels within the plot area. As a consequence, the size of the pie may vary when points are updated and data labels more around. In that case it is best to set a fixed value, for example "75%".

        Defaults to:

      • setSkipKeyboardNavigation

        public void setSkipKeyboardNavigation(Boolean skipKeyboardNavigation)

        If set to True, the accessibility module will skip past the points in this series for keyboard navigation.

      • setSlicedOffset

        public void setSlicedOffset(Number slicedOffset)

        If a point is sliced, moved out from the center, how many pixels should it be moved?.

        Defaults to: 10

      • setStartAngle

        public void setStartAngle(Number startAngle)

        The start angle of the pie slices in degrees where 0 is top and 90 right.

        Defaults to: 0

      • 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: false

      • 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

      • setZoneAxis

        public void setZoneAxis(ZoneAxis zoneAxis)

        Defines the Axis on which the zones are applied.

        Defaults to: y

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

      • addZone

        public void addZone(Zones zone)

        Adds zone to the zones array

        Parameters:

        zone - to add

        See Also:

        setZones(Zones...)

      • removeZone

        public void removeZone(Zones zone)

        Removes first occurrence of zone in zones array

        Parameters:

        zone - to remove

        See Also:

        setZones(Zones...)

      • getCenter

        public String[] getCenter()