Package io.jmix.charts.component.impl

Class SlicedChartImpl<T extends SlicedChart,M extends SlicedChartModelImpl>

java.lang.Object

io.jmix.ui.component.impl.AbstractComponent<JmixAmchartsScene>

io.jmix.charts.component.impl.ChartImpl<T,M>

io.jmix.charts.component.impl.SlicedChartImpl<T,M>

All Implemented Interfaces:

Chart<T>, SlicedChart<T>, HasStartEffect<T>, ChartModel<T>, SlicedChartModel<T>, HasColors<T>, HasMargins<T>, AttachNotifier, Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper, HasContextHelp, HasDebugId, HasHtmlCaption, HasHtmlDescription, HasHtmlSanitizer, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

FunnelChartImpl, PieChartImpl

public abstract class SlicedChartImpl<T extends SlicedChart,M extends SlicedChartModelImpl>
extends ChartImpl<T,M>
implements SlicedChart<T>

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.charts.component.Chart

Chart.AbstractChartClickEvent, Chart.AbstractChartEvent, Chart.AbstractClickEvent, Chart.AbstractCursorEvent, Chart.AbstractGraphItemClickEvent, Chart.AbstractItemEvent, Chart.AbstractSliceClickEvent, Chart.AxisZoomEvent, Chart.ChartClickEvent, Chart.ChartRightClickEvent, Chart.CursorPeriodSelectEvent, Chart.CursorZoomEvent, Chart.GraphClickEvent, Chart.GraphItemClickEvent, Chart.GraphItemRightClickEvent, Chart.LegendItemClickEvent, Chart.LegendItemEvent, Chart.LegendItemHideEvent, Chart.LegendItemShowEvent, Chart.LegendMarkerClickEvent, Chart.RollOutGraphEvent, Chart.RollOutGraphItemEvent, Chart.RollOverGraphEvent, Chart.RollOverGraphItemEvent, Chart.SliceClickEvent, Chart.SlicePullInEvent, Chart.SlicePullOutEvent, Chart.SliceRightClickEvent, Chart.ZoomEvent

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected SliceClickListener	sliceClickHandler
protected SlicePullInListener	slicePullInHandler
protected SlicePullOutListener	slicePullOutHandler
protected SliceRightClickListener	sliceRightClickHandler

Fields inherited from class io.jmix.charts.component.impl.ChartImpl

chartLocaleHelper, clickHandler, currentAuthentication, formatStringsRegistry, legendItemHideHandler, legendItemShowHandler, legendLabelClickHandler, legendMarkerClickHandler, messages, rightClickHandler

Fields inherited from class io.jmix.ui.component.impl.AbstractComponent

alignment, applicationContext, component, contextHelpIconClickHandler, contextHelpIconClickListener, descriptionAsHtml, element, frame, htmlSanitizerEnabled, icon, ICON_STYLE, id, parent

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor	Description
SlicedChartImpl()

Method Summary

