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

Class Brush

java.lang.Object

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

io.jmix.chartsflowui.kit.component.model.Brush

All Implemented Interfaces:

Serializable

public class Brush
extends ChartObservableObject

Brush is an area-selecting component, with which user can select part of series from a chart to display in detail. More detailed information is provided in the documentation.

See Also:

• Brush documentation
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Brush.BrushLink	Links interaction between selected items in different series.
static enum	Brush.BrushMode	Brush selecting mode.
static enum	Brush.BrushSelectMode	Mode for brush selecting.
static class	Brush.BrushStyle	Brush font style.
static enum	Brush.BrushType	Type of brush.
static class	Brush.IndexItem	Index of item which can use brush selecting.
static enum	Brush.SeriesIndex	Enum for assigns which of the series can use brush selecting.
static enum	Brush.ThrottleType	Update type for brush selecting event.
static enum	Brush.Toolbox	Buttons in toolbox that is related to brush includes.

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

ChartObservableObject.ObjectChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Brush.BrushLink	brushLink
protected Brush.BrushMode	brushMode
protected Brush.BrushStyle	brushStyle
protected Brush.BrushType	brushType
protected Brush.IndexItem	geoIndex
protected String	id
protected VisualEffect	inBrush
protected VisualEffect	outOfBrush
protected Boolean	removeOnClick
protected Brush.SeriesIndex	seriesIndex
protected Double	throttleDelay
protected Brush.ThrottleType	throttleType
protected Brush.Toolbox[]	toolboxes
protected Boolean	transformable
protected Brush.IndexItem	xAxisIndex
protected Brush.IndexItem	yAxisIndex
protected Integer	z

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

children, dirty, listener

Constructor Summary

Constructors

Constructor	Description
Brush()

Method Summary

Modifier and Type	Method	Description
Brush.BrushLink	getBrushLink()
Brush.BrushMode	getBrushMode()
Brush.BrushStyle	getBrushStyle()
Brush.BrushType	getBrushType()
Brush.IndexItem	getGeoIndex()
String	getId()
VisualEffect	getInBrush()
VisualEffect	getOutOfBrush()
Boolean	getRemoveOnClick()
Brush.SeriesIndex	getSeriesIndex()
Double	getThrottleDelay()
Brush.ThrottleType	getThrottleType()
Brush.Toolbox[]	getToolboxes()
Boolean	getTransformable()
Brush.IndexItem	getXAxisIndex()
Brush.IndexItem	getYAxisIndex()
Integer	getZ()
void	setBrushLink(Brush.BrushSelectMode brushSelectMode)
void	setBrushLink(Integer... seriesIndexes)
void	setBrushMode(Brush.BrushMode brushMode)
void	setBrushStyle(Brush.BrushStyle brushStyle)
void	setBrushType(Brush.BrushType brushType)
void	setGeoIndex(Brush.BrushSelectMode brushSelectMode)
void	setGeoIndex(Integer number)
void	setGeoIndex(Integer... indexes)
void	setId(String id)
void	setInBrush(VisualEffect inBrush)
void	setOutOfBrush(VisualEffect outOfBrush)
void	setRemoveOnClick(Boolean removeOnClick)
void	setSeriesIndex(Brush.SeriesIndex seriesIndex)
void	setThrottleDelay(Double throttleDelay)
void	setThrottleType(Brush.ThrottleType throttleType)
void	setToolboxes(Brush.Toolbox... toolboxes)
void	setTransformable(Boolean transformable)
void	setXAxisIndex(Brush.BrushSelectMode brushSelectMode)
void	setXAxisIndex(Integer number)
void	setXAxisIndex(Integer... indexes)
void	setYAxisIndex(Brush.BrushSelectMode brushSelectMode)
void	setYAxisIndex(Integer number)
void	setYAxisIndex(Integer... indexes)
void	setZ(Integer z)
Brush	withBrushLine(Brush.BrushSelectMode brushSelectMode)
Brush	withBrushLink(Integer... seriesIndexes)
Brush	withBrushMode(Brush.BrushMode brushMode)
Brush	withBrushStyle(Brush.BrushStyle brushStyle)
Brush	withBrushType(Brush.BrushType brushType)
Brush	withGeoIndex(Brush.BrushSelectMode brushSelectedMode)
Brush	withGeoIndex(Integer number)
Brush	withGeoIndex(Integer... indexes)
Brush	withId(String id)
Brush	withInBrush(VisualEffect inBrush)
Brush	withOutOfBrush(VisualEffect outOfBrush)
Brush	withRemoveOnClick(Boolean removeOnClick)
Brush	withSeriesIndex(Brush.SeriesIndex seriesIndex)
Brush	withThrottleDelay(Double throttleDelay)
Brush	withThrottleType(Brush.ThrottleType throttleType)
Brush	withToolboxes(Brush.Toolbox... toolbox)
Brush	withTransformable(Boolean transformable)
Brush	withXAxisIndex(Brush.BrushSelectMode brushSelectedMode)
Brush	withXAxisIndex(Integer number)
Brush	withXAxisIndex(Integer... indexes)
Brush	withYAxisIndex(Brush.BrushSelectMode brushSelectMode)
Brush	withYAxisIndex(Integer number)
Brush	withYAxisIndex(Integer... indexes)
Brush	withZ(Integer z)

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

Field Details

id

protected String id

toolboxes

protected Brush.Toolbox[] toolboxes

brushLink

protected Brush.BrushLink brushLink

seriesIndex

