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

Class ScrollableLegend

java.lang.Object

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

io.jmix.chartsflowui.kit.component.model.legend.AbstractLegend<ScrollableLegend>

io.jmix.chartsflowui.kit.component.model.legend.ScrollableLegend

All Implemented Interfaces:

HasBorder<ScrollableLegend>, HasPosition<ScrollableLegend>, HasShadow<ScrollableLegend>, HasPadding<ScrollableLegend>, Serializable

public class ScrollableLegend
extends AbstractLegend<ScrollableLegend>

Scrollable legend. It helps when too many legend items needed to be shown. More detailed information is provided in the documentation.

See Also:

• Legend
• Legend documentation
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScrollableLegend.PageIcons	The icons of page button.

Nested classes/interfaces inherited from class io.jmix.chartsflowui.kit.component.model.legend.AbstractLegend

AbstractLegend.Align, AbstractLegend.Emphasis, AbstractLegend.Position, AbstractLegend.SelectorLabel, AbstractLegend.TextStyle

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

ChartObservableObject.ObjectChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	animation
protected Integer	animationDurationUpdate
protected Integer	pageButtonGap
protected Integer	pageButtonItemGap
protected AbstractLegend.Position	pageButtonPosition
protected String	pageFormatter
protected JsFunction	pageFormatterFunction
protected Color	pageIconColor
protected Color	pageIconInactiveColor
protected ScrollableLegend.PageIcons	pageIcons
protected Integer	pageIconSize
protected TextStyle	pageTextStyle
protected Integer	scrollDataIndex

Fields inherited from class io.jmix.chartsflowui.kit.component.model.legend.AbstractLegend

align, backgroundColor, borderColor, borderRadius, borderWidth, bottom, emphasis, formatter, formatterFunction, height, icon, id, inactiveBorderColor, inactiveBorderWidth, inactiveColor, itemGap, itemHeight, itemStyle, itemWidth, left, lineStyle, orientation, padding, right, selectedMode, selectedSeries, selector, selectorButtonGap, selectorItemGap, selectorLabel, selectorPosition, shadowBlur, shadowColor, shadowOffsetX, shadowOffsetY, show, symbolRotate, textStyle, tooltip, top, type, width, z, zLevel

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

children, dirty, listener

Constructor Summary

Constructors

Constructor	Description
ScrollableLegend()

Method Summary

Modifier and Type	Method	Description
Boolean	getAnimation()
Integer	getAnimationDurationUpdate()
Integer	getPageButtonGap()
Integer	getPageButtonItemGap()
AbstractLegend.Position	getPageButtonPosition()
String	getPageFormatter()
JsFunction	getPageFormatterFunction()
Color	getPageIconColor()
Color	getPageIconInactiveColor()
ScrollableLegend.PageIcons	getPageIcons()
Integer	getPageIconSize()
TextStyle	getPageTextStyle()
Integer	getScrollDataIndex()
void	setAnimation(Boolean animation)
void	setAnimationDurationUpdate(Integer animationDurationUpdate)
void	setPageButtonGap(Integer pageButtonGap)
void	setPageButtonItemGap(Integer pageButtonItemGap)
void	setPageButtonPosition(AbstractLegend.Position pageButtonPosition)
void	setPageFormatter(String pageFormatter)
void	setPageFormatterFunction(JsFunction pageFormatterFunction)
void	setPageFormatterFunction(String pageFormatterFunction)
void	setPageIconColor(Color pageIconColor)
void	setPageIconInactiveColor(Color pageIconInactiveColor)
void	setPageIcons(ScrollableLegend.PageIcons pageIcons)
void	setPageIconSize(Integer pageIconSize)
void	setPageTextStyle(TextStyle pageTextStyle)
void	setScrollDataIndex(Integer scrollDataIndex)
ScrollableLegend	withAnimation(Boolean animation)
ScrollableLegend	withAnimationDurationUpdate(Integer animationDurationUpdate)
ScrollableLegend	withPageButtonGap(Integer pageButtonGap)
ScrollableLegend	withPageButtonItemGap(Integer pageButtonItemGap)
ScrollableLegend	withPageButtonPosition(AbstractLegend.Position pageButtonPosition)
ScrollableLegend	withPageFormatter(String pageFormatter)
ScrollableLegend	withPageFormatterFunction(JsFunction formatterFunction)
ScrollableLegend	withPageFormatterFunction(String formatterFunctionCode)
ScrollableLegend	withPageIconColor(Color pageIconColor)
ScrollableLegend	withPageIconInactiveColor(Color pageIconInactiveColor)
ScrollableLegend	withPageIcons(ScrollableLegend.PageIcons pageIcons)
ScrollableLegend	withPageIconSize(Integer pageIconSize)
ScrollableLegend	withPageTextStyle(TextStyle pageTextStyle)
ScrollableLegend	withScrollDataIndex(Integer scrollDataIndex)

