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

Class EffectScatterSeries

java.lang.Object

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

io.jmix.chartsflowui.kit.component.model.series.AbstractSeries<T>

io.jmix.chartsflowui.kit.component.model.series.AbstractAxisAwareSeries<EffectScatterSeries>

io.jmix.chartsflowui.kit.component.model.series.EffectScatterSeries

All Implemented Interfaces:

HasSymbols<EffectScatterSeries>, Serializable

public class EffectScatterSeries
extends AbstractAxisAwareSeries<EffectScatterSeries>
implements HasSymbols<EffectScatterSeries>

The scatter (bubble) graph with ripple animation. The special animation effect can visually highlight some data. More detailed information is provided in the documentation.

See Also:

• ScatterSeries
• EffectScatterSeries documentation
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EffectScatterSeries.AbstractEffectScatterElement<T extends EffectScatterSeries.AbstractEffectScatterElement<T>>	Base component for effect scatter elements.
static class	EffectScatterSeries.Blur	Component to configure the blur state.
static enum	EffectScatterSeries.EffectOn	Enum of when to show the effect.
static class	EffectScatterSeries.Emphasis	Component to configure the emphasis state.
static class	EffectScatterSeries.LabelLine	Configuration of label guideline.
static class	EffectScatterSeries.RippleEffect	Related configurations component about ripple effect.
static class	EffectScatterSeries.Select	Component to configure the selection state.

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

AbstractAxisAwareSeries.SeriesLayoutType

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

AbstractSeries.LabelLayout, AbstractSeries.Tooltip

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.shared.HasSymbols

HasSymbols.Symbol, HasSymbols.SymbolType

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	animation
protected Integer	animationDelayUpdate
protected Integer	animationDurationUpdate
protected String	animationEasingUpdate
protected Integer	animationThreshold
protected EffectScatterSeries.Blur	blur
protected Integer	calendarIndex
protected Boolean	clip
protected CoordinateSystem	coordinateSystem
protected String	cursor
protected String	effectType
protected EffectScatterSeries.Emphasis	emphasis
protected Integer	geoIndex
protected ItemStyle	itemStyle
protected EffectScatterSeries.LabelLine	labelLine
protected Integer	polarIndex
protected EffectScatterSeries.RippleEffect	rippleEffect
protected EffectScatterSeries.Select	select
protected EffectScatterSeries.EffectOn	showEffectOn
protected HasSymbols.Symbol	symbol
protected Boolean	symbolKeepAspect
protected String[]	symbolOffset
protected Integer	symbolRotate
protected Integer	symbolSize
protected JsFunction	symbolSizeFunction
protected Integer	xAxisIndex
protected Integer	yAxisIndex

Fields inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractAxisAwareSeries

datasetIndex, encode, legendHoverLink, markArea, markLine, markPoint, seriesLayoutBy

Fields inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractSeries

animationDelay, animationDuration, animationEasing, colorBy, dataGroupId, id, label, labelLayout, name, selectedMode, silent, tooltip, type, z, zLevel

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

children, dirty, listener

Constructor Summary

Constructors

Constructor	Description
EffectScatterSeries()

Method Summary

