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
Nested ClassesModifier and TypeClassDescriptionstatic classBase component for line elements.static classThe style of area.static classComponent to configure the blur state.static classComponent to configure the emphasis state.static classLabel component on the end of line.static classstatic classComponent to configure label guide line.static classComponent to configure the selection state.static enumType for maintaining the monotonicity on XAxis or YAxis.static enumType of step line.Nested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractAxisAwareSeries
AbstractAxisAwareSeries.SeriesLayoutTypeNested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractSeries
AbstractSeries.LabelLayout, AbstractSeries.TooltipNested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject
ChartObservableObject.ObjectChangeEventNested classes/interfaces inherited from interface io.jmix.chartsflowui.kit.component.model.series.HasStack
HasStack.StackStrategyNested classes/interfaces inherited from interface io.jmix.chartsflowui.kit.component.model.shared.HasSymbols
HasSymbols.Symbol, HasSymbols.SymbolType -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected Booleanprotected Integerprotected Integerprotected Stringprotected Integerprotected LineSeries.AreaStyleprotected LineSeries.Blurprotected Booleanprotected Booleanprotected CoordinateSystemprotected Stringprotected LineSeries.Emphasisprotected LineSeries.EndLabelprotected LineSeries.ItemStyleprotected LineSeries.LabelLineprotected LineStyleprotected Integerprotected SamplingTypeprotected LineSeries.Selectprotected Booleanprotected Booleanprotected Doubleprotected LineSeries.SmoothMonotoneTypeprotected Stringprotected HasStack.StackStrategyprotected LineSeries.Stepprotected HasSymbols.Symbolprotected Booleanprotected String[]protected Integerprotected Integerprotected JsFunctionprotected Booleanprotected Integerprotected IntegerFields inherited from class io.jmix.chartsflowui.kit.component.model.series.AbstractAxisAwareSeries
datasetIndex, encode, legendHoverLink, markArea, markLine, markPoint, seriesLayoutByFields 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, zLevelFields inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject
children, dirty, listener -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetBlur()getClip()getStack()getStep()String[]voidsetAnimation(Boolean animation) voidsetAnimationDelayUpdate(Integer animationDelayUpdate) voidsetAnimationDurationUpdate(Integer animationDurationUpdate) voidsetAnimationEasingUpdate(String animationEasingUpdate) voidsetAnimationThreshold(Integer animationThreshold) voidsetAreaStyle(LineSeries.AreaStyle areaStyle) voidsetBlur(LineSeries.Blur blur) voidvoidsetConnectNulls(Boolean connectNulls) voidsetCoordinateSystem(CoordinateSystem coordinateSystem) voidvoidsetEmphasis(LineSeries.Emphasis emphasis) voidsetEndLabel(LineSeries.EndLabel endLabel) voidsetItemStyle(LineSeries.ItemStyle itemStyle) voidsetLabelLine(LineSeries.LabelLine labelLine) voidsetLineStyle(LineStyle lineStyle) voidsetPolarIndex(Integer polarIndex) voidsetSampling(SamplingType sampling) voidsetSelect(LineSeries.Select select) voidsetShowAllSymbol(Boolean showAllSymbol) voidsetShowSymbol(Boolean showSymbol) voidvoidsetSmoothMonotone(LineSeries.SmoothMonotoneType smoothMonotone) voidSets the stack name for the series or replaces an existing one.voidsetStackStrategy(HasStack.StackStrategy stackStrategy) Sets the stack strategy type or replaces an existing one for stack values if the stack name was specified.voidsetStep(LineSeries.Step step) voidsetSymbol(HasSymbols.SymbolType symbolType) Sets predefined symbol type or replaces an existing one.voidSets a symbol or replaces an existing one.
Possible values:image://%url%, example:image://http://example.website/a/b.pngimage://%dataURI%, example:image://data:image/gif;base64,...path://%svgPathData%, example:path://M30.9,53.2c16...voidsetSymbolKeepAspect(Boolean symbolKeepAspect) Sets the keeping of aspects for a symbol.voidsetSymbolOffset(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");.voidsetSymbolRotate(Integer symbolRotate) Sets a rotate degree of symbol or replaces an existing one.voidsetSymbolSize(Integer symbolSize) Sets a symbol size or replaces an existing one.voidsetSymbolSizeFunction(JsFunction symbolSizeFunction) Sets a callback function for symbol size or replaces an existing one.voidsetSymbolSizeFunction(String symbolSizeFunction) Sets a callback function for symbol size as string or replaces an existing one.voidsetTriggerLineEvent(Boolean triggerLineEvent) voidsetXAxisIndex(Integer xAxisIndex) voidsetYAxisIndex(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, withSeriesLayoutByMethods 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, withZLevelMethods inherited from class io.jmix.chartsflowui.kit.component.model.ChartObservableObject
addChild, fireChangeEvent, getChildren, isDirty, isDirtyInDepth, markAsDirty, markAsDirtyInDepth, removeChild, setChartObjectChangeListener, unmarkDirtyInDepthMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface io.jmix.chartsflowui.kit.component.model.series.HasStack
withStack, withStackStrategyMethods 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:
getStackin interfaceHasStack<LineSeries>- Returns:
- stack name for the series
-
setStack
Description copied from interface:HasStackSets the stack name for the series or replaces an existing one.- Specified by:
setStackin interfaceHasStack<LineSeries>- Parameters:
stack- stack name to set
-
getStackStrategy
- Specified by:
getStackStrategyin interfaceHasStack<LineSeries>- Returns:
- type of strategy for stacking values
-
setStackStrategy
Description copied from interface:HasStackSets the stack strategy type or replaces an existing one for stack values if the stack name was specified.- Specified by:
setStackStrategyin interfaceHasStack<LineSeries>- Parameters:
stackStrategy- stack strategy type to set
-
getSymbol
- Specified by:
getSymbolin interfaceHasSymbols<LineSeries>- Returns:
- symbol
-
setSymbol
Description copied from interface:HasSymbolsSets 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:
setSymbolin interfaceHasSymbols<LineSeries>- Parameters:
icon- symbol to set
-
-
getSymbolSize
- Specified by:
getSymbolSizein interfaceHasSymbols<LineSeries>- Returns:
- symbol size
-
setSymbolSize
Description copied from interface:HasSymbolsSets a symbol size or replaces an existing one.- Specified by:
setSymbolSizein interfaceHasSymbols<LineSeries>- Parameters:
symbolSize- symbol size to set
-
getSymbolSizeFunction
- Specified by:
getSymbolSizeFunctionin interfaceHasSymbols<LineSeries>- Returns:
- callback function for symbol size
-
setSymbolSizeFunction
Description copied from interface:HasSymbolsSets a callback function for symbol size as string or replaces an existing one.- Specified by:
setSymbolSizeFunctionin interfaceHasSymbols<LineSeries>- Parameters:
symbolSizeFunction- formatter function as string
-
getSymbolRotate
- Specified by:
getSymbolRotatein interfaceHasSymbols<LineSeries>- Returns:
- rotate degree of symbol
-
setSymbolRotate
Description copied from interface:HasSymbolsSets a rotate degree of symbol or replaces an existing one. The negative value represents clockwise.- Specified by:
setSymbolRotatein interfaceHasSymbols<LineSeries>- Parameters:
symbolRotate- rotate symbol to set
-
getSymbolKeepAspect
- Specified by:
getSymbolKeepAspectin interfaceHasSymbols<LineSeries>- Returns:
trueif the aspect for symbols must be kept,falseotherwise
-
setSymbolKeepAspect
Description copied from interface:HasSymbolsSets the keeping of aspects for a symbol.- Specified by:
setSymbolKeepAspectin interfaceHasSymbols<LineSeries>- Parameters:
symbolKeepAspect- whether to keep aspect for symbols in the form ofpath://%svgPathData%
-
getSymbolOffset
- Specified by:
getSymbolOffsetin interfaceHasSymbols<LineSeries>- Returns:
- offset of symbol relative to original position
-
setSymbolOffset
Description copied from interface:HasSymbolsSets 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:
setSymbolOffsetin 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
-