Package io.jmix.dashboardsui.annotation

Annotation Interface DashboardWidget

@Target(TYPE)
@Retention(RUNTIME)
@Documented
public @interface DashboardWidget

Indicates that an annotated class is a widget type. Such classes must be inherited from the Widget

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	editFragmentId	Contains fragment ID for editing a widget.
String	name	The name for widget-edit screen, can be localized in main message.properties by pattern: dashboard-widget.{name} = {localization message}
String	value

Element Details

name

@AliasFor("value")
String name

The name for widget-edit screen, can be localized in main message.properties by pattern: dashboard-widget.{name} = {localization message}

Returns:

name for widget-edit screen

Default:

""

value

@AliasFor("name")
String value

Returns:

alias for name()

Default:

""

editFragmentId

String editFragmentId

Contains fragment ID for editing a widget. This fragment is embedded in the "widget-edit" screen

Returns:

fragment ID for editing a widget

Default:

""