Modifier and Type	Method	Description
T	addColors(Color... colors)	Adds colors.
T	addGradientRatio(Double... ratios)	Adds gradient ratios.
Subscription	addSliceClickListener(Consumer<Chart.SliceClickEvent> listener)	Adds a listener for a slice.
Subscription	addSlicePullInListener(Consumer<Chart.SlicePullInEvent> listener)	Adds a listener for a slice.
Subscription	addSlicePullOutListener(Consumer<Chart.SlicePullOutEvent> listener)	Adds a listener for a slice.
Subscription	addSliceRightClickListener(Consumer<Chart.SliceRightClickEvent> listener)	Adds a listener for a slice.
String	getAccessibleLabel()
Double	getAlpha()
String	getAlphaField()
Color	getBaseColor()
String	getClassNameField()
String	getColorField()
List<Color>	getColors()
String	getDescriptionField()
List<Double>	getGradientRatio()
Double	getGroupedAlpha()
Color	getGroupedColor()
String	getGroupedDescription()
Boolean	getGroupedPulled()
String	getGroupedTitle()
Double	getGroupPercent()
Double	getHideLabelsPercent()
Double	getHoverAlpha()
Color	getLabelColorField()
JsFunction	getLabelFunction()
Boolean	getLabelsEnabled()
Double	getLabelTickAlpha()
Color	getLabelTickColor()
Integer	getMarginBottom()
Integer	getMarginLeft()
Integer	getMarginRight()
Integer	getMarginTop()
Integer	getMaxLabelWidth()
Double	getOutlineAlpha()
Color	getOutlineColor()
Integer	getOutlineThickness()
String	getPatternField()
String	getPulledField()
Integer	getPullOutDuration()
AnimationEffect	getPullOutEffect()
Boolean	getPullOutOnlyOne()
Boolean	getSequencedAnimation()
Boolean	getShowZeroSlices()
Double	getStartAlpha()
Double	getStartDuration()
AnimationEffect	getStartEffect()
Integer	getTabIndex()
String	getTitleField()
String	getUrlField()
String	getUrlTarget()
String	getValueField()
String	getVisibleInLegendField()
protected void	onSliceClick(SliceClickEvent e)
protected void	onSlicePullIn(SlicePullInEvent e)
protected void	onSlicePullOut(SlicePullOutEvent e)
protected void	onSliceRightClick(SliceRightClickEvent e)
T	setAccessibleLabel(String accessibleLabel)	Sets accessible label text.
T	setAlpha(Double alpha)	Sets opacity of all slices.
T	setAlphaField(String alphaField)	Sets alpha field name from data provider which holds slice's alpha.
T	setBaseColor(Color baseColor)	Sets color of the first slice.
T	setClassNameField(String classNameField)	Sets field name from your data provider which holds CSS class name.
T	setColorField(String colorField)	Sets name of the field from data provider which holds slice's color.
T	setColors(List list)	Sets the list of colors.
T	setDescriptionField(String descriptionField)	Sets name of the field from data provider which holds a string with description.
T	setGradientRatio(List gradientRatio)	Sets the list of gradient ratio.
T	setGroupedAlpha(Double groupedAlpha)	Sets opacity of the group slice.
T	setGroupedColor(Color groupedColor)	Sets the color of the group slice.
T	setGroupedDescription(String groupedDescription)	Sets description of the group slice.
T	setGroupedPulled(Boolean groupedPulled)	If groupedPulled set to true, the group slice will be pulled out when the chart loads.
T	setGroupedTitle(String groupedTitle)	Sets title of the group slice.
T	setGroupPercent(Double groupPercent)	Sets group percent.
T	setHideLabelsPercent(Double hideLabelsPercent)	Sets hide labels percent.
T	setHoverAlpha(Double hoverAlpha)	Sets opacity of a hovered slice.
T	setLabelColorField(Color labelColorField)	Sets a field from your data provider which holds color value for the tick.
T	setLabelFunction(JsFunction labelFunction)	Sets label function that can format data labels in any way you want.
T	setLabelsEnabled(Boolean labelsEnabled)	Set labelsEnabled to true if data labels should be visible.
T	setLabelTickAlpha(Double labelTickAlpha)	Sets label tick opacity.
T	setLabelTickColor(Color labelTickColor)	Sets label tick color.
T	setMarginBottom(Integer marginBottom)	Sets bottom spacing.
T	setMarginLeft(Integer marginLeft)	Sets left-hand spacing.
T	setMarginRight(Integer marginRight)	Sets right-hand spacing.
T	setMarginTop(Integer marginTop)	Sets top spacing.
T	setMaxLabelWidth(Integer maxLabelWidth)	Sets maximum label width.
T	setOutlineAlpha(Double outlineAlpha)	Sets outline opacity.
T	setOutlineColor(Color outlineColor)	Sets outline color.
T	setOutlineThickness(Integer outlineThickness)	Sets pie outline thickness.
T	setPatternField(String patternField)	Sets field name from your data provider which holds pattern information.
T	setPulledField(String pulledField)	Sets name of the field in chart's data provider which holds a boolean value telling the chart whether this slice must be pulled or not.
T	setPullOutDuration(Integer pullOutDuration)	Sets pull out duration in seconds.
T	setPullOutEffect(AnimationEffect pullOutEffect)	Sets pull out effect.
T	setPullOutOnlyOne(Boolean pullOutOnlyOne)	If pullOutOnlyOne set to true, only one slice can be pulled out at a time.
T	setSequencedAnimation(Boolean sequencedAnimation)	Specifies whether the animation should be sequenced or all slices should appear at once.
T	setShowZeroSlices(Boolean showZeroSlices)	Set showZeroSlices to true if you want the chart should display outlines (if visible) and labels for slices even if their value is 0.
T	setStartAlpha(Double startAlpha)	Sets initial opacity of all slices.
T	setStartDuration(Double startDuration)	Sets duration of the animation, in seconds.
T	setStartEffect(AnimationEffect startEffect)	Sets animation effect.
T	setTabIndex(Integer tabIndex)	In case you set it to some number, the chart will set focus on a slice (starting from first) when user clicks tab key.
T	setTitleField(String titleField)	Sets name of the field from data provider which holds slice's title.
T	setUrlField(String urlField)	Sets name of the field from data provider which holds URL which would be accessed if the user clicks on a slice.
T	setUrlTarget(String urlTarget)	If URL is specified for a slice, it will be opened when user clicks on it.
T	setValueField(String valueField)	Sets name of the field from data provider which holds slice's value.
T	setVisibleInLegendField(String visibleInLegendField)	Use this field to selectively specify which slice is shown in legend.

Methods inherited from class io.jmix.charts.component.impl.ChartImpl

addAdditionalFields, addClickListener, addData, addLabels, addLegendItemHideListener, addLegendItemShowListener, addLegendLabelClickListener, addLegendMarkerClickListener, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addRightClickListener, addTitles, afterPropertiesSet, createChartConfiguration, createChartSerializer, createComponent, getAccessible, getAccessibleDescription, getAccessibleTitle, getAddClassNames, getAdditionalFields, getAllLabels, getAutoDisplay, getAutoResize, getAutoTransform, getBackgroundAlpha, getBackgroundColor, getBalloon, getBorderAlpha, getBorderColor, getClassNamePrefix, getColor, getCreditsPosition, getDataProvider, getDecimalSeparator, getDefs, getExport, getFontFamily, getFontSize, getHandDrawn, getHandDrawScatter, getHandDrawThickness, getHideBalloonTime, getLanguage, getLegend, getModel, getNativeJson, getPanEventsEnabled, getPath, getPathToImages, getPercentPrecision, getPrecision, getPrefixesOfBigNumbers, getPrefixesOfSmallNumbers, getProcessCount, getProcessTimeout, getResponsive, getSvgIcons, getTapToActivate, getTheme, getThousandsSeparator, getTitles, getTouchClickDuration, getUsePrefixes, initLocale, onChartClick, onChartRightClick, onLegendItemHide, onLegendItemShow, onLegendLabelClick, onLegendMarkerClick, repaint, setAccessible, setAccessibleDescription, setAccessibleTitle, setAddClassNames, setAdditionalFields, setAllLabels, setAutoDisplay, setAutoResize, setAutoTransform, setBackgroundAlpha, setBackgroundColor, setBalloon, setBorderAlpha, setBorderColor, setChartLocaleHelper, setClassNamePrefix, setColor, setCreditsPosition, setCurrentAuthentication, setDataProvider, setDecimalSeparator, setDefs, setExport, setFontFamily, setFontSize, setFormatStringsRegistry, setHandDrawn, setHandDrawScatter, setHandDrawThickness, setHideBalloonTime, setLanguage, setLegend, setMessages, setNativeJson, setPanEventsEnabled, setPath, setPathToImages, setPercentPrecision, setPrecision, setPrefixesOfBigNumbers, setPrefixesOfSmallNumbers, setProcessCount, setProcessTimeout, setResponsive, setSvgIcons, setTapToActivate, setTheme, setThousandsSeparator, setTitles, setTouchClickDuration, setupChartLocale, setupDefaults, setUsePrefixes

