io.jmix.charts.model.chart

Interface AngularGaugeChartModel<T extends AngularGaugeChartModel>

All Superinterfaces:

ChartModel<T>, HasMargins<T>, HasStartEffect<T>

All Known Subinterfaces:

AngularGaugeChart

All Known Implementing Classes:

AngularGaugeChartImpl, AngularGaugeChartModelImpl

public interface AngularGaugeChartModel<T extends AngularGaugeChartModel>
extends ChartModel<T>, HasMargins<T>, HasStartEffect<T>

Method Summary

Modifier and Type	Method and Description
T	addArrows(GaugeArrow... arrows) Adds GaugeArrows.
T	addAxes(GaugeAxis... axes) Adds GaugeAxis.
java.lang.Boolean	getAdjustSize()
java.util.List<GaugeArrow>	getArrows()
java.util.List<GaugeAxis>	getAxes()
java.lang.Boolean	getClockWiseOnly()
java.lang.Double	getFaceAlpha()
java.lang.Double	getFaceBorderAlpha()
Color	getFaceBorderColor()
java.lang.Integer	getFaceBorderWidth()
Color	getFaceColor()
Pattern	getFacePattern()
java.lang.String	getGaugeX()
java.lang.String	getGaugeY()
java.lang.Integer	getMinRadius()
T	setAdjustSize(java.lang.Boolean adjustSize) Sets using the whole space of the canvas to draw the gauge.
T	setArrows(java.util.List<GaugeArrow> arrows) Sets list of GaugeArrow.
T	setAxes(java.util.List<GaugeAxis> axes) Sets list of GaugeAxis.
T	setClockWiseOnly(java.lang.Boolean clockWiseOnly) Set clockWiseOnly to true if you use gauge to create a clock.
T	setFaceAlpha(java.lang.Double faceAlpha) Sets gauge face opacity.
T	setFaceBorderAlpha(java.lang.Double faceBorderAlpha) Sets gauge face border opacity.
T	setFaceBorderColor(Color faceBorderColor) Sets gauge face border color.
T	setFaceBorderWidth(java.lang.Integer faceBorderWidth) Sets gauge face border width.
T	setFaceColor(Color faceColor) Sets gauge face color, requires faceAlpha greater than 0 value.
T	setFacePattern(Pattern facePattern) Sets gauge face image-pattern.
T	setGaugeX(java.lang.String gaugeX) Sets gauge's horizontal position in pixel, origin is the center.
T	setGaugeY(java.lang.String gaugeY) Sets gauge's vertical position in pixel, origin is the center.
T	setMinRadius(java.lang.Integer minRadius) Sets minimum radius of a gauge.

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

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

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

getStartDuration, getStartEffect, setStartDuration, setStartEffect

Method Detail

getAdjustSize

java.lang.Boolean getAdjustSize()

Returns:

true if adjust size is enabled

setAdjustSize

@StudioProperty(defaultValue="true")
T setAdjustSize(java.lang.Boolean adjustSize)

Sets using the whole space of the canvas to draw the gauge. If not set the default value is true.

Parameters:

adjustSize - adjust size option

Returns:

chart model

getArrows

java.util.List<GaugeArrow> getArrows()

Returns:

list of GaugeArrow

setArrows

@StudioElementsGroup(caption="Arrows",
                     xmlElement="arrows")
T setArrows(java.util.List<GaugeArrow> arrows)

Sets list of GaugeArrow.

Parameters:

arrows - the arrows

Returns:

chart model

addArrows

T addArrows(GaugeArrow... arrows)

Adds GaugeArrows.

Parameters:

arrows - the arrows

Returns:

chart model

getAxes

java.util.List<GaugeAxis> getAxes()

Returns:

list of GaugeAxis

setAxes

@StudioElementsGroup(caption="Axes",
                     xmlElement="axes")
T setAxes(java.util.List<GaugeAxis> axes)

Sets list of GaugeAxis.