Modifier and Type	Method	Description
Boolean	getAnimation()
Integer	getAnimationDelayUpdate()
Integer	getAnimationDurationUpdate()
String	getAnimationEasingUpdate()
Integer	getAnimationThreshold()
EffectScatterSeries.Blur	getBlur()
Integer	getCalendarIndex()
Boolean	getClip()
CoordinateSystem	getCoordinateSystem()
String	getCursor()
String	getEffectType()
EffectScatterSeries.Emphasis	getEmphasis()
Integer	getGeoIndex()
ItemStyle	getItemStyle()
EffectScatterSeries.LabelLine	getLabelLine()
Integer	getPolarIndex()
EffectScatterSeries.RippleEffect	getRippleEffect()
EffectScatterSeries.Select	getSelect()
EffectScatterSeries.EffectOn	getShowEffectOn()
HasSymbols.Symbol	getSymbol()
Boolean	getSymbolKeepAspect()
String[]	getSymbolOffset()
Integer	getSymbolRotate()
Integer	getSymbolSize()
JsFunction	getSymbolSizeFunction()
Integer	getXAxisIndex()
Integer	getYAxisIndex()
void	setAnimation(Boolean animation)
void	setAnimationDelayUpdate(Integer animationDelayUpdate)
void	setAnimationDurationUpdate(Integer animationDurationUpdate)
void	setAnimationEasingUpdate(String animationEasingUpdate)
void	setAnimationThreshold(Integer animationThreshold)
void	setBlur(EffectScatterSeries.Blur blur)
void	setCalendarIndex(Integer calendarIndex)
void	setClip(Boolean clip)
void	setCoordinateSystem(CoordinateSystem coordinateSystem)
void	setCursor(String cursor)
void	setEffectType(String effectType)
void	setEmphasis(EffectScatterSeries.Emphasis emphasis)
void	setGeoIndex(Integer geoIndex)
void	setItemStyle(ItemStyle itemStyle)
void	setLabelLine(EffectScatterSeries.LabelLine labelLine)
void	setPolarIndex(Integer polarIndex)
void	setRippleEffect(EffectScatterSeries.RippleEffect rippleEffect)
void	setSelect(EffectScatterSeries.Select select)
void	setShowEffectOn(EffectScatterSeries.EffectOn showEffectOn)
void	setSymbol(HasSymbols.SymbolType symbolType)	Sets predefined symbol type or replaces an existing one.
void	setSymbol(String icon)	Sets a symbol or replaces an existing one. Possible values: image://%url%, example: image://http://example.website/a/b.png image://%dataURI%, example: image://data:image/gif;base64,... path://%svgPathData%, example: path://M30.9,53.2c16...
void	setSymbolKeepAspect(Boolean symbolKeepAspect)	Sets the keeping of aspects for a symbol.
void	setSymbolOffset(String xOffset, String yOffset)	Sets an offset of symbol relative to original position or replaces an existing one. Possible values: Pixel values: hasSymbols.setSymbolOffset("10", "10");.
void	setSymbolRotate(Integer symbolRotate)	Sets a rotate degree of symbol or replaces an existing one.
void	setSymbolSize(Integer symbolSize)	Sets a symbol size or replaces an existing one.
void	setSymbolSizeFunction(JsFunction symbolSizeFunction)	Sets a callback function for symbol size or replaces an existing one.
void	setSymbolSizeFunction(String symbolSizeFunction)	Sets a callback function for symbol size as string or replaces an existing one.
void	setXAxisIndex(Integer xAxisIndex)
void	setYAxisIndex(Integer yAxisIndex)
EffectScatterSeries	withAnimation(Boolean animation)
EffectScatterSeries	withAnimationDelayUpdate(Integer animationDelayUpdate)
EffectScatterSeries	withAnimationDurationUpdate(Integer animationDurationUpdate)
EffectScatterSeries	withAnimationEasingUpdate(String animationEasingUpdate)
EffectScatterSeries	withAnimationThreshold(Integer animationThreshold)
EffectScatterSeries	withBlur(EffectScatterSeries.Blur blur)
EffectScatterSeries	withCalendarIndex(Integer calendarIndex)
EffectScatterSeries	withClip(Boolean clip)
EffectScatterSeries	withCoordinateSystem(CoordinateSystem coordinateSystem)
EffectScatterSeries	withCursor(String cursor)
EffectScatterSeries	withEffectType(String effectType)
EffectScatterSeries	withEmphasis(EffectScatterSeries.Emphasis emphasis)
EffectScatterSeries	withGeoIndex(Integer geoIndex)
EffectScatterSeries	withItemStyle(ItemStyle itemStyle)
EffectScatterSeries	withLabelLine(EffectScatterSeries.LabelLine labelLine)
EffectScatterSeries	withPolarIndex(Integer polarIndex)
EffectScatterSeries	withRippleEffect(EffectScatterSeries.RippleEffect rippleEffect)
EffectScatterSeries	withSelect(EffectScatterSeries.Select select)
EffectScatterSeries	withShowEffectOn(EffectScatterSeries.EffectOn showEffectOn)
EffectScatterSeries	withXAxisIndex(Integer xAxisIndex)
EffectScatterSeries	withYAxisIndex(Integer yAxisIndex)

