Manifest

Interface

The base interface for both widgets and themes.

Subclasses: WidgetManifest

Properties

PropertyTypeNotes
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.

any

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

string

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

string

The name must be unique and same as folder name.

boolean

Default value is false. If true, the widget will not be in ArcGIS Online.

string

The widget/theme version. The format of the version must follow this pattern: MAJOR.MINOR.PATCH, see semver for details.

exbVersion

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.

i18nMessages

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.action<action name>_label: the action label.ext<extension name>_label: the extension label.layout<layout name>_label: the layout label.

label

Interface Property
label: string

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

name

Interface Property
name: string

The name must be unique and same as folder name.

notSupportAGOL

optional
Interface Property
notSupportAGOL: boolean

Default value is false. If true, the widget will not be in ArcGIS Online.

version

Interface Property
version: string

The widget/theme version. The format of the version must follow this pattern: MAJOR.MINOR.PATCH, see semver for details.

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