Package io.jmix.charts.model.chart

Interface GanttChartModel<T extends GanttChartModel>

All Superinterfaces:
ChartModel<T>, CoordinateChartModel<T>, HasColors<T>, HasMargins<T>, HasStartEffect<T>, RectangularChartModel<T>, SeriesBasedChartModel<T>
All Known Subinterfaces:
GanttChart
All Known Implementing Classes:
GanttChartImpl, GanttChartModelImpl
public interface GanttChartModel<T extends GanttChartModel> extends SeriesBasedChartModel<T>

  • Method Details

    • getBrightnessStep

      Integer getBrightnessStep()
      Returns:
      brightness step

    • setBrightnessStep

      @StudioProperty @Max(255L) @Min(-255L) T setBrightnessStep(Integer brightnessStep)
      Sets brightness step. Lightness increase of each subsequent bar of one series. Value range is from -255 to 255.
      Parameters:
      brightnessStep - brightness step
      Returns:
      gantt chart model

    • getColorField

      String getColorField()
      Returns:
      segment color field

    • setColorField

      @StudioProperty(type=PROPERTY_PATH_REF) T setColorField(String colorField)
      Sets segment color field from your data provider.
      Parameters:
      colorField - color field string
      Returns:
      gantt chart model

    • getColumnWidthField

      String getColumnWidthField()
      Returns:
      column width field

    • setColumnWidthField

      @StudioProperty(type=PROPERTY_PATH_REF) T setColumnWidthField(String columnWidthField)
      Sets field of column width of a segments from your data provider.
      Parameters:
      columnWidthField - column width field string
      Returns:
      gantt chart model

    • getDurationField

      String getDurationField()
      Returns:
      duration field

    • setDurationField

      @StudioProperty(type=PROPERTY_PATH_REF) T setDurationField(String durationField)
      Sets duration field. Instead of specifying end date or end value in your data, you can specify duration of a segment.
      Parameters:
      durationField - duration field string
      Returns:
      gantt chart model

    • getEndDateField

      String getEndDateField()
      Returns:
      end date field

    • setEndDateField

      @StudioProperty(type=PROPERTY_PATH_REF) T setEndDateField(String endDateField)
      Sets end date field from your data provider which holds end date of a segment.
      Parameters:
      endDateField - end date field string
      Returns:
      gantt chart model

    • getEndField

      String getEndField()
      Returns:
      end field

    • setEndField

      @StudioProperty(type=PROPERTY_PATH_REF) T setEndField(String endField)
      Sets end field from your data provider which holds end value of a segment. If your data is date-based, you should use endDateField instead, unless you specified startDate and period values. In this case you can use endField and set number of periods instead of providing exact end date. If not set the default value is "ss".
      Parameters:
      endField - end field string
      Returns:
      gantt chart model

    • getGraph

      Graph getGraph()
      Returns:
      graph

    • setGraph

      T setGraph(Graph graph)
      Sets graph of a Gantt chart. Gantt chart actually creates multiple graphs (separate for each segment). Properties of this graph are passed to each of the created graphs - this allows you to control the look of segments.
      Parameters:
      graph - the graph
      Returns:
      gantt chart model

    • getPeriod

      DatePeriod getPeriod()
      Returns:
      data period

    • setPeriod

      T setPeriod(DatePeriod period)
      Sets data period. Used only value axis is date-based.
      Parameters:
      period - the period
      Returns:
      gantt chart model

    • getSegmentsField

      String getSegmentsField()
      Returns:
      segments field

    • setSegmentsField

      @StudioProperty(type=PROPERTY_PATH_REF) T setSegmentsField(String segmentsField)
      Sets segments field in your data provider.
      Parameters:
      segmentsField - segments field string
      Returns:
      gantt chart model

    • getStartDate

      Date getStartDate()
      Returns:
      start date

    • setStartDate

      @StudioProperty T setStartDate(Date startDate)
      Sets initial date of value axis. If you set this date, then you can set start, end, duration of segments using number of periods instead of providing exact dates.
      Parameters:
      startDate - the start date
      Returns:
      gantt chart model

    • getStartDateField

      String getStartDateField()
      Returns:
      start date field

    • setStartDateField

      @StudioProperty(type=PROPERTY_PATH_REF) T setStartDateField(String startDateField)
      Sets date field from your data provider which holds start date of a segment.
      Parameters:
      startDateField - start date field string
      Returns:
      gantt chart model

    • getStartField

      String getStartField()
      Returns:
      start field

    • setStartField

      @StudioProperty(type=PROPERTY_PATH_REF) T setStartField(String startField)
      Sets start field from your data provider which holds start value of a segment. If your data is date-based, you should use startDateField instead, unless you specified startDate and period values. In this case you can use startField and set number of periods instead of providing exact start date.
      Parameters:
      startField - start field string
      Returns:
      gantt chart model

    • getValueAxis

      ValueAxis getValueAxis()
      Returns:
      value axis

    • setValueAxis

      T setValueAxis(ValueAxis valueAxis)
      Sets value axis of Gantt chart. Set it's type to "date" if your data is date or time based.
      Parameters:
      valueAxis - the value axis
      Returns:
      gantt chart model

    • getAdditionalSegmentFields

      List<String> getAdditionalSegmentFields()
      Returns:
      additional segment fields that should be fetched from the data provider

    • setAdditionalSegmentFields

      @StudioProperty(type=STRING) T setAdditionalSegmentFields(List<String> additionalSegmentFields)
      Sets the list of additional segment fields that should be fetched from the data provider, similarly to the additionalFields attribute.
      Parameters:
      additionalSegmentFields - list of additional segment fields
      Returns:
      gantt chart model

    • addAdditionalSegmentFields

      T addAdditionalSegmentFields(String... fields)
      Adds additional segment fields.
      Parameters:
      fields - the fields
      Returns:
      gantt chart model