Methods inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractAxisAwareSeries

getDatasetIndex, getEncode, getLegendHoverLink, getMarkArea, getMarkLine, getMarkPoint, getSeriesLayoutBy, setDatasetIndex, setEncode, setLegendHoverLink, setMarkArea, setMarkLine, setMarkPoint, setSeriesLayoutBy, withDatasetIndex, withEncode, withLegendHoverLink, withMarkArea, withMarkLine, withMarkPoint, withSeriesLayoutBy

Methods inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractSeries

getAnimationDelay, getAnimationDuration, getAnimationEasing, getColorBy, getDataGroupId, getId, getLabel, getLabelLayout, getName, getSelectedMode, getSilent, getTooltip, getType, getZ, getZLevel, setAnimationDelay, setAnimationDuration, setAnimationEasing, setColorBy, setDataGroupId, setId, setLabel, setLabelLayout, setName, setSelectedMode, setSilent, setTooltip, setType, setZ, setZLevel, withAnimationDelay, withAnimationDuration, withAnimationEasing, withColorBy, withDataGroupId, withId, withLabel, withLabelLayout, withName, withSelectedMode, withSilent, withTooltip, 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.shared.HasSymbols

withSymbol, withSymbol, withSymbolKeepAspect, withSymbolOffset, withSymbolRotate, withSymbolSize, withSymbolSizeFunction, withSymbolSizeFunction

Field Details

coordinateSystem

protected CoordinateSystem coordinateSystem

effectType

protected String effectType

showEffectOn

protected EffectScatterSeries.EffectOn showEffectOn

rippleEffect

protected EffectScatterSeries.RippleEffect rippleEffect

xAxisIndex

protected Integer xAxisIndex

yAxisIndex

protected Integer yAxisIndex

polarIndex

protected Integer polarIndex

geoIndex

protected Integer geoIndex

calendarIndex

protected Integer calendarIndex

clip

protected Boolean clip

cursor

protected String cursor

symbol

protected HasSymbols.Symbol symbol

symbolSize

protected Integer symbolSize

symbolSizeFunction

protected JsFunction symbolSizeFunction

symbolRotate

protected Integer symbolRotate

symbolKeepAspect

protected Boolean symbolKeepAspect

symbolOffset

protected String[] symbolOffset

labelLine

protected EffectScatterSeries.LabelLine labelLine

itemStyle

protected ItemStyle itemStyle

emphasis

protected EffectScatterSeries.Emphasis emphasis

blur

protected EffectScatterSeries.Blur blur

select

protected EffectScatterSeries.Select select

animation

protected Boolean animation

animationThreshold

protected Integer animationThreshold

animationDurationUpdate

protected Integer animationDurationUpdate

animationEasingUpdate

protected String animationEasingUpdate

animationDelayUpdate

protected Integer animationDelayUpdate

Constructor Details

EffectScatterSeries

public EffectScatterSeries()

Method Details

getCoordinateSystem

public CoordinateSystem getCoordinateSystem()

setCoordinateSystem

public void setCoordinateSystem(CoordinateSystem coordinateSystem)

getEffectType

public String getEffectType()

setEffectType

public void setEffectType(String effectType)

getShowEffectOn

public EffectScatterSeries.EffectOn getShowEffectOn()

setShowEffectOn

public void setShowEffectOn(EffectScatterSeries.EffectOn showEffectOn)

getRippleEffect

public EffectScatterSeries.RippleEffect getRippleEffect()

setRippleEffect

public void setRippleEffect(EffectScatterSeries.RippleEffect rippleEffect)

getXAxisIndex

public Integer getXAxisIndex()

setXAxisIndex

public void setXAxisIndex(Integer xAxisIndex)

getYAxisIndex

public Integer getYAxisIndex()

setYAxisIndex

public void setYAxisIndex(Integer yAxisIndex)

getPolarIndex

public Integer getPolarIndex()

setPolarIndex

public void setPolarIndex(Integer polarIndex)

getGeoIndex

