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 Summary

Modifier and Type	Method and Description
T	addAdditionalSegmentFields(java.lang.String... fields) Adds additional segment fields.
java.util.List<java.lang.String>	getAdditionalSegmentFields()
java.lang.Integer	getBrightnessStep()
java.lang.String	getColorField()
java.lang.String	getColumnWidthField()
java.lang.String	getDurationField()
java.lang.String	getEndDateField()
java.lang.String	getEndField()
Graph	getGraph()
DatePeriod	getPeriod()
java.lang.String	getSegmentsField()
java.util.Date	getStartDate()
java.lang.String	getStartDateField()
java.lang.String	getStartField()
ValueAxis	getValueAxis()
T	setAdditionalSegmentFields(java.util.List<java.lang.String> additionalSegmentFields) Sets the list of additional segment fields that should be fetched from the data provider, similarly to the additionalFields attribute.
T	setBrightnessStep(java.lang.Integer brightnessStep) Sets brightness step.
T	setColorField(java.lang.String colorField) Sets segment color field from your data provider.
T	setColumnWidthField(java.lang.String columnWidthField) Sets field of column width of a segments from your data provider.
T	setDurationField(java.lang.String durationField) Sets duration field.
T	setEndDateField(java.lang.String endDateField) Sets end date field from your data provider which holds end date of a segment.
T	setEndField(java.lang.String endField) Sets end field from your data provider which holds end value of a segment.
T	setGraph(Graph graph) Sets graph of a Gantt chart.
T	setPeriod(DatePeriod period) Sets data period.
T	setSegmentsField(java.lang.String segmentsField) Sets segments field in your data provider.
T	setStartDate(java.util.Date startDate) Sets initial date of value axis.
T	setStartDateField(java.lang.String startDateField) Sets date field from your data provider which holds start date of a segment.
T	setStartField(java.lang.String startField) Sets start field from your data provider which holds start value of a segment.
T	setValueAxis(ValueAxis valueAxis) Sets value axis of Gantt chart.

Methods inherited from interface io.jmix.charts.model.chart.SeriesBasedChartModel

getBalloonDateFormat, getCategoryAxis, getCategoryField, getColumnSpacing, getColumnSpacing3D, getColumnWidth, getDataDateFormat, getMaxSelectedSeries, getMaxSelectedTime, getMinSelectedTime, getMouseWheelScrollEnabled, getMouseWheelZoomEnabled, getRotate, getSynchronizeGrid, getValueScrollbar, getZoomOutOnDataUpdate, setBalloonDateFormat, setCategoryAxis, setCategoryField, setColumnSpacing, setColumnSpacing3D, setColumnWidth, setDataDateFormat, setMaxSelectedSeries, setMaxSelectedTime, setMinSelectedTime, setMouseWheelScrollEnabled, setMouseWheelZoomEnabled, setRotate, setSynchronizeGrid, setValueScrollbar, setZoomOutOnDataUpdate

Methods inherited from interface io.jmix.charts.model.chart.RectangularChartModel

addTrendLines, getAngle, getAutoMarginOffset, getAutoMargins, getChartCursor, getChartScrollbar, getDepth3D, getMarginsUpdated, getMaxZoomFactor, getMinMarginBottom, getMinMarginLeft, getMinMarginRight, getMinMarginTop, getPlotAreaBorderAlpha, getPlotAreaBorderColor, getPlotAreaFillAlphas, getPlotAreaFillColors, getPlotAreaGradientAngle, getTrendLines, getZoomOutButtonAlpha, getZoomOutButtonColor, getZoomOutButtonImage, getZoomOutButtonImageSize, getZoomOutButtonPadding, getZoomOutButtonRollOverAlpha, getZoomOutButtonTabIndex, getZoomOutText, setAngle, setAutoMarginOffset, setAutoMargins, setChartCursor, setChartScrollbar, setDepth3D, setMarginsUpdated, setMaxZoomFactor, setMinMarginBottom, setMinMarginLeft, setMinMarginRight, setMinMarginTop, setPlotAreaBorderAlpha, setPlotAreaBorderColor, setPlotAreaFillAlphas, setPlotAreaFillColors, setPlotAreaGradientAngle, setTrendLines, setZoomOutButtonAlpha, setZoomOutButtonColor, setZoomOutButtonImage, setZoomOutButtonImageSize, setZoomOutButtonPadding, setZoomOutButtonRollOverAlpha, setZoomOutButtonTabIndex, setZoomOutText

Methods inherited from interface io.jmix.charts.model.chart.CoordinateChartModel

addGraphs, addGuides, addValueAxes, getGraphs, getGridAboveGraphs, getGuides, getSequencedAnimation, getStartAlpha, getUrlTarget, getValueAxes, setGraphs, setGridAboveGraphs, setGuides, setSequencedAnimation, setStartAlpha, setUrlTarget, setValueAxes

