Package io.jmix.chartsflowui.kit.component.model.axis

Class AbstractCartesianAxis<T extends AbstractCartesianAxis<T>>

java.lang.Object

io.jmix.chartsflowui.kit.component.model.ChartObservableObject

io.jmix.chartsflowui.kit.component.model.axis.AbstractAxis<T>

io.jmix.chartsflowui.kit.component.model.axis.AbstractCartesianAxis<T>

Type Parameters:

T - origin class type

All Implemented Interfaces:

HasAxisName<T>, Serializable

Direct Known Subclasses:

XAxis, YAxis

public abstract class AbstractCartesianAxis<T extends AbstractCartesianAxis<T>>
extends AbstractAxis<T>
implements HasAxisName<T>

The base class for Cartesian axes.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AbstractCartesianAxis.Position	Position of Cartesian axis.

Nested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.axis.AbstractAxis

AbstractAxis.AxisPointer, AbstractAxis.BoundaryGap

Nested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject

ChartObservableObject.ObjectChangeEvent

Nested classes/interfaces inherited from interface io.jmix.chartsflowui.kit.component.model.axis.HasAxisName

HasAxisName.NameLocation, HasAxisName.NameTextStyle

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	alignTicks
protected Integer	gridIndex
protected Boolean	inverse
protected String	name
protected Integer	nameGap
protected HasAxisName.NameLocation	nameLocation
protected Integer	nameRotate
protected HasAxisName.NameTextStyle	nameTextStyle
protected Integer	offset
protected AbstractCartesianAxis.Position	position
protected Boolean	show

Fields inherited from class io.jmix.chartsflowui.kit.component.model.axis.AbstractAxis

animation, animationDelay, animationDelayFunction, animationDelayUpdate, animationDelayUpdateFunction, animationDuration, animationDurationFunction, animationDurationUpdate, animationDurationUpdateFunction, animationEasing, animationEasingUpdate, animationThreshold, axisLabel, axisLine, axisPointer, axisTick, boundaryGap, id, interval, logBase, max, maxFunction, maxInterval, min, minFunction, minInterval, minorSplitLine, minorTick, scale, silent, splitArea, splitLine, splitNumber, triggerEvent, type, z, zLevel

Fields inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject

children, dirty, listener

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCartesianAxis(AxisType type)

Method Summary

Modifier and Type	Method	Description
Boolean	getAlignTicks()
Integer	getGridIndex()
Boolean	getInverse()
String	getName()
Integer	getNameGap()
HasAxisName.NameLocation	getNameLocation()
Integer	getNameRotate()
HasAxisName.NameTextStyle	getNameTextStyle()
Integer	getOffset()
AbstractCartesianAxis.Position	getPosition()
Boolean	getShow()
void	setAlignTicks(Boolean alignTicks)
void	setGridIndex(Integer gridIndex)
void	setInverse(Boolean inverse)	Sets the inversion for the axis or replaces an existing one.
void	setName(String name)	Sets an axis name or replaces an existing one.
void	setNameGap(Integer nameGap)	Sets gap between axis name and axis line or replaces an existing one.
void	setNameLocation(HasAxisName.NameLocation nameLocation)	Sets a location of axis name or replaces an existing one.
void	setNameRotate(Integer nameRotate)	Sets a rotate degree of axis name or replaces an existing one.
void	setNameTextStyle(HasAxisName.NameTextStyle nameTextStyle)	Sets a font text style of axis name or replaces an existing one.
void	setOffset(Integer offset)
void	setPosition(AbstractCartesianAxis.Position position)
void	setShow(Boolean show)
T	withAlignTicks(Boolean alignTicks)
T	withGridIndex(Integer gridIndex)
T	withOffset(Integer offset)
T	withPosition(AbstractCartesianAxis.Position position)
T	withShow(Boolean show)

Methods inherited from class io.jmix.chartsflowui.kit.component.model.axis.AbstractAxis

getAnimation, getAnimationDelay, getAnimationDelayFunction, getAnimationDelayUpdate, getAnimationDelayUpdateFunction, getAnimationDuration, getAnimationDurationFunction, getAnimationDurationUpdate, getAnimationDurationUpdateFunction, getAnimationEasing, getAnimationEasingUpdate, getAnimationThreshold, getAxisLabel, getAxisLine, getAxisPointer, getAxisTick, getBoundaryGap, getId, getInterval, getLogBase, getMax, getMaxFunction, getMaxInterval, getMin, getMinFunction, getMinInterval, getMinorSplitLine, getMinorTick, getScale, getSilent, getSplitArea, getSplitLine, getSplitNumber, getTriggerEvent, getType, getZ, getZLevel, setAnimation, setAnimationDelay, setAnimationDelayFunction, setAnimationDelayFunction, setAnimationDelayUpdate, setAnimationDelayUpdateFunction, setAnimationDelayUpdateFunction, setAnimationDuration, setAnimationDurationFunction, setAnimationDurationFunction, setAnimationDurationUpdate, setAnimationDurationUpdateFunction, setAnimationDurationUpdateFunction, setAnimationEasing, setAnimationEasingUpdate, setAnimationThreshold, setAxisLabel, setAxisLine, setAxisPointer, setAxisTick, setBoundaryGap, setBoundaryGap, setId, setInterval, setLogBase, setMax, setMaxFunction, setMaxFunction, setMaxInterval, setMin, setMinFunction, setMinFunction, setMinInterval, setMinorSplitLine, setMinorTick, setScale, setSilent, setSplitArea, setSplitLine, setSplitNumber, setTriggerEvent, setType, setZ, setZLevel, withAnimation, withAnimationDelay, withAnimationDelayFunction, withAnimationDelayFunction, withAnimationDelayUpdate, withAnimationDelayUpdateFunction, withAnimationDelayUpdateFunction, withAnimationDuration, withAnimationDurationFunction, withAnimationDurationFunction, withAnimationDurationUpdate, withAnimationDurationUpdateFunction, withAnimationDurationUpdateFunction, withAnimationEasing, withAnimationEasingUpdate, withAnimationThreshold, withAxisLabel, withAxisLine, withAxisPointer, withAxisTick, withBoundaryGap, withBoundaryGap, withId, withInterval, withLogBase, withMax, withMaxFunction, withMaxFunction, withMaxInterval, withMin, withMinFunction, withMinFunction, withMinInterval, withMinorSplitLine, withMinorTick, withScale, withSilent, withSplitArea, withSplitLine, withSplitNumber, withTriggerEvent, withType, withZ, withZLevel

