Package io.jmix.charts.model.chart

Interface CoordinateChartModel<T extends CoordinateChartModel>

All Superinterfaces:
ChartModel<T>, HasColors<T>, HasStartEffect<T>
All Known Subinterfaces:
CoordinateChart<T>, GanttChart, GanttChartModel<T>, RadarChart, RadarChartModel<T>, RectangularChart<T>, RectangularChartModel<T>, SerialChart, SeriesBasedChart<T>, SeriesBasedChartModel<T>, XYChart, XYChartModel<T>
All Known Implementing Classes:
AbstractSerialChart, CoordinateChartImpl, CoordinateChartModelImpl, GanttChartImpl, GanttChartModelImpl, RadarChartImpl, RadarChartModelImpl, RectangularChartImpl, RectangularChartModelImpl, SerialChartImpl, SerialChartModelImpl, SeriesBasedChartImpl, StockPanel, XYChartImpl, XYChartModelImpl
public interface CoordinateChartModel<T extends CoordinateChartModel> extends ChartModel<T>, HasStartEffect<T>, HasColors<T>

  • Method Details

    • getGraphs

      List<Graph> getGraphs()
      Returns:
      list of graphs

    • setGraphs

      @StudioElementsGroup(caption="Graphs", xmlElement="graphs") T setGraphs(List<Graph> graphs)
      Sets the list of graphs belonging to this chart.
      Parameters:
      graphs - list of graphs
      Returns:
      coordinate chart model

    • addGraphs

      T addGraphs(Graph... graphs)
      Adds graphs to the chart.
      Parameters:
      graphs - graphs
      Returns:
      coordinate chart model

    • getValueAxes

      List<ValueAxis> getValueAxes()
      Returns:
      list of ValueAxis

    • setValueAxes

      @StudioElementsGroup(caption="Value Axes", xmlElement="valueAxes", elementXmlName="axis") T setValueAxes(List<ValueAxis> valueAxes)
      Sets list of ValueAxis. Chart creates one value axis automatically.
      Parameters:
      valueAxes - list of ValueAxis
      Returns:
      coordinate chart model

    • addValueAxes

      T addValueAxes(ValueAxis... valueAxes)
      Adds ValueAxes.
      Parameters:
      valueAxes - the value axes
      Returns:
      coordinate chart model

    • getGuides

      List<Guide> getGuides()
      Returns:
      list of guides

    • setGuides

      @StudioElementsGroup(caption="Guides", xmlElement="guides") T setGuides(List<Guide> guides)
      Sets list of guides. Instead of adding guides to the axes, you can push all of them to this list. In case guide has category or date defined, it will automatically will be assigned to the category axis. Otherwise to first value axis, unless you specify a different valueAxis for the guide.
      Parameters:
      guides - list of guides
      Returns:
      coordinate chart model

    • addGuides

      T addGuides(Guide... guides)
      Adds guides.
      Parameters:
      guides - the guides
      Returns:
      coordinate chart model

    • getGridAboveGraphs

      Boolean getGridAboveGraphs()
      Returns:
      true if grid should be drawn above the graphs or below

    • setGridAboveGraphs

      @StudioProperty(defaultValue="false") T setGridAboveGraphs(Boolean gridAboveGraphs)
      Set grid above graphs to true if grid should be drawn above the graphs or below. Will not work properly with 3D charts. If not set the default value is false.
      Parameters:
      gridAboveGraphs - grid above graphs option
      Returns:
      coordinate chart model

    • getSequencedAnimation

      Boolean getSequencedAnimation()
      Returns:
      true if the animation should be sequenced, false if all objects should appear at once

    • setSequencedAnimation

      @StudioProperty(defaultValue="true") T setSequencedAnimation(Boolean sequencedAnimation)
      Specifies whether the animation should be sequenced or all objects should appear at once. If not set the default value is true.
      Parameters:
      sequencedAnimation - sequenced animation option
      Returns:
      coordinate chart model

    • getStartAlpha

      Double getStartAlpha()
      Returns:
      initial opacity of the column/line

    • setStartAlpha

      @StudioProperty(defaultValue="1") @Max(1L) @Min(0L) T setStartAlpha(Double startAlpha)
      Sets the initial opacity of the column/line. If you set startDuration to a value higher than 0, the columns/lines will fade in from startAlpha. Value range is 0 - 1. If not set the default value is 1.
      Parameters:
      startAlpha - - the start alpha
      Returns:
      coordinate chart model

    • getUrlTarget

      String getUrlTarget()
      Returns:
      target of URL

    • setUrlTarget

      @StudioProperty(type=OPTIONS, options={"_blank","_parent","_self","_top"}, defaultValue="_self") T setUrlTarget(String urlTarget)
      Sets target of URL. If not set the default value is "_self".
      Parameters:
      urlTarget - the URL target string
      Returns:
      coordinate chart model