Class LineSeries
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<LineSeries>
io.jmix.chartsflowui.kit.component.model.series.LineSeries
- All Implemented Interfaces:
HasStack<LineSeries>
,HasSymbols<LineSeries>
,Serializable
public class LineSeries
extends AbstractAxisAwareSeries<LineSeries>
implements HasSymbols<LineSeries>, HasStack<LineSeries>
Line chart relates all the data points
Note: when
Note: with
More detailed information is provided in the documentation.
symbol
by broken lines, which is used to show
the trend of data changing. It could be used in both rectangular and polar coordinate.Note: when
areaStyle
is set, area chart will be drawn.Note: with
PiecewiseVisualMap
component, line chart / area chart can have different colors
on different sections.More detailed information is provided in the documentation.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Base component for line elements.static class
The style of area.static class
Component to configure the blur state.static class
Component to configure the emphasis state.static class
Label component on the end of line.static class
static class
Component to configure label guide line.static class
Component to configure the selection state.static enum
Type for maintaining the monotonicity on XAxis or YAxis.static enum
Type of step line.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.series.HasStack
HasStack.StackStrategy
Nested classes/interfaces inherited from interface io.jmix.chartsflowui.kit.component.model.shared.HasSymbols
HasSymbols.Symbol, HasSymbols.SymbolType
-
Field Summary
Modifier and TypeFieldDescriptionprotected Boolean
protected Integer
protected Integer
protected String
protected Integer
protected LineSeries.AreaStyle
protected LineSeries.Blur
protected Boolean
protected Boolean
protected CoordinateSystem
protected String
protected LineSeries.Emphasis
protected LineSeries.EndLabel
protected LineSeries.ItemStyle
protected LineSeries.LabelLine
protected LineStyle
protected Integer
protected SamplingType
protected LineSeries.Select
protected Boolean
protected Boolean
protected Double
protected LineSeries.SmoothMonotoneType
protected String
protected HasStack.StackStrategy
protected LineSeries.Step
protected HasSymbols.Symbol
protected Boolean
protected String[]
protected Integer
protected Integer
protected JsFunction
protected Boolean
protected Integer
protected Integer
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
-
Method Summary
Modifier and TypeMethodDescriptiongetBlur()
getClip()
getStack()
getStep()
String[]
void
setAnimation
(Boolean animation) void
setAnimationDelayUpdate
(Integer animationDelayUpdate) void
setAnimationDurationUpdate
(Integer animationDurationUpdate) void
setAnimationEasingUpdate
(String animationEasingUpdate) void
setAnimationThreshold
(Integer animationThreshold) void
setAreaStyle
(LineSeries.AreaStyle areaStyle) void
setBlur
(LineSeries.Blur blur) void
void
setConnectNulls
(Boolean connectNulls) void
setCoordinateSystem
(CoordinateSystem coordinateSystem) void
void
setEmphasis
(LineSeries.Emphasis emphasis) void
setEndLabel
(LineSeries.EndLabel endLabel) void
setItemStyle
(LineSeries.ItemStyle itemStyle) void
setLabelLine
(LineSeries.LabelLine labelLine) void
setLineStyle
(LineStyle lineStyle) void
setPolarIndex
(Integer polarIndex) void
setSampling
(SamplingType sampling) void
setSelect
(LineSeries.Select select) void
setShowAllSymbol
(Boolean showAllSymbol) void
setShowSymbol
(Boolean showSymbol) void
void
setSmoothMonotone
(LineSeries.SmoothMonotoneType smoothMonotone) void
Sets the stack name for the series or replaces an existing one.void
setStackStrategy
(HasStack.StackStrategy stackStrategy) Sets the stack strategy type or replaces an existing one for stack values if the stack name was specified.void
setStep
(LineSeries.Step step) void
setSymbol
(HasSymbols.SymbolType symbolType) Sets predefined symbol type or replaces an existing one.void
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
setTriggerLineEvent
(Boolean triggerLineEvent) void
setXAxisIndex
(Integer xAxisIndex) void
setYAxisIndex
(Integer yAxisIndex) withAnimation
(Boolean animation) withAnimationDelayUpdate
(Integer animationDelayUpdate) withAnimationDurationUpdate
(Integer animationDurationUpdate) withAnimationEasingUpdate
(String animationEasingUpdate) withAnimationThreshold
(Integer animationThreshold) withAreaStyle
(LineSeries.AreaStyle areaStyle) withBlur
(LineSeries.Blur blur) withConnectNulls
(Boolean connectNulls) withCoordinateSystem
(CoordinateSystem coordinateSystem) withCursor
(String cursor) withEmphasis
(LineSeries.Emphasis emphasis) withEndLabel
(LineSeries.EndLabel endLabel) withItemStyle
(LineSeries.ItemStyle itemStyle) withLabelLine
(LineSeries.LabelLine labelLine) withLineStyle
(LineStyle lineStyle) withPolarIndex
(Integer polarIndex) withSampling
(SamplingType sampling) withSelect
(LineSeries.Select select) withShowAllSymbol
(Boolean showAllSymbol) withShowSymbol
(Boolean showSymbol) withSmooth
(Double smooth) withSmoothMonotone
(LineSeries.SmoothMonotoneType smoothMonotone) withStep
(LineSeries.Step step) withTriggerLineEvent
(Boolean triggerLineEvent) withXAxisIndex
(Integer xAxisIndex) 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.series.HasStack
withStack, withStackStrategy
Methods inherited from interface io.jmix.chartsflowui.kit.component.model.shared.HasSymbols
withSymbol, withSymbol, withSymbolKeepAspect, withSymbolOffset, withSymbolRotate, withSymbolSize, withSymbolSizeFunction, withSymbolSizeFunction
-
Field Details
-
coordinateSystem
-
xAxisIndex
-
yAxisIndex
-
polarIndex
-
clip
-
sampling
-
stack
-
stackStrategy
-
symbol
-
symbolSize
-
symbolSizeFunction
-
symbolRotate
-
symbolKeepAspect
-
symbolOffset
-
showSymbol
-
showAllSymbol
-
endLabel
-
lineStyle
-
itemStyle
-
labelLine
-
areaStyle
-
step
-
connectNulls
-
triggerLineEvent
-
cursor
-
emphasis
-
blur
-
select
-
smooth
-
smoothMonotone
-
animation
-
animationThreshold
-
animationDurationUpdate
-
animationEasingUpdate
-
animationDelayUpdate
-
-
Constructor Details
-
LineSeries
public LineSeries()
-
-
Method Details
-
getCoordinateSystem
-
setCoordinateSystem
-
getXAxisIndex
-
setXAxisIndex
-
getYAxisIndex
-
setYAxisIndex
-
getPolarIndex
-
setPolarIndex
-
getClip
-
setClip
-
getSampling
-
setSampling
-
getStack
- Specified by:
getStack
in interfaceHasStack<LineSeries>
- Returns:
- stack name for the series
-
setStack
Description copied from interface:HasStack
Sets the stack name for the series or replaces an existing one.- Specified by:
setStack
in interfaceHasStack<LineSeries>
- Parameters:
stack
- stack name to set
-
getStackStrategy
- Specified by:
getStackStrategy
in interfaceHasStack<LineSeries>
- Returns:
- type of strategy for stacking values
-
setStackStrategy
Description copied from interface:HasStack
Sets the stack strategy type or replaces an existing one for stack values if the stack name was specified.- Specified by:
setStackStrategy
in interfaceHasStack<LineSeries>
- Parameters:
stackStrategy
- stack strategy type to set
-
getSymbol
- Specified by:
getSymbol
in interfaceHasSymbols<LineSeries>
- Returns:
- symbol
-
setSymbol
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 interfaceHasSymbols<LineSeries>
- Parameters:
icon
- symbol to set
-
-
getSymbolSize
- Specified by:
getSymbolSize
in interfaceHasSymbols<LineSeries>
- Returns:
- symbol size
-
setSymbolSize
Description copied from interface:HasSymbols
Sets a symbol size or replaces an existing one.- Specified by:
setSymbolSize
in interfaceHasSymbols<LineSeries>
- Parameters:
symbolSize
- symbol size to set
-
getSymbolSizeFunction
- Specified by:
getSymbolSizeFunction
in interfaceHasSymbols<LineSeries>
- Returns:
- callback function for symbol size
-
setSymbolSizeFunction
Description copied from interface:HasSymbols
Sets a callback function for symbol size as string or replaces an existing one.- Specified by:
setSymbolSizeFunction
in interfaceHasSymbols<LineSeries>
- Parameters:
symbolSizeFunction
- formatter function as string
-
getSymbolRotate
- Specified by:
getSymbolRotate
in interfaceHasSymbols<LineSeries>
- Returns:
- rotate degree of symbol
-
setSymbolRotate
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 interfaceHasSymbols<LineSeries>
- Parameters:
symbolRotate
- rotate symbol to set
-
getSymbolKeepAspect
- Specified by:
getSymbolKeepAspect
in interfaceHasSymbols<LineSeries>
- Returns:
true
if the aspect for symbols must be kept,false
otherwise
-
setSymbolKeepAspect
Description copied from interface:HasSymbols
Sets the keeping of aspects for a symbol.- Specified by:
setSymbolKeepAspect
in interfaceHasSymbols<LineSeries>
- Parameters:
symbolKeepAspect
- whether to keep aspect for symbols in the form ofpath://%svgPathData%
-
getSymbolOffset
- Specified by:
getSymbolOffset
in interfaceHasSymbols<LineSeries>
- Returns:
- offset of symbol relative to original position
-
setSymbolOffset
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 interfaceHasSymbols<LineSeries>
- Parameters:
xOffset
- horizontal offsetyOffset
- vertical offset
-
Pixel values:
-
getShowSymbol
-
setShowSymbol
-
getShowAllSymbol
-
setShowAllSymbol
-
getEndLabel
-
setEndLabel
-
getLineStyle
-
getItemStyle
-
setItemStyle
-
getLabelLine
-
setLabelLine
-
getAreaStyle
-
setAreaStyle
-
getStep
-
setStep
-
getConnectNulls
-
setConnectNulls
-
getTriggerLineEvent
-
setTriggerLineEvent
-
getCursor
-
setCursor
-
getEmphasis
-
setEmphasis
-
getBlur
-
setBlur
-
getSelect
-
setSelect
-
getSmooth
-
setSmooth
-
getSmoothMonotone
-
setSmoothMonotone
-
getAnimation
-
setAnimation
-
getAnimationThreshold
-
setAnimationThreshold
-
getAnimationDurationUpdate
-
setAnimationDurationUpdate
-
getAnimationEasingUpdate
-
setAnimationEasingUpdate
-
getAnimationDelayUpdate
-
setAnimationDelayUpdate
-
withCoordinateSystem
-
withXAxisIndex
-
withYAxisIndex
-
withPolarIndex
-
withClip
-
withSampling
-
withShowSymbol
-
withShowAllSymbol
-
withEndLabel
-
withItemStyle
-
withLabelLine
-
withAreaStyle
-
withStep
-
withConnectNulls
-
withTriggerLineEvent
-
withCursor
-
withEmphasis
-
withBlur
-
withSelect
-
withSmooth
-
withSmoothMonotone
-
withAnimation
-
withAnimationThreshold
-
withAnimationDurationUpdate
-
withAnimationEasingUpdate
-
withAnimationDelayUpdate
-