Package io.jmix.dashboardsui.component

Interface Dashboard

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, CompositeWithCaption, CompositeWithDescription, CompositeWithIcon

All Known Implementing Classes:

DashboardImpl

public interface Dashboard
extends Component, Component.BelongToFrame, CompositeWithIcon, CompositeWithCaption, CompositeWithDescription

UI representation of DashboardModel.

Dashboard can be configured by DashboardModel.code or by the classpath of dashboard.json It is possible to add (or rewrite) primitive parameters in the dashboard.

Nested Class Summary

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method	Description
String	getAssistantBeanName()	Returns assistant bean name
DashboardModel	getDashboardModel()
int	getTimerDelay()	Returns delay for timer
ScreenFragment	getWidget(String widgetId)	Returns widget by passed id.
void	init(Map<String,Object> params)	Initialize dashboard with passed parameters, timer and assistant.
void	refresh()	Refreshes dashboard.
void	refresh(Map<String,Object> params)	Refreshes dashboard with passed parameters.
void	setAssistantBeanName(String assistantBeanName)	Set assistant bean name
void	setCode(String code)	Dashboard can be configured by setting code of existing dashboard To apply new changes the init(Map) method required to be invoked
void	setJsonPath(String jsonPath)	Dashboard can be configured from json file
void	setTimerDelay(int delay)	Set delay for dashboard timer
void	setXmlParameters(List<Parameter> parameters)	Sets passed parameters to dashboard component

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.CompositeWithCaption

getCaption, setCaption

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

getDescription, setDescription

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

getIcon, setIcon, setIconFromSet

Field Details

NAME

static final String NAME

See Also:

• Constant Field Values

Method Details

init

void init(Map<String,Object> params)

Initialize dashboard with passed parameters, timer and assistant.

Parameters:

params - map of dashboard params

getDashboardModel

DashboardModel getDashboardModel()

Returns:

dashboard entity

getWidget

@Nullable
ScreenFragment getWidget(String widgetId)

Returns widget by passed id.

Parameters:

widgetId - widget identifier

Returns:

widget fragment

refresh

void refresh()

Refreshes dashboard. Dashboard will be refreshed . If existed parameter has the same name as one of the param from passed map, it will be overwritten by param from map.

refresh

void refresh(Map<String,Object> params)

Refreshes dashboard with passed parameters. Dashboard will be refreshed with merged existed and new parameters. If existed parameter has the same name as one of the param from passed map, it will be overwritten by param from map.

Parameters:

params - map with new dashboard parameters

setCode

void setCode(String code)

Dashboard can be configured by setting code of existing dashboard To apply new changes the init(Map) method required to be invoked

Parameters:

code - another dashboard code

setJsonPath

void setJsonPath(String jsonPath)

Dashboard can be configured from json file

Parameters:

jsonPath - path to json configuration file

setXmlParameters

void setXmlParameters(List<Parameter> parameters)

Sets passed parameters to dashboard component

Parameters:

parameters - list of parameters to be set

setTimerDelay

void setTimerDelay(int delay)

Set delay for dashboard timer

Parameters:

delay - delay time in seconds

getTimerDelay

int getTimerDelay()

Returns delay for timer

Returns:

delay time in seconds

getAssistantBeanName

String getAssistantBeanName()

Returns assistant bean name

Returns:

name of assistant bean

setAssistantBeanName

void setAssistantBeanName(String assistantBeanName)

Set assistant bean name

Parameters:

assistantBeanName - name of the assistant bean