Methods inherited from class io.jmix.ui.component.impl.AbstractComponent

addAttachListener, addDetachListener, addStyleName, assignDebugId, attached, detached, getAlignment, getCaption, getComponent, getComposition, getContextHelpIconClickHandler, getContextHelpText, getDebugId, getDescription, getEventHub, getFrame, getHeight, getHeightSizeUnit, getHtmlSanitizer, getIcon, getIconName, getIconResource, getId, getParent, getStyleName, getUiComponentProperties, getUiProperties, getWidth, getWidthSizeUnit, getXmlDescriptor, hasSubscriptions, hasValidationError, isAttached, isCaptionAsHtml, isContextHelpTextHtmlEnabled, isDescriptionAsHtml, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, onContextHelpIconClick, publish, removeStyleName, sanitize, setAlignment, setApplicationContext, setCaption, setCaptionAsHtml, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setDebugId, setDescription, setDescriptionAsHtml, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setIcon, setIconFromSet, setId, setParent, setResponsive, setStyleName, setValidationError, setVisible, setWidth, setXmlDescriptor, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.charts.component.Chart

addClickListener, addLegendItemHideListener, addLegendItemShowListener, addLegendLabelClickListener, addLegendMarkerClickListener, addRightClickListener, getDataProvider, getNativeJson, repaint, setDataProvider, setNativeJson

Methods inherited from interface io.jmix.charts.model.chart.ChartModel

addAdditionalFields, addData, addLabels, addPrefixesOfBigNumbers, addPrefixesOfSmallNumbers, addTitles, getAccessible, getAccessibleDescription, getAccessibleTitle, getAddClassNames, getAdditionalFields, getAllLabels, getAutoDisplay, getAutoResize, getAutoTransform, getBackgroundAlpha, getBackgroundColor, getBalloon, getBorderAlpha, getBorderColor, getClassNamePrefix, getColor, getCreditsPosition, getDecimalSeparator, getDefs, getExport, getFontFamily, getFontSize, getHandDrawn, getHandDrawScatter, getHandDrawThickness, getHideBalloonTime, getLanguage, getLegend, getPanEventsEnabled, getPath, getPathToImages, getPercentPrecision, getPrecision, getPrefixesOfBigNumbers, getPrefixesOfSmallNumbers, getProcessCount, getProcessTimeout, getResponsive, getSvgIcons, getTapToActivate, getTheme, getThousandsSeparator, getTitles, getTouchClickDuration, getUsePrefixes, setAccessible, setAccessibleDescription, setAccessibleTitle, setAddClassNames, setAdditionalFields, setAllLabels, setAutoDisplay, setAutoResize, setAutoTransform, setBackgroundAlpha, setBackgroundColor, setBalloon, setBorderAlpha, setBorderColor, setClassNamePrefix, setColor, setCreditsPosition, setDecimalSeparator, setDefs, setExport, setFontFamily, setFontSize, setHandDrawn, setHandDrawScatter, setHandDrawThickness, setHideBalloonTime, setLanguage, setLegend, setPanEventsEnabled, setPath, setPathToImages, setPercentPrecision, setPrecision, setPrefixesOfBigNumbers, setPrefixesOfSmallNumbers, setProcessCount, setProcessTimeout, setResponsive, setSvgIcons, setTapToActivate, setTheme, setThousandsSeparator, setTitles, setTouchClickDuration, setUsePrefixes

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Field Details

sliceClickHandler

protected SliceClickListener sliceClickHandler

sliceRightClickHandler

protected SliceRightClickListener sliceRightClickHandler

slicePullInHandler

protected SlicePullInListener slicePullInHandler

slicePullOutHandler

protected SlicePullOutListener slicePullOutHandler

Constructor Details

SlicedChartImpl

public SlicedChartImpl()

Method Details

getAlpha

public Double getAlpha()

Specified by:

getAlpha in interface SlicedChartModel<T extends SlicedChart>

Returns:

opacity of all slices

setAlpha

public T setAlpha(Double alpha)

Description copied from interface: SlicedChartModel

Sets opacity of all slices. If not set the default value is 1.

Specified by:

setAlpha in interface SlicedChartModel<T extends SlicedChart>

Parameters:

alpha - opacity of all slices

Returns:

sliced chart model

getAlphaField

public String getAlphaField()

Specified by:

getAlphaField in interface SlicedChartModel<T extends SlicedChart>

Returns:

alpha field name

setAlphaField

public T setAlphaField(String alphaField)

Description copied from interface: SlicedChartModel

Sets alpha field name from data provider which holds slice's alpha.

Specified by:

setAlphaField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

alphaField - alpha field string

Returns:

sliced chart model

getBaseColor

public Color getBaseColor()

Specified by:

getBaseColor in interface SlicedChartModel<T extends SlicedChart>

Returns:

color of the first slice

setBaseColor

public T setBaseColor(Color baseColor)

Description copied from interface: SlicedChartModel

Sets color of the first slice. All the other will be colored with darker or brighter colors. Use brightnessStep to set intensity of color change for each subsequent slice. If not set the default value is 20.

Specified by:

setBaseColor in interface SlicedChartModel<T extends SlicedChart>

Parameters:

baseColor - color of the first slice

