WidgetManifest

Interface

The widget manifest

Properties

dataActions

dataActions: DataActionProperty[]

The data actions provided by the widget

defaultSize optional

defaultSize: Size

The size when widget is added into an app.

dependency optional

dependency: string | string[]

When a widget get loaded, the dependency will be loaded first. Use this property, a widget can load some 3rd party libraries.

To do this, a widget can define its own dependency by providing an DependencyDefine extension, or just put the absolute library URL here.

Known dependency: jimu-arcgis: will load jimu-arcgis package that will load ArcGIS JavaScript API.

exbVersion

exbVersion: string

The framework version that the widget/theme depends on.

extensions optional

extensions: ExtensionProperties[]

Extensions provided by the widget.

i18nMessages

i18nMessages: any

This property is added in runtime.

Save the current locale only, but not the default locale. The default string should be written in manifest. There are some conventional keys:widgetLabel: the widget label. _actionlabel: the action label. _extlabel: the extension label. _layout_label: the layout label.

label

label: string

This should be same as the _widgetLabel value in translation/default.ts

layouts optional

layouts: object[]

Valid only when the hasEmbeddedLayout is true.

messageActions

messageActions: BaseActionProperty[]

The message actions provided by the widget.

name

name: string

The name must be unique and same as folder name.

properties optional

properties: WidgetManifestProperties

Widget manifest properties

publishMessages

publishMessages: StringSelectionChange | ExtentChange | DataRecordsSelectionChange | DataRecordSetChange | SelectDataRecord | PublishMessageProperty[]

The message types published by the widget.

translatedLocales

translatedLocales: string[]

As a convention, the default locale must be the first.

version

version: string

The widget/theme version.

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