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
Property | Type | Notes |
---|---|---|
boolean | Default value is false. If true, the widget can provide a data set to the data action. | |
boolean | Default value is false. If true, the widget will be shown in the | |
boolean | 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. | |
boolean | Default value is false. If true, the widget can generate mulitple output data sources. | |
boolean | Default value is false. If true, the widget can provide a repeat data source. | |
boolean | 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. | |
boolean | Default value is true. | |
boolean | Default value is false. If true, flips the icon on RTL. | |
boolean | This property is automatically set. If | |
boolean | This property is automatically set. If | |
boolean | Default value is true.
If false, the builder will not load the setting page.
One use case of setting the value to | |
boolean | Default value is false. If true, the framework will create the layouts for the widget, see | |
boolean | This property is automatically set. If | |
boolean | This property is automatically set. If | |
boolean | Default value is false. A widget controller widget is used to control (open/close) other widgets. | |
boolean | Default value is true. If true, the children layout items are constrained in the widget. | |
boolean | Default value is false. | |
boolean | Default value is false. Set this property to true, won't load the used fields of the widget. | |
boolean | Default value is true. If true, the height/width of the widget can be set to auto. | |
boolean | Default value is false. If true, an edit button will show when widget is selected. | |
boolean | Default value is false. If true, the widget can be put in a list. | |
boolean | Default value is false. Will the builder provider a drag handler for this widget. | |
boolean | Default value is false.
Set this property to true, the widget can use |
canConsumeDataAction
canConsumeDataAction: boolean
Default value is false. If true, the widget can provide a data set to the data action.
canCreateMapView
Interface PropertycanCreateMapView: boolean
Default value is false. If true, the widget will be shown in the MapWidgetSelector
.
canCrossLayoutBoundary
canCrossLayoutBoundary: boolean
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.
canGenerateMultipleOutputDataSources
canGenerateMultipleOutputDataSources: boolean
Default value is false. If true, the widget can generate mulitple output data sources.
canProvideRepeatDataSource
canProvideRepeatDataSource: boolean
Default value is false. If true, the widget can provide a repeat data source.
coverLayoutBackground
coverLayoutBackground: boolean
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.
deactivateOtherWidgets
deactivateOtherWidgets: boolean
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.
flipIcon
flipIcon: boolean
Default value is false. If true, flips the icon on RTL.
hasBuilderSupportModule
Interface PropertyhasBuilderSupportModule: boolean
This property is automatically set. If runtime/builder-support.tsx
exists, this property is true.
hasConfig
Interface PropertyhasConfig: boolean
This property is automatically set. If config.json
exists, this property is true.
hasConfigInSettingPage
Interface PropertyhasConfigInSettingPage: boolean
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.
hasEmbeddedLayout
Interface PropertyhasEmbeddedLayout: boolean
Default value is false. If true, the framework will create the layouts for the widget, see layouts
property.
hasMainClass
Interface PropertyhasMainClass: boolean
This property is automatically set. If runtime/widget.tsx
exists, this property is true.
hasSettingPage
Interface PropertyhasSettingPage: boolean
This property is automatically set. If setting/setting.tsx
exists, this property is true.
isWidgetController
isWidgetController: boolean
Default value is false. A widget controller widget is used to control (open/close) other widgets.
lockChildren
Interface PropertylockChildren: boolean
Default value is true. If true, the children layout items are constrained in the widget.
needActiveState
needActiveState: boolean
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.
notAutoLoadUsedFieldsData
notAutoLoadUsedFieldsData: boolean
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.
supportAutoSize
Interface PropertysupportAutoSize: boolean
Default value is true. If true, the height/width of the widget can be set to auto.
supportInlineEditing
Interface PropertysupportInlineEditing: boolean
Default value is false. If true, an edit button will show when widget is selected.
supportRepeat
Interface PropertysupportRepeat: boolean
Default value is false. If true, the widget can be put in a list.