Returns:

sliced chart model

getColorField

public String getColorField()

Specified by:

getColorField in interface SlicedChartModel<T extends SlicedChart>

Returns:

color field

setColorField

public T setColorField(String colorField)

Description copied from interface: SlicedChartModel

Sets name of the field from data provider which holds slice's color.

Specified by:

setColorField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

colorField - color field string

Returns:

sliced chart model

getColors

public List<Color> getColors()

Specified by:

getColors in interface HasColors<T extends SlicedChart>

Returns:

List of colors

setColors

public T setColors(List list)

Description copied from interface: HasColors

Sets the list of colors.

If you use charts based on SlicedChartModelImpl it specifies the colors of the slices, if the slice color is not set. If there are more slices than colors in this array, the chart picks random color.

If you use charts based on CoordinateChartModelImpl or StockChartModel it specifies the colors of the graphs if the lineColor of a graph is not set. If there are more graphs then colors in this array, the chart picks a random color. If not set the default value is

  ["#FF6600", "#FCD202", "#B0DE09",
   "#0D8ECF", "#2A0CD0", "#CD0D74",
   "#CC0000", "#00CC00", "#0000CC",
   "#DDDDDD", "#999999", "#333333",
   "#990000"]
 

If you use chart based on SlicedChartModelImpl (PieChart, FunnelChart). Specifies the colors of the slices, if the slice color is not set. If there are more slices than colors in this array, the chart picks random color. If not set default value is

  ["#FF0F00", "#FF6600", "#FF9E01", "#FCD202",
   "#F8FF01", "#B0DE09", "#04D215", "#0D8ECF",
   "#0D52D1", "#2A0CD0", "#8A0CCF", "#CD0D74",
   "#754DEB", "#DDDDDD", "#999999", "#333333",
   "#000000", "#57032A", "#CA9726", "#990000",
  "#4B0C25"]
 

Specified by:

setColors in interface HasColors<T extends SlicedChart>

Parameters:

list - list of colors

Returns:

chart

addColors

public T addColors(Color... colors)

Description copied from interface: HasColors

Adds colors.

Specified by:

addColors in interface HasColors<T extends SlicedChart>

Parameters:

colors - list of colors

Returns:

chart

getDescriptionField

public String getDescriptionField()

Specified by:

getDescriptionField in interface SlicedChartModel<T extends SlicedChart>

Returns:

description field

setDescriptionField

public T setDescriptionField(String descriptionField)

Description copied from interface: SlicedChartModel

Sets name of the field from data provider which holds a string with description.

Specified by:

setDescriptionField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

descriptionField - description field string

Returns:

sliced chart model

getGradientRatio

public List<Double> getGradientRatio()

Specified by:

getGradientRatio in interface SlicedChartModel<T extends SlicedChart>

Returns:

list of gradient ratio

setGradientRatio

public T setGradientRatio(List gradientRatio)

Description copied from interface: SlicedChartModel

Sets the list of gradient ratio. Will make slices to be filled with color gradients. Negative value means the color will be darker than the original, and positive number means the color will be lighter.

Specified by:

setGradientRatio in interface SlicedChartModel<T extends SlicedChart>

Parameters:

gradientRatio - list of gradient ratio

Returns:

sliced chart model

addGradientRatio

public T addGradientRatio(Double... ratios)

Description copied from interface: SlicedChartModel

Adds gradient ratios.

Specified by:

addGradientRatio in interface SlicedChartModel<T extends SlicedChart>

Parameters:

ratios - the ratios

Returns:

sliced chart model

getGroupedAlpha

public Double getGroupedAlpha()

Specified by:

getGroupedAlpha in interface SlicedChartModel<T extends SlicedChart>

Returns:

opacity of the group slice

setGroupedAlpha

public T setGroupedAlpha(Double groupedAlpha)

Description copied from interface: SlicedChartModel

Sets opacity of the group slice. Value range is 0 - 1. If not set the default value is 1.

Specified by:

setGroupedAlpha in interface SlicedChartModel<T extends SlicedChart>

Parameters:

groupedAlpha - opacity of the group slice

Returns:

sliced chart model

getGroupedColor

public Color getGroupedColor()

Specified by:

getGroupedColor in interface SlicedChartModel<T extends SlicedChart>

Returns:

grouped color

setGroupedColor

public T setGroupedColor(Color groupedColor)

Description copied from interface: SlicedChartModel

Sets the color of the group slice. The default value is not set - this means the next available color from "colors" list will be used.

Specified by:

setGroupedColor in interface SlicedChartModel<T extends SlicedChart>

Parameters:

groupedColor - grouped color

Returns:

sliced chart model

getGroupedDescription

public String getGroupedDescription()

Specified by:

getGroupedDescription in interface SlicedChartModel<T extends SlicedChart>

Returns:

grouped description

setGroupedDescription

public T setGroupedDescription(String groupedDescription)

Description copied from interface: SlicedChartModel

Sets description of the group slice.

Specified by:

setGroupedDescription in interface SlicedChartModel<T extends SlicedChart>

Parameters:

groupedDescription - grouped description string

Returns:

sliced chart model

getGroupedPulled

public Boolean getGroupedPulled()

Specified by:

getGroupedPulled in interface SlicedChartModel<T extends SlicedChart>

Returns:

true if grouped pulled is enabled

setGroupedPulled

public T setGroupedPulled(Boolean groupedPulled)

Description copied from interface: SlicedChartModel

If groupedPulled set to true, the group slice will be pulled out when the chart loads. If not set the default value is false.

Specified by:

setGroupedPulled in interface SlicedChartModel<T extends SlicedChart>

Parameters:

groupedPulled - grouped pulled option

Returns:

sliced chart model

getGroupedTitle

public String getGroupedTitle()

Specified by:

getGroupedTitle in interface SlicedChartModel<T extends SlicedChart>

Returns:

grouped title

setGroupedTitle

public T setGroupedTitle(String groupedTitle)

Description copied from interface: SlicedChartModel

Sets title of the group slice. If not set the default value is "Other".

Specified by:

setGroupedTitle in interface SlicedChartModel<T extends SlicedChart>

Parameters:

groupedTitle - grouped title string

Returns:

sliced chart model

getGroupPercent

public Double getGroupPercent()

Specified by:

getGroupPercent in interface SlicedChartModel<T extends SlicedChart>

setGroupPercent

public T setGroupPercent(Double groupPercent)

Description copied from interface: SlicedChartModel

Sets group percent. If there is more than one slice whose percentage of the pie is less than this number, those slices will be grouped together into one slice. This is the "other" slice. It will always be the last slice in a pie. If not set the default value is 0.

Specified by:

setGroupPercent in interface SlicedChartModel<T extends SlicedChart>

Parameters:

groupPercent - the group percent

Returns:

sliced chart model

getHideLabelsPercent

public Double getHideLabelsPercent()

Specified by:

getHideLabelsPercent in interface SlicedChartModel<T extends SlicedChart>

Returns:

hide labels percent

setHideLabelsPercent

public T setHideLabelsPercent(Double hideLabelsPercent)

Description copied from interface: SlicedChartModel

Sets hide labels percent. Slices with percent less then hideLabelsPercent won't display labels. This is useful to avoid cluttering up the chart, if you have a lot of small slices. 0 means all labels will be shown. If not set the default value is 0.

Specified by:

setHideLabelsPercent in interface SlicedChartModel<T extends SlicedChart>

Parameters:

hideLabelsPercent - the hide labels percent

Returns:

sliced chart model

getHoverAlpha

public Double getHoverAlpha()

Specified by:

getHoverAlpha in interface SlicedChartModel<T extends SlicedChart>

Returns:

opacity of a hovered slice

setHoverAlpha

public T setHoverAlpha(Double hoverAlpha)

Description copied from interface: SlicedChartModel

Sets opacity of a hovered slice. Value range is 0 - 1. If not set the default value is 1.

Specified by:

setHoverAlpha in interface SlicedChartModel<T extends SlicedChart>

Parameters:

hoverAlpha - opacity of a hovered slice

Returns:

sliced chart model

getLabelsEnabled

public Boolean getLabelsEnabled()

Specified by:

getLabelsEnabled in interface SlicedChartModel<T extends SlicedChart>

Returns:

true if data labels are visible

setLabelsEnabled

public T setLabelsEnabled(Boolean labelsEnabled)

Description copied from interface: SlicedChartModel

Set labelsEnabled to true if data labels should be visible. If not set the default value is true.

Specified by:

setLabelsEnabled in interface SlicedChartModel<T extends SlicedChart>

Parameters:

labelsEnabled - labels enabled option

Returns:

sliced chart model

getLabelTickAlpha

public Double getLabelTickAlpha()

Specified by:

getLabelTickAlpha in interface SlicedChartModel<T extends SlicedChart>

Returns:

label tick opacity

setLabelTickAlpha

public T setLabelTickAlpha(Double labelTickAlpha)

Description copied from interface: SlicedChartModel

Sets label tick opacity. Value range is 0 - 1. If not set the default value is 0.2.

Specified by:

setLabelTickAlpha in interface SlicedChartModel<T extends SlicedChart>

Parameters:

labelTickAlpha - label tick opacity

Returns:

sliced chart model

getLabelTickColor

public Color getLabelTickColor()

Specified by:

getLabelTickColor in interface SlicedChartModel<T extends SlicedChart>

Returns:

label tick color

setLabelTickColor

public T setLabelTickColor(Color labelTickColor)

Description copied from interface: SlicedChartModel

Sets label tick color. If not set the default value is #000000.

Specified by:

setLabelTickColor in interface SlicedChartModel<T extends SlicedChart>

Parameters:

labelTickColor - label tick color

Returns:

sliced chart model

getMarginBottom

public Integer getMarginBottom()

Specified by:

getMarginBottom in interface HasMargins<T extends SlicedChart>

Returns:

bottom spacing

setMarginBottom

public T setMarginBottom(Integer marginBottom)

Description copied from interface: HasMargins

Sets bottom spacing. If not set the default value is 10.

If is used for Legend default value is 0.

If is used for RadarChartModelImpl the default value is 0.

If is used for chart based on RectangularChartModelImpl (GanttChart, SerialChart, XYChart) the default value is 20.

If is used for chart based on SlicedChartModelImpl (FunnelChart, PieChart) the default value is 10.

If is used for PanelsSettings the default value is 0.

Specified by:

setMarginBottom in interface HasMargins<T extends SlicedChart>

Parameters:

marginBottom - bottom spacing

Returns:

object with set bottom spacing

getMarginLeft

public Integer getMarginLeft()

Specified by:

getMarginLeft in interface HasMargins<T extends SlicedChart>

Returns:

left-hand spacing

setMarginLeft

public T setMarginLeft(Integer marginLeft)

Description copied from interface: HasMargins

Sets left-hand spacing.

marginLeft will be ignored if chart is SerialChart or XYChartModelImpl and AbstractLegend.autoMargins is true.

If is used for Legend the default value is 20.

If is used for RadarChartModelImpl the default value is 0.

If is used for chart based on RectangularChartModelImpl (GanttChart, SerialChart, XYChart) the default value is 20.

If is used for chart based on SlicedChartModelImpl the default value is 0.

If is used for PanelsSettings the default value is 0.

Specified by:

setMarginLeft in interface HasMargins<T extends SlicedChart>

Parameters:

marginLeft - left-hand spacing

Returns:

object with set left-hand spacing

getMarginRight

public Integer getMarginRight()

Specified by:

getMarginRight in interface HasMargins<T extends SlicedChart>

Returns:

right-hand spacing

setMarginRight

public T setMarginRight(Integer marginRight)

Description copied from interface: HasMargins

Sets right-hand spacing.

marginRight will be ignored if chart is SerialChart or XYChartModelImpl and AbstractLegend.autoMargins is true.

If is used for Legend the default value is 20.

If is used for RadarChartModelImpl the default value is 0.

If is used for chart based on RectangularChartModelImpl (GanttChart, SerialChart, XYChart) the default value is 20.

If is used for chart based on SlicedChartModelImpl (FunnelChart, PieChart) the default value is 0.

If is used for PanelsSettings the default value is 0.

Specified by:

setMarginRight in interface HasMargins<T extends SlicedChart>

Parameters:

marginRight - right-hand spacing

Returns:

object with set right-hand spacing

getMarginTop

public Integer getMarginTop()

Specified by:

getMarginTop in interface HasMargins<T extends SlicedChart>

Returns:

top spacing

setMarginTop

public T setMarginTop(Integer marginTop)

Description copied from interface: HasMargins

Sets top spacing. If not set the default value is 10.

If is used for Legend the default value is 0.

If is used for RadarChartModelImpl the default value is 0.

If is used for chart based on RectangularChartModelImpl (GanttChart, SerialChart, XYChart) the default value is 20.

If is used for chart based on SlicedChartModelImpl the default value is 10.

If is used for PanelsSettings the default value is 0.

Specified by:

setMarginTop in interface HasMargins<T extends SlicedChart>

Parameters:

marginTop - top spacing

Returns:

object with set top spacing

getOutlineAlpha

public Double getOutlineAlpha()

Specified by:

getOutlineAlpha in interface SlicedChartModel<T extends SlicedChart>

Returns:

outline opacity

setOutlineAlpha

public T setOutlineAlpha(Double outlineAlpha)

Description copied from interface: SlicedChartModel

Sets outline opacity. Value range is 0 - 1. If not set the default value is 0.

Specified by:

setOutlineAlpha in interface SlicedChartModel<T extends SlicedChart>

Parameters:

outlineAlpha - outline opacity

Returns:

sliced chart model

getOutlineColor

public Color getOutlineColor()

Specified by:

getOutlineColor in interface SlicedChartModel<T extends SlicedChart>

Returns:

outline color

setOutlineColor

public T setOutlineColor(Color outlineColor)

Description copied from interface: SlicedChartModel

Sets outline color. If not set the default value is #FFFFFF.

Specified by:

setOutlineColor in interface SlicedChartModel<T extends SlicedChart>

Parameters:

outlineColor - the outline color

Returns:

sliced chart model

getOutlineThickness

public Integer getOutlineThickness()

Specified by:

getOutlineThickness in interface SlicedChartModel<T extends SlicedChart>

Returns:

outline thickness

setOutlineThickness

public T setOutlineThickness(Integer outlineThickness)

Description copied from interface: SlicedChartModel

Sets pie outline thickness. If not set the default value is 1.

Specified by:

setOutlineThickness in interface SlicedChartModel<T extends SlicedChart>

Parameters:

outlineThickness - the outline thickness

Returns:

sliced chart model

getPatternField

public String getPatternField()

Specified by:

getPatternField in interface SlicedChartModel<T extends SlicedChart>

Returns:

pattern field name

setPatternField

public T setPatternField(String patternField)

Description copied from interface: SlicedChartModel

Sets field name from your data provider which holds pattern information.

Specified by:

setPatternField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

patternField - pattern field string

Returns:

sliced chart model

getPulledField

public String getPulledField()

Specified by:

getPulledField in interface SlicedChartModel<T extends SlicedChart>

Returns:

pulled field name

setPulledField

public T setPulledField(String pulledField)

Description copied from interface: SlicedChartModel

Sets name of the field in chart's data provider which holds a boolean value telling the chart whether this slice must be pulled or not.

Specified by:

setPulledField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

pulledField - pulled field string

Returns:

sliced chart model

getPullOutDuration

public Integer getPullOutDuration()

Specified by:

getPullOutDuration in interface SlicedChartModel<T extends SlicedChart>

Returns:

pull out duration in seconds

setPullOutDuration

public T setPullOutDuration(Integer pullOutDuration)

Description copied from interface: SlicedChartModel

Sets pull out duration in seconds. If not set the default value is 1.

Specified by:

setPullOutDuration in interface SlicedChartModel<T extends SlicedChart>

Parameters:

pullOutDuration - pull out duration in seconds

Returns:

sliced chart model

getPullOutEffect

public AnimationEffect getPullOutEffect()

Specified by:

getPullOutEffect in interface SlicedChartModel<T extends SlicedChart>

Returns:

pull out effect

setPullOutEffect

public T setPullOutEffect(AnimationEffect pullOutEffect)

Description copied from interface: SlicedChartModel

Sets pull out effect. Possible values are: easeOutSine, easeInSine, elastic, bounce. If not set the default value is BOUNCE.

Specified by:

setPullOutEffect in interface SlicedChartModel<T extends SlicedChart>

Parameters:

pullOutEffect - the pull out effect

Returns:

sliced chart model

getPullOutOnlyOne

public Boolean getPullOutOnlyOne()

Specified by:

getPullOutOnlyOne in interface SlicedChartModel<T extends SlicedChart>

Returns:

true if only one slice can be pulled out at a time

setPullOutOnlyOne

public T setPullOutOnlyOne(Boolean pullOutOnlyOne)

Description copied from interface: SlicedChartModel

If pullOutOnlyOne set to true, only one slice can be pulled out at a time. If the viewer clicks on a slice, any other pulled-out slice will be pulled in. If not set the default value is false.