Methods inherited from class io.jmix.chartsflowui.kit.component.model.legend.AbstractLegend

addSelectedSeries, getAlign, getBackgroundColor, getBorderColor, getBorderRadius, getBorderWidth, getBottom, getEmphasis, getFormatter, getFormatterFunction, getHeight, getIcon, getId, getInactiveBorderColor, getInactiveBorderWidth, getInactiveColor, getItemGap, getItemHeight, getItemStyle, getItemWidth, getLeft, getLineStyle, getOrientation, getPadding, getRight, getSelectedMode, getSelectedSeries, getSelector, getSelectorButtonGap, getSelectorItemGap, getSelectorLabel, getSelectorPosition, getShadowBlur, getShadowColor, getShadowOffsetX, getShadowOffsetY, getShow, getSymbolRotate, getTextStyle, getTooltip, getTop, getType, getWidth, getZ, getZLevel, removeSelectedSeries, setAlign, setBackgroundColor, setBorderColor, setBorderRadius, setBorderWidth, setBottom, setEmphasis, setFormatter, setFormatterFunction, setFormatterFunction, setHeight, setIcon, setId, setInactiveBorderColor, setInactiveBorderWidth, setInactiveColor, setItemGap, setItemHeight, setItemStyle, setItemWidth, setLeft, setLineStyle, setOrientation, setPadding, setPadding, setPadding, setRight, setSelectedMode, setSelectedSeries, setSelector, setSelectorButtonGap, setSelectorItemGap, setSelectorLabel, setSelectorPosition, setShadowBlur, setShadowColor, setShadowOffsetX, setShadowOffsetY, setShow, setSymbolRotate, setTextStyle, setTooltip, setTop, setWidth, setZ, setZLevel, withAlign, withBackgroundColor, withEmphasis, withFormatter, withFormatterFunction, withFormatterFunction, withHeight, withIcon, withId, withInactiveBorderColor, withInactiveBorderWidth, withInactiveColor, withItemGap, withItemHeight, withItemStyle, withItemWidth, withLineStyle, withOrientation, withSelectedMode, withSelectedSeries, withSelectedSeries, withSelector, withSelectorButtonGap, withSelectorItemGap, withSelectorLabel, withSelectorPosition, withShow, withSymbolRotate, withTextStyle, withTooltip, withWidth, 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.HasBorder

withBorderColor, withBorderRadius, withBorderWidth

Methods inherited from interface io.jmix.chartsflowui.kit.component.model.shared.HasPadding

withPadding, withPadding, withPadding

Methods inherited from interface io.jmix.chartsflowui.kit.component.model.HasPosition

withBottom, withLeft, withRight, withTop

Methods inherited from interface io.jmix.chartsflowui.kit.component.model.HasShadow

withShadowBlur, withShadowColor, withShadowOffsetX, withShadowOffsetY

Field Details

scrollDataIndex

protected Integer scrollDataIndex

pageButtonItemGap

protected Integer pageButtonItemGap

pageButtonGap

protected Integer pageButtonGap

pageButtonPosition

protected AbstractLegend.Position pageButtonPosition

pageFormatter

protected String pageFormatter

