Skip to content

Interface

Properties that declare the widget capability. Some properties are automatically generated on compilation, and some need to be set in the manifest.json .

Properties

PropertyTypeNotes
canConsumeDataActionboolean

Default value is false. If true, the widget can provide a data set to the data action.

canCreateMapViewboolean

Default value is false. If true, the widget will be shown in the MapWidgetSelector .

canCrossLayoutBoundaryboolean

Default value is false. By default, a widget is constrained in the layout. Setting this property to true will make the widget overflow out of the layout.

canGenerateMultipleOutputDataSourcesboolean

Default value is false. If true, the widget can generate multiple output data sources.

canProvideRepeatDataSourceboolean

Default value is false. If true, the widget can provide a repeat data source.

coverLayoutBackgroundboolean

Default value is false. By default, a widget does not have background and the background set in the layout style will take effect. If it is true, the background setting in the layout style will be hidden.

deactivateOtherWidgetsboolean

Default value is true.

defaultOffPanelboolean

This is the default value of the WidgetJson.offPanel. If true, the newly added widgets will have be off panel by default.

flipIconboolean

Default value is false. If true, flips the icon on RTL.

forbidOneByOneEffectboolean

Default value is false. If true, the layout widget can not have one by one animation.

hasBuilderSupportModuleboolean

This property is automatically set. If runtime/builder-support.tsx exists, this property is true.

hasConfigboolean

This property is automatically set. If config.json exists, this property is true.

hasConfigInSettingPageboolean

Default value is true. If false, the builder will not load the setting page. One use case of setting the value to false is when a widget supports inline editing, as it does not need to show the setting page even though it has config.

hasEmbeddedLayoutboolean

Default value is false. If true, the framework will create the layouts for the widget, see layouts property.

hasMainClassboolean

This property is automatically set. If runtime/widget.tsx exists, this property is true.

hasSettingPageboolean

This property is automatically set. If setting/setting.tsx exists, this property is true.

isWidgetControllerboolean

Default value is false. A widget controller widget is used to control (open/close) other widgets.

lockChildrenboolean

Default value is true. If true, the children layout items are constrained in the widget.

needActiveStateboolean

Default value is false.

needHiddenStateboolean

Default value is false.

notAutoLoadUsedFieldsDataboolean

Default value is false. Set this property to true, won't load the used fields of the widget.

notShareDynamicModulesboolean

By default, the widget will share dynamic modules (load by import()) with other widgets, which means these modules will be compiled into the widgets/chunks folder. If this property is true, the dynamic modules will be compiled into the chunks folder of the widget.

showDescriptionboolean

Default value is false. If true, the description of the widget will be shown in the widget list. To support i18n, please define this string key in the translations/default.ts: _widgetDescription .

supportAutoSizeboolean

Default value is true. If true, the height/width of the widget can be set to auto.

supportInlineEditingboolean

Default value is false. If true, an edit button will show when widget is selected.

supportRepeatboolean

Default value is false. If true, the widget can be put in a list.

useDragHandlerboolean

Default value is false. Will the builder provider a drag handler for this widget.

watchViewportVisibilityboolean

Default value is false. Set this property to true, the widget can use <ViewportVisibilityContext.Consumer> to get whether the widget is in the browser viewport.

canConsumeDataAction

optional
Interface Property

canCreateMapView

Interface Property

canCrossLayoutBoundary

optional
Interface Property

canGenerateMultipleOutputDataSources

optional
Interface Property

canProvideRepeatDataSource

optional
Interface Property

coverLayoutBackground

optional
Interface Property

deactivateOtherWidgets

optional
Interface Property

defaultOffPanel

optional
Interface Property

flipIcon

optional
Interface Property

forbidOneByOneEffect

Interface Property

hasBuilderSupportModule

Interface Property

hasConfig

Interface Property

hasConfigInSettingPage

Interface Property

hasEmbeddedLayout

Interface Property

hasMainClass

Interface Property

hasSettingPage

Interface Property

isWidgetController

optional
Interface Property

lockChildren

Interface Property

needActiveState

optional
Interface Property

needHiddenState

optional
Interface Property

notAutoLoadUsedFieldsData

optional
Interface Property

notShareDynamicModules

optional
Interface Property

showDescription

optional
Interface Property

supportAutoSize

Interface Property

supportInlineEditing

Interface Property

supportRepeat

Interface Property

useDragHandler

optional
Interface Property

watchViewportVisibility

optional
Interface Property

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.