Interface
The widget manifest
Properties
| Property | Type | Notes |
|---|---|---|
The data actions provided by the widget | ||
Size & { autoHeight?: boolean; autoWidth?: boolean } | 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. | |
exbVersioninherited | 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 data actions in setting and runtime | |
Extensions provided by the widget. | ||
i18nMessagesinherited | any | You don't need to add this property in your code, this property is added at runtime. |
labelinherited | string | This should be same as the |
{ label: string; name: string; type?: string }[] | Valid only when the | |
The message actions provided by the widget. | ||
nameinherited | string | The name must be unique and same as folder name. |
notAllowAddinherited | boolean | Whether the widget can be added to the app, default is false. Widgets that will be deprecated can set this property to true. The code is still available, but the widget will not be shown in the widget list. |
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. | |
{ label: string; name: string; tooltip?: string }[] | Declare the URL parameters that the widget supports | |
versioninherited | string | The widget/theme version. The format of the version must follow this pattern: MAJOR.MINOR.PATCH, see semver for details. |
dataActions
dataActions: DataActionProperty[]The data actions provided by the widget
defaultSize
defaultSize: Size & { autoHeight?: boolean; autoWidth?: boolean }The initial size the widget will be when added into an app.
dependency
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-arcgispackage that will load the ArcGIS Maps SDK for JavaScript.
exbVersion
exbVersion: stringA 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.
excludeDataActions
excludeDataActions: string[]Exclude those data actions in setting and runtime
extensions
extensions: ExtensionProperties[]Extensions provided by the widget.
i18nMessages
i18nMessages: anyYou 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.action<action name>_label: the action label.ext<extension name>_label: the extension label.layout<layout name>_label: the layout label.
label
label: stringThis should be same as the _widgetLabel value in translation/default.ts
layouts
layouts: { label: string; name: string; type?: string }[]Valid only when the hasEmbeddedLayout is true.
messageActions
messageActions: BaseActionProperty[]The message actions provided by the widget.
notAllowAdd
notAllowAdd: booleanWhether the widget can be added to the app, default is false. Widgets that will be deprecated can set this property to true. The code is still available, but the widget will not be shown in the widget list.
properties
properties: WidgetManifestPropertiesWidget manifest properties
publishMessages
publishMessages: MessageType | MessageDescription[]The message types published by the widget.
requireEnterprise
requireEnterprise: booleanDefault value is false. If true, the widget requires an ArcGIS Enterprise subscription.
settingDependency
settingDependency: string | string[]Dependency for setting component. See WidgetManifest.dependency
translatedLocales
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.
urlParameters
urlParameters: { label: string; name: string; tooltip?: string }[]Declare the URL parameters that the widget supports
version
version: stringThe widget/theme version. The format of the version must follow this pattern: MAJOR.MINOR.PATCH, see semver for details.