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

Class MarkPoint.Point

java.lang.Object

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

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

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

All Implemented Interfaces:

HasSymbols<MarkPoint.Point>, Serializable

Enclosing class:

MarkPoint

public static class MarkPoint.Point
extends AbstractMarkElement<MarkPoint.Point>
implements HasSymbols<MarkPoint.Point>

Point to display.

See Also:

• Serialized Form

Nested Class Summary

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 Coordinate	coordinate
protected MarkPoint.Emphasis	emphasis
protected String	name
protected HasSymbols.Symbol	symbol
protected Boolean	symbolKeepAspect
protected String[]	symbolOffset
protected Integer	symbolRotate
protected Integer	symbolSize
protected JsFunction	symbolSizeFunction
protected PointDataType	type
protected String	valueDim
protected Integer	valueIndex
protected String	x
protected String	y

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

itemStyle, label

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

children, dirty, listener

Constructor Summary

Constructors

Constructor	Description
Point()

Method Summary

Modifier and Type	Method	Description
Coordinate	getCoordinate()
MarkPoint.Emphasis	getEmphasis()
String	getName()
HasSymbols.Symbol	getSymbol()
Boolean	getSymbolKeepAspect()
String[]	getSymbolOffset()
Integer	getSymbolRotate()
Integer	getSymbolSize()
JsFunction	getSymbolSizeFunction()
PointDataType	getType()
String	getValueDim()
Integer	getValueIndex()
String	getX()
String	getY()
void	setCoordinate(Double... coordinate)
void	setCoordinate(String... coordinate)
void	setEmphasis(MarkPoint.Emphasis emphasis)
void	setName(String name)
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	setType(PointDataType type)
void	setValueDim(String valueDim)
void	setValueIndex(Integer valueIndex)
void	setX(String x)
void	setY(String y)
MarkPoint.Point	withCoordinate(Double... coordinate)
MarkPoint.Point	withCoordinate(String... coordinate)
MarkPoint.Point	withEmphasis(MarkPoint.Emphasis emphasis)
MarkPoint.Point	withName(String name)
MarkPoint.Point	withType(PointDataType type)
MarkPoint.Point	withValueDim(String valueDim)
MarkPoint.Point	withValueIndex(Integer valueIndex)
MarkPoint.Point	withX(String x)
MarkPoint.Point	withY(String y)

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

getItemStyle, getLabel, setItemStyle, setLabel, withItemStyle, withLabel

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

name

protected String name

type

protected PointDataType type

valueIndex

protected Integer valueIndex

valueDim

protected String valueDim

coordinate

protected Coordinate coordinate

x

protected String x

y

protected String y

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

emphasis

protected MarkPoint.Emphasis emphasis

Constructor Details

Point

public Point()

Method Details

getName

public String getName()

setName

public void setName(String name)

getType

public PointDataType getType()

setType

public void setType(PointDataType type)

getValueIndex

public Integer getValueIndex()

setValueIndex

public void setValueIndex(Integer valueIndex)

getValueDim

public String getValueDim()

setValueDim

public void setValueDim(String valueDim)

getCoordinate

public Coordinate getCoordinate()

setCoordinate

public void setCoordinate(Double... coordinate)

setCoordinate

public void setCoordinate(String... coordinate)

getX

public String getX()

setX

public void setX(String x)

getY

public String getY()

setY

public void setY(String y)

getSymbol

public HasSymbols.Symbol getSymbol()

Specified by:

getSymbol in interface HasSymbols<MarkPoint.Point>

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

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

Parameters:

symbolType - symbol to set

getSymbolSize

public Integer getSymbolSize()

Specified by:

getSymbolSize in interface HasSymbols<MarkPoint.Point>

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

Parameters:

symbolSize - symbol size to set

getSymbolSizeFunction

public JsFunction getSymbolSizeFunction()

Specified by:

getSymbolSizeFunction in interface HasSymbols<MarkPoint.Point>

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

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

Parameters:

symbolSizeFunction - formatter function as string

getSymbolRotate

public Integer getSymbolRotate()

Specified by:

getSymbolRotate in interface HasSymbols<MarkPoint.Point>

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

Parameters:

symbolRotate - rotate symbol to set

getSymbolKeepAspect

public Boolean getSymbolKeepAspect()

Specified by:

getSymbolKeepAspect in interface HasSymbols<MarkPoint.Point>

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

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

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

Parameters:

xOffset - horizontal offset

yOffset - vertical offset

getEmphasis

public MarkPoint.Emphasis getEmphasis()

setEmphasis

public void setEmphasis(MarkPoint.Emphasis emphasis)

withName

public MarkPoint.Point withName(String name)

withType

public MarkPoint.Point withType(PointDataType type)

withValueIndex

public MarkPoint.Point withValueIndex(Integer valueIndex)

withValueDim

public MarkPoint.Point withValueDim(String valueDim)

withCoordinate

public MarkPoint.Point withCoordinate(String... coordinate)

withCoordinate

public MarkPoint.Point withCoordinate(Double... coordinate)

withX

public MarkPoint.Point withX(String x)

withY

public MarkPoint.Point withY(String y)

withEmphasis

public MarkPoint.Point withEmphasis(MarkPoint.Emphasis emphasis)