WidgetManifest

Interface

The widget manifest

Inheritance: WidgetManifestManifest

Properties

Hide inherited properties
PropertyTypeNotes
DataActionProperty[]

The batch data actions provided by the widget

DataActionProperty[]

The data actions provided by the widget

Size & {}

The initial size the widget will be when added into an app.

string | string[]

Use this property to load third-party libraries. Pass an absolute URL to a library. See the Using third-party libraries guide for more information.

exbVersion
 inherited 
string

A widget may only support certain framework versions due to breaking API changes, so this property allows the widget/theme to define the framework version that it supports. This version check is not currently enforced, but will be enforced in the future.

string[]

Exclude those batch data actions in setting and runtime

string[]

Exclude those data actions in setting and runtime

Extensions provided by the widget.

i18nMessages
 inherited 
any

You don't need to add this property in your code, this property is added at runtime.

label
 inherited 
string

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

{}[]

Valid only when the hasEmbeddedLayout is true.

BaseActionProperty[]

The message actions provided by the widget.

name
 inherited 
string

The name must be unique and same as folder name.

Widget manifest properties

The message types published by the widget.

boolean

Default value is false. If true, the widget requires an ArcGIS Enterprise subscription.

string | string[]

Dependency for setting component. See WidgetManifest.dependency

string[]

The translated locales the widget provides. Each entry should be a string representing the language version as defined in BCP 47. Examples of valid language codes include "en", "en-US", "fr", "fr-FR", "es-ES", etc. By convention, the default locale is listed first.

version
 inherited 
string

The widget/theme version.

batchDataActions

optional
Interface Property
batchDataActions: DataActionProperty[]

The batch data actions provided by the widget

dataActions

optional
Interface Property
dataActions: DataActionProperty[]

The data actions provided by the widget

defaultSize

optional
Interface Property
defaultSize: Size & {}

The initial size the widget will be when added into an app.

dependency

optional
Interface Property
dependency: string | string[]

Use this property to load third-party libraries. Pass an absolute URL to a library. See the Using third-party libraries guide for more information.

Alternatively, a widget can define its own dependencies by providing aDependencyDefine extension.

Pre-defined dependencies:

  • jimu-arcgis: will load the jimu-arcgis package that will load the ArcGIS API for JavaScript.

exbVersion

inherited
Interface Property
exbVersion: string

A widget may only support certain framework versions due to breaking API changes, so this property allows the widget/theme to define the framework version that it supports. This version check is not currently enforced, but will be enforced in the future.

Inherited from Manifest.exbVersion

excludeBatchDataActions

optional
Interface Property
excludeBatchDataActions: string[]

Exclude those batch data actions in setting and runtime

excludeDataActions

optional
Interface Property
excludeDataActions: string[]

Exclude those data actions in setting and runtime

extensions

optional
Interface Property
extensions: ExtensionProperties[]

Extensions provided by the widget.

i18nMessages

inherited
Interface Property
i18nMessages: any

You don't need to add this property in your code, this property is added at 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.

Inherited from Manifest.i18nMessages

label

inherited
Interface Property
label: string

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

Inherited from Manifest.label

layouts

optional
Interface Property
layouts: {}[]

Valid only when the hasEmbeddedLayout is true.

messageActions

optional
Interface Property
messageActions: BaseActionProperty[]

The message actions provided by the widget.

name

inherited
Interface Property
name: string

The name must be unique and same as folder name.

Inherited from Manifest.name

properties

optional
Interface Property
properties: WidgetManifestProperties

Widget manifest properties

publishMessages

optional
Interface Property
publishMessages: MessageType | MessageDescription[]

The message types published by the widget.

requireEnterprise

optional
Interface Property
requireEnterprise: boolean

Default value is false. If true, the widget requires an ArcGIS Enterprise subscription.

settingDependency

optional
Interface Property
settingDependency: string | string[]

Dependency for setting component. See WidgetManifest.dependency

translatedLocales

optional
Interface Property
translatedLocales: string[]

The translated locales the widget provides. Each entry should be a string representing the language version as defined in BCP 47. Examples of valid language codes include "en", "en-US", "fr", "fr-FR", "es-ES", etc. By convention, the default locale is listed first.

version

inherited
Interface Property
version: string

The widget/theme version.

Inherited from Manifest.version

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