public Integer getGeoIndex()

setGeoIndex

public void setGeoIndex(Integer geoIndex)

getCalendarIndex

public Integer getCalendarIndex()

setCalendarIndex

public void setCalendarIndex(Integer calendarIndex)

getClip

public Boolean getClip()

setClip

public void setClip(Boolean clip)

getCursor

public String getCursor()

setCursor

public void setCursor(String cursor)

getSymbol

public HasSymbols.Symbol getSymbol()

Specified by:

getSymbol in interface HasSymbols<EffectScatterSeries>

Returns:

symbol

setSymbol

public void setSymbol(HasSymbols.SymbolType symbolType)

Description copied from interface: HasSymbols

Sets predefined symbol type or replaces an existing one.

Specified by:

setSymbol in interface HasSymbols<EffectScatterSeries>

Parameters:

symbolType - symbol to set

setSymbol

public void setSymbol(String icon)

Description copied from interface: HasSymbols

Sets a symbol or replaces an existing one.
Possible values:

• image://%url%, example: image://http://example.website/a/b.png
• image://%dataURI%, example: image://data:image/gif;base64,...
• path://%svgPathData%, example: path://M30.9,53.2c16...

Specified by:

setSymbol in interface HasSymbols<EffectScatterSeries>

Parameters:

icon - symbol to set

getSymbolSize

public Integer getSymbolSize()

Specified by:

getSymbolSize in interface HasSymbols<EffectScatterSeries>

Returns:

symbol size

setSymbolSize

public void setSymbolSize(Integer symbolSize)

Description copied from interface: HasSymbols

Sets a symbol size or replaces an existing one.

Specified by:

setSymbolSize in interface HasSymbols<EffectScatterSeries>

Parameters:

symbolSize - symbol size to set

getSymbolSizeFunction

public JsFunction getSymbolSizeFunction()

Specified by:

getSymbolSizeFunction in interface HasSymbols<EffectScatterSeries>

Returns:

callback function for symbol size

setSymbolSizeFunction

public void setSymbolSizeFunction(JsFunction symbolSizeFunction)

Description copied from interface: HasSymbols

Sets a callback function for symbol size or replaces an existing one.

Specified by:

setSymbolSizeFunction in interface HasSymbols<EffectScatterSeries>

Parameters:

symbolSizeFunction - symbol size callback function

setSymbolSizeFunction

public void setSymbolSizeFunction(String symbolSizeFunction)

Description copied from interface: HasSymbols

Sets a callback function for symbol size as string or replaces an existing one.

Specified by:

setSymbolSizeFunction in interface HasSymbols<EffectScatterSeries>

Parameters:

symbolSizeFunction - formatter function as string

getSymbolRotate

public Integer getSymbolRotate()

Specified by:

getSymbolRotate in interface HasSymbols<EffectScatterSeries>

Returns:

rotate degree of symbol

setSymbolRotate

public void setSymbolRotate(Integer symbolRotate)

Description copied from interface: HasSymbols

Sets a rotate degree of symbol or replaces an existing one. The negative value represents clockwise.

Specified by:

setSymbolRotate in interface HasSymbols<EffectScatterSeries>

Parameters:

symbolRotate - rotate symbol to set

getSymbolKeepAspect

public Boolean getSymbolKeepAspect()

Specified by:

getSymbolKeepAspect in interface HasSymbols<EffectScatterSeries>

Returns:

true if the aspect for symbols must be kept, false otherwise

setSymbolKeepAspect

public void setSymbolKeepAspect(Boolean symbolKeepAspect)

Description copied from interface: HasSymbols

Sets the keeping of aspects for a symbol.

Specified by:

setSymbolKeepAspect in interface HasSymbols<EffectScatterSeries>

Parameters:

symbolKeepAspect - whether to keep aspect for symbols in the form of path://%svgPathData%

getSymbolOffset

public String[] getSymbolOffset()

Specified by:

getSymbolOffset in interface HasSymbols<EffectScatterSeries>

Returns:

offset of symbol relative to original position

setSymbolOffset

public void setSymbolOffset(String xOffset,
 String yOffset)

Description copied from interface: HasSymbols