Methods inherited from interface io.jmix.charts.model.chart.ChartModel

addAdditionalFields, addData, addLabels, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addTitles, getAccessible, getAccessibleDescription, getAccessibleTitle, getAddClassNames, getAdditionalFields, getAllLabels, getAutoDisplay, getAutoResize, getAutoTransform, getBackgroundAlpha, getBackgroundColor, getBalloon, getBorderAlpha, getBorderColor, getClassNamePrefix, getColor, getCreditsPosition, getDataProvider, getDecimalSeparator, getDefs, getExport, getFontFamily, getFontSize, getHandDrawn, getHandDrawScatter, getHandDrawThickness, getHideBalloonTime, getLanguage, getLegend, getPanEventsEnabled, getPath, getPathToImages, getPercentPrecision, getPrecision, getPrefixesOfBigNumbers, getPrefixesOfSmallNumbers, getProcessCount, getProcessTimeout, getResponsive, getSvgIcons, getTapToActivate, getTheme, getThousandsSeparator, getTitles, getTouchClickDuration, getUsePrefixes, setAccessible, setAccessibleDescription, setAccessibleTitle, setAddClassNames, setAdditionalFields, setAllLabels, setAutoDisplay, setAutoResize, setAutoTransform, setBackgroundAlpha, setBackgroundColor, setBalloon, setBorderAlpha, setBorderColor, setClassNamePrefix, setColor, setCreditsPosition, setDataProvider, setDecimalSeparator, setDefs, setExport, setFontFamily, setFontSize, setHandDrawn, setHandDrawScatter, setHandDrawThickness, setHideBalloonTime, setLanguage, setLegend, setPanEventsEnabled, setPath, setPathToImages, setPercentPrecision, setPrecision, setPrefixesOfBigNumbers, setPrefixesOfSmallNumbers, setProcessCount, setProcessTimeout, setResponsive, setSvgIcons, setTapToActivate, setTheme, setThousandsSeparator, setTitles, setTouchClickDuration, setUsePrefixes

Methods inherited from interface io.jmix.charts.model.animation.HasStartEffect

getStartDuration, getStartEffect, setStartDuration, setStartEffect

Methods inherited from interface io.jmix.charts.model.HasColors

addColors, getColors, setColors

Methods inherited from interface io.jmix.charts.model.HasMargins

getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

Method Detail

getBrightnessStep

java.lang.Integer getBrightnessStep()

Returns:

brightness step

setBrightnessStep

@StudioProperty
 @Max(value=255L)
 @Min(value=-255L)
T setBrightnessStep(java.lang.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

java.lang.String getColorField()

Returns:

segment color field

setColorField

@StudioProperty(type=PROPERTY_PATH_REF)
T setColorField(java.lang.String colorField)

Sets segment color field from your data provider.

Parameters:

colorField - color field string

Returns:

gantt chart model

getColumnWidthField

java.lang.String getColumnWidthField()

Returns:

column width field

setColumnWidthField

@StudioProperty(type=PROPERTY_PATH_REF)
T setColumnWidthField(java.lang.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

java.lang.String getDurationField()

Returns:

duration field

setDurationField

@StudioProperty(type=PROPERTY_PATH_REF)
T setDurationField(java.lang.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

java.lang.String getEndDateField()

Returns:

end date field

setEndDateField

@StudioProperty(type=PROPERTY_PATH_REF)
T setEndDateField(java.lang.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

java.lang.String getEndField()

Returns:

end field

setEndField

@StudioProperty(type=PROPERTY_PATH_REF)
T setEndField(java.lang.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

java.lang.String getSegmentsField()

Returns:

segments field

setSegmentsField

@StudioProperty(type=PROPERTY_PATH_REF)
T setSegmentsField(java.lang.String segmentsField)

Sets segments field in your data provider.

Parameters:

segmentsField - segments field string

Returns:

gantt chart model

getStartDate

java.util.Date getStartDate()

Returns:

start date

setStartDate

@StudioProperty
T setStartDate(java.util.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

java.lang.String getStartDateField()

Returns:

start date field

setStartDateField

@StudioProperty(type=PROPERTY_PATH_REF)
T setStartDateField(java.lang.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

java.lang.String getStartField()

Returns:

start field

setStartField

@StudioProperty(type=PROPERTY_PATH_REF)
T setStartField(java.lang.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

java.util.List<java.lang.String> getAdditionalSegmentFields()

Returns:

additional segment fields that should be fetched from the data provider

setAdditionalSegmentFields

@StudioProperty(type=STRING)
T setAdditionalSegmentFields(java.util.List<java.lang.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(java.lang.String... fields)

Adds additional segment fields.

Parameters:

fields - the fields

Returns:

gantt chart model