WidgetManifestProperties

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

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

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.

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

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

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.

Default value is true.

For map widget, we can set this as false to enable other widgets to interact with map. True, means when this widget is activated, all other widgets will be deactivated. False, means when this widget is activated, will not change other widget's state.

This means there may be more than one active widgets.

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

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

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

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

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

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.

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

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

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

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

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

Default value is false.

When user click a widget, we can activate the widget (change the widget state to active), but not all widget needs this active state. So, for performance reason, we do not activate a widget by default.

When this property is true, and when a widget is activated, we'll use deactivateOtherWidgets to check whether deactivate other widgets.

Default value is false.

When a widget is put in the page/window/view/sidebar/accordion, the widget can be hidden. When a widget is scrolled out of view or is put in the screen group, we don't change the widget state to hidden. For performance reason, a widget does not get a state value when it's rendered. When this property is true, we change the widget state to hidden when it's layout container is hidden. When it's layout container is shown, we change the widget state to undefined.

For example, when this property is true and the widget is added to a view. When the view is hidden, the widget state will be changed to hidden. When the view is shown, the widget state will be changed to undefined.

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

Some widgets use fields but do not use these fields for display or not use data source to load these fields. For example, table widget uses fields but doesn't use data source to load these fields, chart widget uses fields but doesn't use these fields for display (it for statistic). In this case, we do not need to load these fields. After enable client-side query, the more fields we load, the slower the interaction with the map will be.

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.

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 .

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

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

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

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

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.