pageFormatterFunction

protected JsFunction pageFormatterFunction

pageIcons

protected ScrollableLegend.PageIcons pageIcons

pageIconColor

protected Color pageIconColor

pageIconInactiveColor

protected Color pageIconInactiveColor

pageIconSize

protected Integer pageIconSize

pageTextStyle

protected TextStyle pageTextStyle

animation

protected Boolean animation

animationDurationUpdate

protected Integer animationDurationUpdate

Constructor Details

ScrollableLegend

public ScrollableLegend()

Method Details

getScrollDataIndex

public Integer getScrollDataIndex()

setScrollDataIndex

public void setScrollDataIndex(Integer scrollDataIndex)

getPageButtonItemGap

public Integer getPageButtonItemGap()

setPageButtonItemGap

public void setPageButtonItemGap(Integer pageButtonItemGap)

getPageButtonGap

public Integer getPageButtonGap()

setPageButtonGap

public void setPageButtonGap(Integer pageButtonGap)

getPageButtonPosition

public AbstractLegend.Position getPageButtonPosition()

setPageButtonPosition

public void setPageButtonPosition(AbstractLegend.Position pageButtonPosition)

getPageFormatter

public String getPageFormatter()

setPageFormatter

public void setPageFormatter(String pageFormatter)

getPageFormatterFunction

public JsFunction getPageFormatterFunction()

setPageFormatterFunction

public void setPageFormatterFunction(JsFunction pageFormatterFunction)

setPageFormatterFunction

public void setPageFormatterFunction(String pageFormatterFunction)

getPageIcons

public ScrollableLegend.PageIcons getPageIcons()

setPageIcons

public void setPageIcons(ScrollableLegend.PageIcons pageIcons)

getPageIconColor

public Color getPageIconColor()

setPageIconColor

public void setPageIconColor(Color pageIconColor)

getPageIconInactiveColor

public Color getPageIconInactiveColor()

setPageIconInactiveColor

public void setPageIconInactiveColor(Color pageIconInactiveColor)

getPageIconSize

public Integer getPageIconSize()

setPageIconSize

public void setPageIconSize(Integer pageIconSize)

getPageTextStyle

public TextStyle getPageTextStyle()

setPageTextStyle

public void setPageTextStyle(TextStyle pageTextStyle)

getAnimation

public Boolean getAnimation()

setAnimation

public void setAnimation(Boolean animation)

getAnimationDurationUpdate

public Integer getAnimationDurationUpdate()

setAnimationDurationUpdate

public void setAnimationDurationUpdate(Integer animationDurationUpdate)

withScrollDataIndex

public ScrollableLegend withScrollDataIndex(Integer scrollDataIndex)

withPageButtonItemGap

public ScrollableLegend withPageButtonItemGap(Integer pageButtonItemGap)

withPageButtonGap

public ScrollableLegend withPageButtonGap(Integer pageButtonGap)

withPageButtonPosition

public ScrollableLegend withPageButtonPosition(AbstractLegend.Position pageButtonPosition)

withPageFormatter

public ScrollableLegend withPageFormatter(String pageFormatter)

withPageFormatterFunction

public ScrollableLegend withPageFormatterFunction(JsFunction formatterFunction)

withPageFormatterFunction

public ScrollableLegend withPageFormatterFunction(String formatterFunctionCode)

withPageIcons

public ScrollableLegend withPageIcons(ScrollableLegend.PageIcons pageIcons)

withPageIconColor

public ScrollableLegend withPageIconColor(Color pageIconColor)

withPageIconInactiveColor

public ScrollableLegend withPageIconInactiveColor(Color pageIconInactiveColor)

withPageIconSize

public ScrollableLegend withPageIconSize(Integer pageIconSize)

withPageTextStyle

public ScrollableLegend withPageTextStyle(TextStyle pageTextStyle)

withAnimation

public ScrollableLegend withAnimation(Boolean animation)

withAnimationDurationUpdate

public ScrollableLegend withAnimationDurationUpdate(Integer animationDurationUpdate)