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

Class MarkPoint

java.lang.Object

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

io.jmix.chartsflowui.kit.component.model.series.mark.AbstractMark<MarkPoint>

io.jmix.chartsflowui.kit.component.model.series.mark.MarkPoint

All Implemented Interfaces:

HasSymbols<MarkPoint>, Serializable

public class MarkPoint
extends AbstractMark<MarkPoint>
implements HasSymbols<MarkPoint>

Mark point in a chart. Used to mark any single values on the graph. More detailed information is provided in the documentation.

See Also:

• MarkPoint documentation
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MarkPoint.Blur	Component to configure the blur state.
static class	MarkPoint.Emphasis	Component to configure the emphasis state.
static class	MarkPoint.Point	Point to display.

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 MarkPoint.Blur	blur
protected List<MarkPoint.Point>	data
protected MarkPoint.Emphasis	emphasis
protected ItemStyle	itemStyle
protected HasSymbols.Symbol	symbol
protected Boolean	symbolKeepAspect
protected String[]	symbolOffset
protected Integer	symbolRotate
protected Integer	symbolSize
protected JsFunction	symbolSizeFunction

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

animation, animationDelay, animationDelayUpdate, animationDuration, animationDurationUpdate, animationEasing, animationEasingUpdate, animationThreshold, label, silent

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

children, dirty, listener

Constructor Summary

Constructors

Constructor	Description
MarkPoint()

Method Summary

Modifier and Type	Method	Description
void	addData(MarkPoint.Point point)
MarkPoint.Blur	getBlur()
List<MarkPoint.Point>	getData()
MarkPoint.Emphasis	getEmphasis()
ItemStyle	getItemStyle()
HasSymbols.Symbol	getSymbol()
Boolean	getSymbolKeepAspect()
String[]	getSymbolOffset()
Integer	getSymbolRotate()
Integer	getSymbolSize()
JsFunction	getSymbolSizeFunction()
void	removeData(MarkPoint.Point point)
void	setBlur(MarkPoint.Blur blur)
void	setData(MarkPoint.Point... data)
void	setData(List<MarkPoint.Point> data)
void	setEmphasis(MarkPoint.Emphasis emphasis)
void	setItemStyle(ItemStyle itemStyle)
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.
MarkPoint	withBlur(MarkPoint.Blur blur)
MarkPoint	withData(MarkPoint.Point point)
MarkPoint	withData(MarkPoint.Point... data)
MarkPoint	withEmphasis(MarkPoint.Emphasis emphasis)
MarkPoint	withItemStyle(ItemStyle itemStyle)

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

getAnimation, getAnimationDelay, getAnimationDelayUpdate, getAnimationDuration, getAnimationDurationUpdate, getAnimationEasing, getAnimationEasingUpdate, getAnimationThreshold, getLabel, getSilent, setAnimation, setAnimationDelay, setAnimationDelayUpdate, setAnimationDuration, setAnimationDurationUpdate, setAnimationEasing, setAnimationEasingUpdate, setAnimationThreshold, setLabel, setSilent, withAnimation, withAnimationDelay, withAnimationDelayUpdate, withAnimationDuration, withAnimationDurationUpdate, withAnimationEasing, withAnimationEasingUpdate, withAnimationThreshold, withLabel, withSilent

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

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

itemStyle

protected ItemStyle itemStyle

emphasis

protected MarkPoint.Emphasis emphasis

blur

protected MarkPoint.Blur blur

data

protected List<MarkPoint.Point> data

Constructor Details

MarkPoint

public MarkPoint()

Method Details

getSymbol

public HasSymbols.Symbol getSymbol()

Specified by:

getSymbol in interface HasSymbols<MarkPoint>

Returns:

symbol

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<MarkPoint>

Parameters:

icon - symbol to set

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<MarkPoint>

Parameters:

symbolType - symbol to set

getSymbolSize

public Integer getSymbolSize()

Specified by:

getSymbolSize in interface HasSymbols<MarkPoint>

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<MarkPoint>

Parameters:

symbolSize - symbol size to set

getSymbolSizeFunction

public JsFunction getSymbolSizeFunction()

Specified by:

getSymbolSizeFunction in interface HasSymbols<MarkPoint>

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<MarkPoint>

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<MarkPoint>

Parameters:

symbolSizeFunction - formatter function as string

getSymbolRotate

public Integer getSymbolRotate()

Specified by:

getSymbolRotate in interface HasSymbols<MarkPoint>

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<MarkPoint>

Parameters:

symbolRotate - rotate symbol to set

getSymbolKeepAspect

public Boolean getSymbolKeepAspect()

Specified by:

getSymbolKeepAspect in interface HasSymbols<MarkPoint>

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<MarkPoint>

Parameters:

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

getSymbolOffset

public String[] getSymbolOffset()

Specified by:

getSymbolOffset in interface HasSymbols<MarkPoint>

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<MarkPoint>

Parameters:

xOffset - horizontal offset

yOffset - vertical offset

getItemStyle

public ItemStyle getItemStyle()

setItemStyle

public void setItemStyle(ItemStyle itemStyle)

getEmphasis

public MarkPoint.Emphasis getEmphasis()

setEmphasis

public void setEmphasis(MarkPoint.Emphasis emphasis)

getBlur

public MarkPoint.Blur getBlur()

setBlur

public void setBlur(MarkPoint.Blur blur)

getData

public List<MarkPoint.Point> getData()

setData

public void setData(List<MarkPoint.Point> data)

setData

public void setData(MarkPoint.Point... data)

removeData

public void removeData(MarkPoint.Point point)

addData

public void addData(MarkPoint.Point point)

withItemStyle

public MarkPoint withItemStyle(ItemStyle itemStyle)

withEmphasis

public MarkPoint withEmphasis(MarkPoint.Emphasis emphasis)

withBlur

public MarkPoint withBlur(MarkPoint.Blur blur)

withData

public MarkPoint withData(MarkPoint.Point... data)

withData

public MarkPoint withData(MarkPoint.Point point)