Package io.jmix.chartsflowui.kit.meta.loader

Class StudioChartsPreviewLoader

java.lang.Object

io.jmix.chartsflowui.kit.meta.loader.StudioChartsPreviewLoader

All Implemented Interfaces:

StudioPreviewComponentLoader

public class StudioChartsPreviewLoader
extends Object
implements StudioPreviewComponentLoader

Studio preview loader for the charts:chart component.

A real JmixChart is used: even without data ECharts draws the declared title, legend and axes, which is exactly what the runtime shows for an empty chart. Only the visual skeleton of the options is mapped (title text, legend, axis types, series names) — data bindings and the rest of the extensive options model stay design-time-irrelevant.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CHART_ELEMENT
protected static final String	CHARTS_SCHEMA

Fields inherited from interface io.jmix.flowui.kit.meta.component.preview.StudioPreviewComponentLoader

FRAGMENT_SCHEMA, MAIN_VIEW_SCHEMA, MAIN_VIEW_TAB_MODE_SCHEMA, VIEW_OR_FRAGMENT_SCHEMAS, VIEW_SCHEMA

Constructor Summary

Constructors

Constructor	Description
StudioChartsPreviewLoader()

Method Summary

Modifier and Type	Method	Description
protected @Nullable AbstractSeries<?>	createSeries(String tagName)
boolean	isSupported(org.dom4j.Element element)	Define the element that this loader can load.
@Nullable com.vaadin.flow.component.Component	load(org.dom4j.Element componentElement, org.dom4j.Element viewElement)	Create vaadin component from component xml element.
@Nullable com.vaadin.flow.component.Component	load(org.dom4j.Element componentElement, org.dom4j.Element viewElement, StudioPreviewEnvironment environment)	Create vaadin component from component xml element, with access to Studio-resolved context (e.g.
protected void	loadAxes(org.dom4j.Element componentElement, JmixChart chart)
protected void	loadSeries(org.dom4j.Element componentElement, JmixChart chart)
protected void	loadTitle(org.dom4j.Element componentElement, StudioPreviewEnvironment environment, JmixChart chart)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.flowui.kit.meta.component.preview.StudioPreviewComponentLoader

hasViewOrFragmentSchema, loadBoolean, loadBoolean, loadClassNames, loadComponentBaseAttributes, loadDouble, loadDouble, loadEnabled, loadEnum, loadEnum, loadFieldAttributes, loadHeight, loadInteger, loadInteger, loadLocalizedString, loadMaxHeight, loadMaxWidth, loadMinHeight, loadMinWidth, loadSizeAttributes, loadString, loadString, loadString, loadThemeNames, loadTooltip, loadWidth, propertyCaption, split, split

Field Details

CHARTS_SCHEMA

protected static final String CHARTS_SCHEMA

See Also:

• Constant Field Values

CHART_ELEMENT

protected static final String CHART_ELEMENT

See Also:

• Constant Field Values

Constructor Details

StudioChartsPreviewLoader

public StudioChartsPreviewLoader()

Method Details

isSupported

public boolean isSupported(org.dom4j.Element element)

Description copied from interface: StudioPreviewComponentLoader

Define the element that this loader can load.

Specified by:

isSupported in interface StudioPreviewComponentLoader

load

public @Nullable com.vaadin.flow.component.Component load(org.dom4j.Element componentElement,
 org.dom4j.Element viewElement)

Description copied from interface: StudioPreviewComponentLoader

Create vaadin component from component xml element.

Specified by:

load in interface StudioPreviewComponentLoader

Parameters:

componentElement - xml element of component

viewElement - xml element of view containing componentElement

See Also:

• Element

load

public @Nullable com.vaadin.flow.component.Component load(org.dom4j.Element componentElement,
 org.dom4j.Element viewElement,
 StudioPreviewEnvironment environment)

Description copied from interface: StudioPreviewComponentLoader

Create vaadin component from component xml element, with access to Studio-resolved context (e.g. localized messages, entity property captions).

Specified by:

load in interface StudioPreviewComponentLoader

Parameters:

componentElement - xml element of component

viewElement - xml element of view containing componentElement

environment - Studio-side environment; StudioPreviewEnvironment.NOOP when unavailable

See Also:

• Element

loadTitle

protected void loadTitle(org.dom4j.Element componentElement,
 StudioPreviewEnvironment environment,
 JmixChart chart)

loadAxes

protected void loadAxes(org.dom4j.Element componentElement,
 JmixChart chart)

loadSeries

protected void loadSeries(org.dom4j.Element componentElement,
 JmixChart chart)

createSeries

protected @Nullable AbstractSeries<?> createSeries(String tagName)