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

Class SaveAsImageFeature

java.lang.Object

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

io.jmix.chartsflowui.kit.component.model.toolbox.ToolboxFeature

io.jmix.chartsflowui.kit.component.model.toolbox.AbstractFeature<SaveAsImageFeature>

io.jmix.chartsflowui.kit.component.model.toolbox.SaveAsImageFeature

All Implemented Interfaces:

Serializable

public class SaveAsImageFeature
extends AbstractFeature<SaveAsImageFeature>

A tool feature for exporting a chart to an image. More detailed information is provided in the documentation.

See Also:

• SaveAsImage documentation
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SaveAsImageFeature.SaveType	Type of the exported image.

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

ChartObservableObject.ObjectChangeEvent

Field Summary

Fields

Modifier and Type	Field	Description
protected Color	backgroundColor
protected Color	connectedBackgroundColor
protected String[]	excludeComponents
protected String	icon
protected String	name
protected Integer	pixelRatio
protected String	title
protected SaveAsImageFeature.SaveType	type

Fields inherited from class io.jmix.chartsflowui.kit.component.model.toolbox.AbstractFeature

emphasis, iconStyle, show

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

children, dirty, listener

Constructor Summary

Constructors

Constructor	Description
SaveAsImageFeature()

Method Summary

Modifier and Type	Method	Description
Color	getBackgroundColor()
Color	getConnectedBackgroundColor()
String[]	getExcludeComponents()
protected String	getFeatureName()
String	getIcon()
String	getName()
Integer	getPixelRatio()
String	getTitle()
SaveAsImageFeature.SaveType	getType()
void	setBackgroundColor(Color backgroundColor)
void	setConnectedBackgroundColor(Color connectedBackgroundColor)
void	setExcludeComponents(String... excludeComponents)
void	setIcon(String icon)
void	setName(String name)
void	setPixelRatio(Integer pixelRatio)
void	setTitle(String title)
void	setType(SaveAsImageFeature.SaveType type)
SaveAsImageFeature	withBackgroundColor(Color backgroundColor)
SaveAsImageFeature	withConnectedBackgroundColor(Color connectedBackgroundColor)
SaveAsImageFeature	withExcludeComponents(String... excludeComponents)
SaveAsImageFeature	withIcon(String icon)
SaveAsImageFeature	withName(String name)
SaveAsImageFeature	withPixelRatio(Integer pixelRatio)
SaveAsImageFeature	withTitle(String title)
SaveAsImageFeature	withType(SaveAsImageFeature.SaveType type)

Methods inherited from class io.jmix.chartsflowui.kit.component.model.toolbox.AbstractFeature

getEmphasis, getIconStyle, getShow, setEmphasis, setIconStyle, setShow, withEmphasis, withIconStyle, withShow

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

Field Details

type

protected SaveAsImageFeature.SaveType type

name

protected String name

backgroundColor

protected Color backgroundColor

connectedBackgroundColor

protected Color connectedBackgroundColor

excludeComponents

protected String[] excludeComponents

title

protected String title

icon

protected String icon

pixelRatio

protected Integer pixelRatio

Constructor Details

SaveAsImageFeature

public SaveAsImageFeature()

Method Details

getType

public SaveAsImageFeature.SaveType getType()

setType

public void setType(SaveAsImageFeature.SaveType type)

getName

public String getName()

setName

public void setName(String name)

getBackgroundColor

public Color getBackgroundColor()

setBackgroundColor

public void setBackgroundColor(Color backgroundColor)

getConnectedBackgroundColor

public Color getConnectedBackgroundColor()

setConnectedBackgroundColor

public void setConnectedBackgroundColor(Color connectedBackgroundColor)

getExcludeComponents

public String[] getExcludeComponents()

setExcludeComponents

public void setExcludeComponents(String... excludeComponents)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getIcon

public String getIcon()

setIcon

public void setIcon(String icon)

getPixelRatio

public Integer getPixelRatio()

setPixelRatio

public void setPixelRatio(Integer pixelRatio)

withType

public SaveAsImageFeature withType(SaveAsImageFeature.SaveType type)

withName

public SaveAsImageFeature withName(String name)

withBackgroundColor

public SaveAsImageFeature withBackgroundColor(Color backgroundColor)

withConnectedBackgroundColor

public SaveAsImageFeature withConnectedBackgroundColor(Color connectedBackgroundColor)

withExcludeComponents

public SaveAsImageFeature withExcludeComponents(String... excludeComponents)

withTitle

public SaveAsImageFeature withTitle(String title)

withIcon

public SaveAsImageFeature withIcon(String icon)

withPixelRatio

public SaveAsImageFeature withPixelRatio(Integer pixelRatio)

getFeatureName

protected String getFeatureName()

Specified by:

getFeatureName in class ToolboxFeature