Specified by:

setPullOutOnlyOne in interface SlicedChartModel<T extends SlicedChart>

Parameters:

pullOutOnlyOne - pull out only one option

Returns:

sliced chart model

getSequencedAnimation

public Boolean getSequencedAnimation()

Specified by:

getSequencedAnimation in interface SlicedChartModel<T extends SlicedChart>

Returns:

true if the animation should be sequenced

setSequencedAnimation

public T setSequencedAnimation(Boolean sequencedAnimation)

Description copied from interface: SlicedChartModel

Specifies whether the animation should be sequenced or all slices should appear at once. If not set the default value is true.

Specified by:

setSequencedAnimation in interface SlicedChartModel<T extends SlicedChart>

Parameters:

sequencedAnimation - sequenced animation option

Returns:

sliced chart model

getStartAlpha

public Double getStartAlpha()

Specified by:

getStartAlpha in interface SlicedChartModel<T extends SlicedChart>

Returns:

initial opacity of all slices

setStartAlpha

public T setStartAlpha(Double startAlpha)

Description copied from interface: SlicedChartModel

Sets initial opacity of all slices. Slices will fade in from startAlpha. If not set the default value is 0.

Specified by:

setStartAlpha in interface SlicedChartModel<T extends SlicedChart>

Parameters:

startAlpha - initial opacity of all slices

Returns:

sliced chart model

getStartDuration

public Double getStartDuration()

Specified by:

getStartDuration in interface HasStartEffect<T extends SlicedChart>

Returns:

duration of the animation, in seconds

setStartDuration

public T setStartDuration(Double startDuration)

Description copied from interface: HasStartEffect

Sets duration of the animation, in seconds.

If you use AngularGaugeChartModelImpl default value is 1.

If you use charts based on CoordinateChartModel (GanttChart, RadarChart, SerialChart, XYChart) default value is 0.

If you use chart based on SlicedChartModelImpl default value is 1.

Specified by:

setStartDuration in interface HasStartEffect<T extends SlicedChart>

Parameters:

startDuration - the start duration

Returns:

object with set duration of the animation

getStartEffect

public AnimationEffect getStartEffect()

Specified by:

getStartEffect in interface HasStartEffect<T extends SlicedChart>

Returns:

animation effect

setStartEffect

public T setStartEffect(AnimationEffect startEffect)

Description copied from interface: HasStartEffect

Sets animation effect.

If you use AngularGaugeChartModelImpl animation effect will be applied for the arrow. If not set the default value is EASE_IN_SINE.

If you use charts based on CoordinateChartModel (GanttChart, RadarChart, SerialChart, XYChart) default value is ELASTIC.

If you use chart based on SlicedChartModelImpl default value is BOUNCE.

Specified by:

setStartEffect in interface HasStartEffect<T extends SlicedChart>

Parameters:

startEffect - the start effect

Returns:

object with set animation effect

getTitleField

public String getTitleField()

Specified by:

getTitleField in interface SlicedChartModel<T extends SlicedChart>

Returns:

title field name

setTitleField

public T setTitleField(String titleField)

Description copied from interface: SlicedChartModel

Sets name of the field from data provider which holds slice's title.

Specified by:

setTitleField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

titleField - title field string

Returns:

sliced chart model

getUrlField

public String getUrlField()

Specified by:

getUrlField in interface SlicedChartModel<T extends SlicedChart>

Returns:

the URL field name

setUrlField

public T setUrlField(String urlField)

Description copied from interface: SlicedChartModel

Sets name of the field from data provider which holds URL which would be accessed if the user clicks on a slice.

Specified by:

setUrlField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

urlField - the URL field string

Returns:

sliced chart model

getUrlTarget

public String getUrlTarget()

Specified by:

getUrlTarget in interface SlicedChartModel<T extends SlicedChart>

Returns:

the URL target

setUrlTarget

public T setUrlTarget(String urlTarget)

Description copied from interface: SlicedChartModel

If URL is specified for a slice, it will be opened when user clicks on it. urlTarget specifies target of this URL. Use "_blank" if you want URL to be opened in a new window. If not set the default value is "_self".

Specified by:

setUrlTarget in interface SlicedChartModel<T extends SlicedChart>

Parameters:

urlTarget - the URL target string

Returns:

sliced chart model

getValueField

public String getValueField()

Specified by:

getValueField in interface SlicedChartModel<T extends SlicedChart>

Returns:

value field name

setValueField

public T setValueField(String valueField)

Description copied from interface: SlicedChartModel

Sets name of the field from data provider which holds slice's value.

Specified by:

setValueField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

valueField - value field string

Returns:

sliced chart model

getVisibleInLegendField

public String getVisibleInLegendField()

Specified by:

getVisibleInLegendField in interface SlicedChartModel<T extends SlicedChart>

Returns:

visible in legend field

setVisibleInLegendField

public T setVisibleInLegendField(String visibleInLegendField)

Description copied from interface: SlicedChartModel

Use this field to selectively specify which slice is shown in legend. It should be set to a boolean field in data (that holds either true or false). For example if you set visibleInLegendField to "showInLegend", all slices that have "showInLegend: false" in their data will not be shown in the legend.

Specified by:

setVisibleInLegendField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

visibleInLegendField - visible in legend field string

Returns:

sliced chart model

getLabelFunction

public JsFunction getLabelFunction()

Specified by:

getLabelFunction in interface SlicedChartModel<T extends SlicedChart>

Returns:

label function

setLabelFunction

public T setLabelFunction(JsFunction labelFunction)

Description copied from interface: SlicedChartModel

Sets label function that can format data labels in any way you want. Chart will call this method and will pass Slice object and formatted text as attributes. This function should return string which will be displayed as label.