Methods inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject

addChild, fireChangeEvent, getChildren, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setChartObjectChangeListener, unmarkDirtyInDepth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.chartsflowui.kit.component.model.axis.HasAxisName

withInverse, withName, withNameGap, withNameLocation, withNameRotate, withNameTextStyle

Field Details

show

protected Boolean show

gridIndex

protected Integer gridIndex

alignTicks

protected Boolean alignTicks

position

protected AbstractCartesianAxis.Position position

offset

protected Integer offset

name

protected String name

nameLocation

protected HasAxisName.NameLocation nameLocation

nameTextStyle

protected HasAxisName.NameTextStyle nameTextStyle

nameGap

protected Integer nameGap

nameRotate

protected Integer nameRotate

inverse

protected Boolean inverse

Constructor Details

AbstractCartesianAxis

protected AbstractCartesianAxis(AxisType type)

Method Details

getShow

public Boolean getShow()

setShow

public void setShow(Boolean show)

getGridIndex

public Integer getGridIndex()

setGridIndex

public void setGridIndex(Integer gridIndex)

getAlignTicks

public Boolean getAlignTicks()

setAlignTicks

public void setAlignTicks(Boolean alignTicks)

getPosition

public AbstractCartesianAxis.Position getPosition()

setPosition

public void setPosition(AbstractCartesianAxis.Position position)

getOffset

public Integer getOffset()

setOffset

public void setOffset(Integer offset)

getName

public String getName()

Specified by:

getName in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Returns:

axis name

setName

public void setName(String name)

Description copied from interface: HasAxisName

Sets an axis name or replaces an existing one.

Specified by:

setName in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Parameters:

name - axis name to set

getNameLocation

public HasAxisName.NameLocation getNameLocation()

Specified by:

getNameLocation in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Returns:

location of axis name

setNameLocation

public void setNameLocation(HasAxisName.NameLocation nameLocation)

Description copied from interface: HasAxisName

Sets a location of axis name or replaces an existing one.

Specified by:

setNameLocation in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Parameters:

nameLocation - location to set

getNameTextStyle

public HasAxisName.NameTextStyle getNameTextStyle()

Specified by:

getNameTextStyle in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Returns:

font text style of axis name

setNameTextStyle

public void setNameTextStyle(HasAxisName.NameTextStyle nameTextStyle)

Description copied from interface: HasAxisName

Sets a font text style of axis name or replaces an existing one.

Specified by:

setNameTextStyle in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Parameters:

nameTextStyle - text style to set

getNameGap

public Integer getNameGap()

Specified by:

getNameGap in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Returns:

gap between axis name and axis line. The unit is pixels.

setNameGap

public void setNameGap(Integer nameGap)

Description copied from interface: HasAxisName

Sets gap between axis name and axis line or replaces an existing one.

Specified by:

setNameGap in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Parameters:

nameGap - gap to set in pixels

getNameRotate

public Integer getNameRotate()

Specified by:

getNameRotate in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Returns:

rotate degree of axis name

setNameRotate

public void setNameRotate(Integer nameRotate)

Description copied from interface: HasAxisName

Sets a rotate degree of axis name or replaces an existing one.

Specified by:

setNameRotate in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Parameters:

nameRotate - rotate degree to set

getInverse

public Boolean getInverse()

Specified by:

getInverse in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Returns:

true if the axis is inverted, false otherwise

setInverse

public void setInverse(Boolean inverse)

Description copied from interface: HasAxisName

Sets the inversion for the axis or replaces an existing one.

Specified by:

setInverse in interface HasAxisName<T extends AbstractCartesianAxis<T>>

Parameters:

inverse - whether to inverse axis

withShow

public T withShow(Boolean show)

withGridIndex

public T withGridIndex(Integer gridIndex)

withAlignTicks

public T withAlignTicks(Boolean alignTicks)

withPosition

public T withPosition(AbstractCartesianAxis.Position position)

withOffset

public T withOffset(Integer offset)