protected Brush.SeriesIndex seriesIndex

geoIndex

protected Brush.IndexItem geoIndex

xAxisIndex

protected Brush.IndexItem xAxisIndex

yAxisIndex

protected Brush.IndexItem yAxisIndex

brushType

protected Brush.BrushType brushType

brushMode

protected Brush.BrushMode brushMode

transformable

protected Boolean transformable

brushStyle

protected Brush.BrushStyle brushStyle

throttleType

protected Brush.ThrottleType throttleType

throttleDelay

protected Double throttleDelay

removeOnClick

protected Boolean removeOnClick

inBrush

protected VisualEffect inBrush

outOfBrush

protected VisualEffect outOfBrush

z

protected Integer z

Constructor Details

Brush

public Brush()

Method Details

getId

public String getId()

setId

public void setId(String id)

getToolboxes

public Brush.Toolbox[] getToolboxes()

setToolboxes

public void setToolboxes(Brush.Toolbox... toolboxes)

getBrushLink

public Brush.BrushLink getBrushLink()

setBrushLink

public void setBrushLink(Integer... seriesIndexes)

setBrushLink

public void setBrushLink(Brush.BrushSelectMode brushSelectMode)

getSeriesIndex

public Brush.SeriesIndex getSeriesIndex()

setSeriesIndex

public void setSeriesIndex(Brush.SeriesIndex seriesIndex)

getGeoIndex

public Brush.IndexItem getGeoIndex()

setGeoIndex

public void setGeoIndex(Integer number)

setGeoIndex

public void setGeoIndex(Integer... indexes)

setGeoIndex

public void setGeoIndex(Brush.BrushSelectMode brushSelectMode)

getXAxisIndex

public Brush.IndexItem getXAxisIndex()

setXAxisIndex

public void setXAxisIndex(Integer number)

setXAxisIndex

public void setXAxisIndex(Integer... indexes)

setXAxisIndex

public void setXAxisIndex(Brush.BrushSelectMode brushSelectMode)

getYAxisIndex

public Brush.IndexItem getYAxisIndex()

setYAxisIndex

public void setYAxisIndex(Integer number)

setYAxisIndex

public void setYAxisIndex(Integer... indexes)

setYAxisIndex

public void setYAxisIndex(Brush.BrushSelectMode brushSelectMode)

getBrushType

public Brush.BrushType getBrushType()

setBrushType

public void setBrushType(Brush.BrushType brushType)

getBrushMode

public Brush.BrushMode getBrushMode()

setBrushMode

public void setBrushMode(Brush.BrushMode brushMode)

getTransformable

public Boolean getTransformable()

setTransformable

public void setTransformable(Boolean transformable)

getBrushStyle

public Brush.BrushStyle getBrushStyle()

setBrushStyle

public void setBrushStyle(Brush.BrushStyle brushStyle)

getThrottleType

public Brush.ThrottleType getThrottleType()

setThrottleType

public void setThrottleType(Brush.ThrottleType throttleType)

getThrottleDelay

public Double getThrottleDelay()

setThrottleDelay

public void setThrottleDelay(Double throttleDelay)

getRemoveOnClick

public Boolean getRemoveOnClick()

setRemoveOnClick

public void setRemoveOnClick(Boolean removeOnClick)

getInBrush

public VisualEffect getInBrush()

setInBrush

public void setInBrush(VisualEffect inBrush)

getOutOfBrush

public VisualEffect getOutOfBrush()

setOutOfBrush

public void setOutOfBrush(VisualEffect outOfBrush)

getZ

public Integer getZ()

setZ

public void setZ(Integer z)

withId

public Brush withId(String id)

withToolboxes

public Brush withToolboxes(Brush.Toolbox... toolbox)

withBrushLink

public Brush withBrushLink(Integer... seriesIndexes)

withBrushLine

public Brush withBrushLine(Brush.BrushSelectMode brushSelectMode)

withSeriesIndex

public Brush withSeriesIndex(Brush.SeriesIndex seriesIndex)

withGeoIndex

public Brush withGeoIndex(Integer number)

withGeoIndex

public Brush withGeoIndex(Integer... indexes)

withGeoIndex

public Brush withGeoIndex(Brush.BrushSelectMode brushSelectedMode)

withXAxisIndex

public Brush withXAxisIndex(Integer number)

withXAxisIndex

public Brush withXAxisIndex(Integer... indexes)

withXAxisIndex

public Brush withXAxisIndex(Brush.BrushSelectMode brushSelectedMode)

withYAxisIndex

public Brush withYAxisIndex(Integer number)

withYAxisIndex

public Brush withYAxisIndex(Integer... indexes)

withYAxisIndex

public Brush withYAxisIndex(Brush.BrushSelectMode brushSelectMode)

withBrushType

public Brush withBrushType(Brush.BrushType brushType)

withBrushMode

public Brush withBrushMode(Brush.BrushMode brushMode)

withTransformable

public Brush withTransformable(Boolean transformable)

withBrushStyle

public Brush withBrushStyle(Brush.BrushStyle brushStyle)

withThrottleType

public Brush withThrottleType(Brush.ThrottleType throttleType)

withThrottleDelay

public Brush withThrottleDelay(Double throttleDelay)

withRemoveOnClick

public Brush withRemoveOnClick(Boolean removeOnClick)

withInBrush

public Brush withInBrush(VisualEffect inBrush)

withOutOfBrush

public Brush withOutOfBrush(VisualEffect outOfBrush)

withZ

public Brush withZ(Integer z)