Specified by:

setLabelFunction in interface SlicedChartModel<T extends SlicedChart>

Parameters:

labelFunction - label function

Returns:

sliced chart model

getMaxLabelWidth

public Integer getMaxLabelWidth()

Specified by:

getMaxLabelWidth in interface SlicedChartModel<T extends SlicedChart>

Returns:

maximum label width

setMaxLabelWidth

public T setMaxLabelWidth(Integer maxLabelWidth)

Description copied from interface: SlicedChartModel

Sets maximum label width. If width of the label is bigger than maxLabelWidth, it will be wrapped. If not set the default value is 200.

Specified by:

setMaxLabelWidth in interface SlicedChartModel<T extends SlicedChart>

Parameters:

maxLabelWidth - maximum label width

Returns:

sliced chart model

getClassNameField

public String getClassNameField()

Specified by:

getClassNameField in interface SlicedChartModel<T extends SlicedChart>

Returns:

class name field

setClassNameField

public T setClassNameField(String classNameField)

Description copied from interface: SlicedChartModel

Sets field name from your data provider which holds CSS class name. If this field is set and AbstractChart.addClassNames is enabled, the slice element will have this class name set.

Specified by:

setClassNameField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

classNameField - class name field string

Returns:

sliced chart model

getShowZeroSlices

public Boolean getShowZeroSlices()

Specified by:

getShowZeroSlices in interface SlicedChartModel<T extends SlicedChart>

Returns:

true if the chart displays outlines (if visible) and labels for slices even if their value is 0.

setShowZeroSlices

public T setShowZeroSlices(Boolean showZeroSlices)

Description copied from interface: SlicedChartModel

Set showZeroSlices to true if you want the chart should display outlines (if visible) and labels for slices even if their value is 0. If not set the default value is false.

Specified by:

setShowZeroSlices in interface SlicedChartModel<T extends SlicedChart>

Parameters:

showZeroSlices - show zero slices option

Returns:

sliced chart model

getAccessibleLabel

public String getAccessibleLabel()

Specified by:

getAccessibleLabel in interface SlicedChartModel<T extends SlicedChart>

Returns:

accessible label text

setAccessibleLabel

public T setAccessibleLabel(String accessibleLabel)

Description copied from interface: SlicedChartModel

Sets accessible label text. It will be read by screen readers if user rolls-over the slice or sets focus using tab key (this is possible only if SlicedChartModelImpl.tabIndex is set to some number). Text is added as aria-label tag. Note, not all screen readers and browsers support this. If not set the default value is "[[title]]: [[percents]]% [[value]] [[description]]".

Specified by:

setAccessibleLabel in interface SlicedChartModel<T extends SlicedChart>

Parameters:

accessibleLabel - accessible label text

Returns:

sliced chart model

getLabelColorField

public Color getLabelColorField()

Specified by:

getLabelColorField in interface SlicedChartModel<T extends SlicedChart>

Returns:

label color field

setLabelColorField

public T setLabelColorField(Color labelColorField)

Description copied from interface: SlicedChartModel

Sets a field from your data provider which holds color value for the tick. Use it to set color of the label for each slice individually. If not set the default value is #000000.

Specified by:

setLabelColorField in interface SlicedChartModel<T extends SlicedChart>

Parameters:

labelColorField - label color field string

Returns:

sliced chart model

getTabIndex

public Integer getTabIndex()

Specified by:

getTabIndex in interface SlicedChartModel<T extends SlicedChart>

Returns:

tab index

setTabIndex

public T setTabIndex(Integer tabIndex)

Description copied from interface: SlicedChartModel

In case you set it to some number, the chart will set focus on a slice (starting from first) when user clicks tab key. When a focus is set, screen readers like NVDA Screen reader will read label which is set using SlicedChartModelImpl.accessibleLabel. Note, not all browsers and readers support this.

Specified by:

setTabIndex in interface SlicedChartModel<T extends SlicedChart>

Parameters:

tabIndex - the tab index

Returns:

sliced chart model

addSliceClickListener

public Subscription addSliceClickListener(Consumer<Chart.SliceClickEvent> listener)

Description copied from interface: SlicedChart

Adds a listener for a slice. Called when user clicks on the slice.

Specified by:

addSliceClickListener in interface SlicedChart<T extends SlicedChart>

Parameters:

listener - a listener to add

Returns:

subscription

onSliceClick

protected void onSliceClick(SliceClickEvent e)

addSliceRightClickListener

public Subscription addSliceRightClickListener(Consumer<Chart.SliceRightClickEvent> listener)

Description copied from interface: SlicedChart

Adds a listener for a slice. Called when user clicks on the slice.

Specified by:

addSliceRightClickListener in interface SlicedChart<T extends SlicedChart>

Parameters:

listener - a listener to add

Returns:

subscription

onSliceRightClick

protected void onSliceRightClick(SliceRightClickEvent e)

addSlicePullInListener

public Subscription addSlicePullInListener(Consumer<Chart.SlicePullInEvent> listener)

Description copied from interface: SlicedChart

Adds a listener for a slice. Called when the slice did pull-in.

Specified by:

addSlicePullInListener in interface SlicedChart<T extends SlicedChart>

Parameters:

listener - a listener to add

Returns:

subscription

onSlicePullIn

protected void onSlicePullIn(SlicePullInEvent e)

addSlicePullOutListener

public Subscription addSlicePullOutListener(Consumer<Chart.SlicePullOutEvent> listener)

Description copied from interface: SlicedChart

Adds a listener for a slice. Called when the slice did pull-out.

Specified by:

addSlicePullOutListener in interface SlicedChart<T extends SlicedChart>

Parameters:

listener - a listener to add

Returns:

subscription

onSlicePullOut

protected void onSlicePullOut(SlicePullOutEvent e)