Sets an offset of symbol relative to original position or replaces an existing one.
Possible values:

• Pixel values: hasSymbols.setSymbolOffset("10", "10");.
• Percentage values: hasSymbols.setSymbolOffset("50%", "45%");.
• Pixel and percentage values combination: hasSymbols.setSymbolOffset("5", "50%");.

Specified by:

setSymbolOffset in interface HasSymbols<EffectScatterSeries>

Parameters:

xOffset - horizontal offset

yOffset - vertical offset

getLabelLine

public EffectScatterSeries.LabelLine getLabelLine()

setLabelLine

public void setLabelLine(EffectScatterSeries.LabelLine labelLine)

getItemStyle

public ItemStyle getItemStyle()

setItemStyle

public void setItemStyle(ItemStyle itemStyle)

getEmphasis

public EffectScatterSeries.Emphasis getEmphasis()

setEmphasis

public void setEmphasis(EffectScatterSeries.Emphasis emphasis)

getBlur

public EffectScatterSeries.Blur getBlur()

setBlur

public void setBlur(EffectScatterSeries.Blur blur)

getSelect

public EffectScatterSeries.Select getSelect()

setSelect

public void setSelect(EffectScatterSeries.Select select)

getAnimation

public Boolean getAnimation()

setAnimation

public void setAnimation(Boolean animation)

getAnimationThreshold

public Integer getAnimationThreshold()

setAnimationThreshold

public void setAnimationThreshold(Integer animationThreshold)

getAnimationDurationUpdate

public Integer getAnimationDurationUpdate()

setAnimationDurationUpdate

public void setAnimationDurationUpdate(Integer animationDurationUpdate)

getAnimationEasingUpdate

public String getAnimationEasingUpdate()

setAnimationEasingUpdate

public void setAnimationEasingUpdate(String animationEasingUpdate)

getAnimationDelayUpdate

public Integer getAnimationDelayUpdate()

setAnimationDelayUpdate

public void setAnimationDelayUpdate(Integer animationDelayUpdate)

withCoordinateSystem

public EffectScatterSeries withCoordinateSystem(CoordinateSystem coordinateSystem)

withEffectType

public EffectScatterSeries withEffectType(String effectType)

withShowEffectOn

public EffectScatterSeries withShowEffectOn(EffectScatterSeries.EffectOn showEffectOn)

withRippleEffect

public EffectScatterSeries withRippleEffect(EffectScatterSeries.RippleEffect rippleEffect)

withXAxisIndex

public EffectScatterSeries withXAxisIndex(Integer xAxisIndex)

withYAxisIndex

public EffectScatterSeries withYAxisIndex(Integer yAxisIndex)

withPolarIndex

public EffectScatterSeries withPolarIndex(Integer polarIndex)

withGeoIndex

public EffectScatterSeries withGeoIndex(Integer geoIndex)

withCalendarIndex

public EffectScatterSeries withCalendarIndex(Integer calendarIndex)

withClip

public EffectScatterSeries withClip(Boolean clip)

withCursor

public EffectScatterSeries withCursor(String cursor)

withLabelLine

public EffectScatterSeries withLabelLine(EffectScatterSeries.LabelLine labelLine)

withItemStyle

public EffectScatterSeries withItemStyle(ItemStyle itemStyle)

withEmphasis

public EffectScatterSeries withEmphasis(EffectScatterSeries.Emphasis emphasis)

withBlur

public EffectScatterSeries withBlur(EffectScatterSeries.Blur blur)

withSelect

public EffectScatterSeries withSelect(EffectScatterSeries.Select select)

withAnimation

public EffectScatterSeries withAnimation(Boolean animation)

withAnimationThreshold

public EffectScatterSeries withAnimationThreshold(Integer animationThreshold)

withAnimationDurationUpdate

public EffectScatterSeries withAnimationDurationUpdate(Integer animationDurationUpdate)

withAnimationEasingUpdate

public EffectScatterSeries withAnimationEasingUpdate(String animationEasingUpdate)

withAnimationDelayUpdate

public EffectScatterSeries withAnimationDelayUpdate(Integer animationDelayUpdate)