Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: ChartSeries

[12:7] extends: FxObj

Aussom helper class representing a named data series used when building XY chart data for JavaFX charts. Each ChartSeries wraps a JavaFX XYChart.Series and accepts individual data points added via addPoint(). The companion PieSlice class wraps a single labeled value used to build the slice data for a PieChart.

Methods

  • ChartSeries (string Name = "")

    Creates a new XY chart data series with an optional name.

    • @p Name is a string with the series name, or empty for an unnamed series.
  • addPoint (X, Y)

    Adds a data point to the series.

    • @p X is the X value.
    • @p Y is the Y value.
    • @r this object for chaining
  • chartProperty ()

    Returns the read-only property that holds the parent chart hosting this series.

    • @r A ReadOnlyObjectProperty AJO holding the chart.
  • dataProperty ()

    Returns the property that holds the live data ObservableList for this series.

    • @r An ObjectProperty AJO holding the data list.
  • getChart ()

    Returns the parent chart that hosts this series, or null if the series has not been added to a chart.

    • @r An AJO holding the parent chart, or null.
  • getData ()

    Returns the live ObservableList of XYChart.Data points in this series. Mutations are reflected on the chart.

    • @r An ObservableList AJO of XYChart.Data elements.
  • getName ()

    Returns the series name.

    • @r A string with the series name.
  • getNode ()

    Returns the Node used to display this series in the chart legend and as the series visual.

    • @r An AJO holding the series Node, or null.
  • nameProperty ()

    Returns the property that holds the series name.

    • @r A StringProperty AJO holding the name.
  • nodeProperty ()

    Returns the property that holds the series display Node.

    • @r An ObjectProperty AJO holding the Node.
  • setData (object Data)

    Replaces the series data with the supplied ObservableList of XYChart.Data points.

    • @p Data is an AJO holding an ObservableList of XYChart.Data.
    • @r this object for chaining
  • setName (string Name)

    Sets the series name.

    • @p Name is a string with the new series name.
    • @r this object for chaining
  • setNode (object NodeObj)

    Sets the Node used to display this series in the legend.

    • @p NodeObj is a Node wrapper used as the series visual.
    • @r this object for chaining

class: PieSlice

[141:7] extends: FxObj

Represents a single slice in a PieChart.

Methods

  • PieSlice (string Name, double Value)

    Creates a new pie chart data slice with a label and numeric value.

    • @p Name is a string with the slice label.
    • @p Value is a double with the numeric value of the slice.
  • chartProperty ()

    Returns the read-only property that holds the parent PieChart hosting this slice.

    • @r A ReadOnlyObjectProperty AJO holding the chart.
  • getChart ()

    Returns the parent PieChart hosting this slice, or null if the slice has not been added to a chart.

    • @r An AJO holding the parent PieChart, or null.
  • getName ()

    Returns the slice label.

    • @r A string with the slice label.
  • getNode ()

    Returns the Node used to render this slice.

    • @r An AJO holding the slice Node, or null.
  • getPieValue ()

    Returns the numeric value of this slice.

    • @r A double with the slice value.
  • nameProperty ()

    Returns the property that holds the slice label.

    • @r A StringProperty AJO holding the label.
  • nodeProperty ()

    Returns the read-only property that holds the slice display Node.

    • @r A ReadOnlyObjectProperty AJO holding the Node.
  • pieValueProperty ()

    Returns the property that holds the numeric value of this slice.

    • @r A DoubleProperty AJO holding the slice value.
  • setName (string Name)

    Sets the slice label.

    • @p Name is a string with the new label.
    • @r this object for chaining
  • setPieValue (double Value)

    Sets the numeric value of this slice. Changes update the chart on the next layout pass.

    • @p Value is a double with the new value.
    • @r this object for chaining