Parameters:

axes - the axes

Returns:

chart model

addAxes

T addAxes(GaugeAxis... axes)

Adds GaugeAxis.

Parameters:

axes - the axes

Returns:

chart model

getClockWiseOnly

java.lang.Boolean getClockWiseOnly()

Returns:

true if clock wise only is enabled

setClockWiseOnly

@StudioProperty(defaultValue="false")
T setClockWiseOnly(java.lang.Boolean clockWiseOnly)

Set clockWiseOnly to true if you use gauge to create a clock. If not set the default value is false.

Parameters:

clockWiseOnly - clock wise only option

Returns:

chart model

getFaceAlpha

java.lang.Double getFaceAlpha()

Returns:

gauge face opacity

setFaceAlpha

@StudioProperty(defaultValue="0")
 @Max(value=1L)
 @Min(value=0L)
T setFaceAlpha(java.lang.Double faceAlpha)

Sets gauge face opacity. If not set the default value is 0.

Parameters:

faceAlpha - the face alpha

Returns:

chart model

getFaceBorderAlpha

java.lang.Double getFaceBorderAlpha()

Returns:

gauge face border opacity.

setFaceBorderAlpha

@StudioProperty(defaultValue="0")
 @Max(value=1L)
 @Min(value=0L)
T setFaceBorderAlpha(java.lang.Double faceBorderAlpha)

Sets gauge face border opacity. If not set the default value is 0.

Parameters:

faceBorderAlpha - the face border alpha

Returns:

chart model

getFaceBorderColor

Color getFaceBorderColor()

Returns:

gauge face border color.

setFaceBorderColor

@StudioProperty(type=OPTIONS,
                defaultValue="#555555")
T setFaceBorderColor(Color faceBorderColor)

Sets gauge face border color. If not set the default value is #555555.

Parameters:

faceBorderColor - the face border color

Returns:

chart model

getFaceBorderWidth

java.lang.Integer getFaceBorderWidth()

Returns:

gauge face border width.

setFaceBorderWidth

@StudioProperty(defaultValue="1")
T setFaceBorderWidth(java.lang.Integer faceBorderWidth)

Sets gauge face border width. If not set the default value is 1.

Parameters:

faceBorderWidth - the face border width

Returns:

chart model

getFaceColor

Color getFaceColor()

Returns:

gauge face color

setFaceColor

@StudioProperty(type=OPTIONS,
                defaultValue="#FAFAFA")
T setFaceColor(Color faceColor)

Sets gauge face color, requires faceAlpha greater than 0 value. If not set the default value is #FAFAFA.

Parameters:

faceColor - the face color

Returns:

chart model

getFacePattern

Pattern getFacePattern()

Returns:

gauge face image-pattern

setFacePattern

T setFacePattern(Pattern facePattern)

Sets gauge face image-pattern.

Parameters:

facePattern - the face pattern

Returns:

chart model

getGaugeX

java.lang.String getGaugeX()

Returns:

gauge's horizontal position in pixel

setGaugeX

@StudioProperty
T setGaugeX(java.lang.String gaugeX)

Sets gauge's horizontal position in pixel, origin is the center. Centered by default.

Parameters:

gaugeX - horizontal position in pixel

Returns:

chart model

getGaugeY

java.lang.String getGaugeY()

Returns:

gauge's vertical position in pixel

setGaugeY

@StudioProperty
T setGaugeY(java.lang.String gaugeY)

Sets gauge's vertical position in pixel, origin is the center. Centered by default.

Parameters:

gaugeY - vertical position in pixel

Returns:

chart model

getMinRadius

java.lang.Integer getMinRadius()

Returns:

minimum radius of a gauge

setMinRadius

@StudioProperty(defaultValue="10")
T setMinRadius(java.lang.Integer minRadius)

Sets minimum radius of a gauge. If not set the default value is 10.

Parameters:

minRadius - minimum radius

Returns:

chart model