State

Interface

The redux store state.

Properties

Property	Type	Notes
`appConfig`	`AppConfig`	The immutable `AppConfig` JSON object contains information about the app's configuration. For more information, see the AppConfig Interface.
`appContext`	`AppContext`	The immutable `AppContext` JSON object contains information about the app's context. Form more information, seeAppContext Interface.
`appId`	`string`	For the Experience Builder ArcGIS Online and Portal editions, `appId` is the `itemId` . For the Experience Builder Dev Edition, the `appId` is a value as a string such as 1 , 2, 3, etc. When the app is downloaded and deployed, the `appId` is `null` . When using `?config=<>` to load app, the `appId` is the config url.
`appInfo`	`AppInfo`	The immutable `AppInfo` JSON object contains information about the app including the name, a text description, a username, thumbnail, id, etc.
`appPath`	`string`	The current path in the URL, which includes the page(p1).
`appRuntimeInfo`	`AppRuntimeInfo`	The immutable `AppRuntimeInfo` JSON object contains information about the app's mode ('Run'or 'Design'), the current rendered page, and others.
`clientId`	`string`	The OAuth2 app ID from the Portal specified in the `portalUrl` .
`dataSourcesInfo`	`{ [dsId: string]: DataSourceInfo }`	`dataSourcesInfo` is an immutable object containing the immutable `DataSourceInfo` for each data source within an experience. See `DatSourceInfo` for more information.
`isNetworkOffLine`	`boolean`	Indicator as to whether network is offline.
`isWebTier`	`boolean`	Whether the portal is a Webtier portal.
`jimuMapViewsInfo`	`{ [jimuMapViewId: string]: JimuMapViewInfo }`	`jimuMapViewsInfo` is an immutable object containing the immutable `JimuMapViewInfo` for each map view within an experince. See `JimuMapViewInfo` for more information.
`portalSelf`	`any`	The response of the portal self call, used to return the view of the portal as seen by the current user, whether anonymous or signed in. More information on the `portalSelf` call can be viewed via the ArcGIS REST API.
`portalUrl`	`string`	The portal url that the app will connect to, not ending in a slash. It will look like:`http://esridevbeijing.maps.arcgis.com`
`queryObject`	`UrlParameters`	The parsed object of the location.search. The immutable `UrlParameters` interface JSON object. This includes the `locale` , the app id, the page id, etc.
`userLocaleChanged`	`boolean`	To track the user's `locale` and refresh the app once it has changed.
`widgetsState`	`{ [widgetId: string]: any }`	`widgetsState` is an immutable object containing the widget id and its state.

appConfig

Interface Property

appConfig: AppConfig

The immutable AppConfig JSON object contains information about the app's configuration. For more information, see the AppConfig Interface.

appContext

Interface Property

appContext: AppContext

The immutable AppContext JSON object contains information about the app's context. Form more information, seeAppContext Interface.

appId

Interface Property

appId: string

For the Experience Builder ArcGIS Online and Portal editions, appId is the itemId . For the Experience Builder Dev Edition, the appId is a value as a string such as 1 , 2, 3, etc. When the app is downloaded and deployed, the appId is null . When using ?config=<> to load app, the appId is the config url.

appInfo

Interface Property

appInfo: AppInfo

The immutable AppInfo JSON object contains information about the app including the name, a text description, a username, thumbnail, id, etc.

appPath

Interface Property

appPath: string

The current path in the URL, which includes the page(p1).

appRuntimeInfo

Interface Property

appRuntimeInfo: AppRuntimeInfo

The immutable AppRuntimeInfo JSON object contains information about the app's mode ('Run'or 'Design'), the current rendered page, and others.

clientId

optional

Interface Property

clientId: string

The OAuth2 app ID from the Portal specified in the portalUrl .

dataSourcesInfo

Interface Property

dataSourcesInfo: { [dsId: string]: DataSourceInfo }

dataSourcesInfo is an immutable object containing the immutable DataSourceInfo for each data source within an experience. See DatSourceInfo for more information.

Type declaration

[dsId: string]: DataSourceInfo

isNetworkOffLine

Interface Property

isNetworkOffLine: boolean

Indicator as to whether network is offline.

isWebTier

optional

Interface Property

isWebTier: boolean

Whether the portal is a Webtier portal.

jimuMapViewsInfo

Interface Property

jimuMapViewsInfo: { [jimuMapViewId: string]: JimuMapViewInfo }

jimuMapViewsInfo is an immutable object containing the immutable JimuMapViewInfo for each map view within an experince. See JimuMapViewInfo for more information.

Type declaration

[jimuMapViewId: string]: JimuMapViewInfo

portalSelf

Interface Property

portalSelf: any

The response of the portal self call, used to return the view of the portal as seen by the current user, whether anonymous or signed in. More information on the portalSelf call can be viewed via the ArcGIS REST API.

portalUrl

optional

Interface Property

portalUrl: string

The portal url that the app will connect to, not ending in a slash. It will look like:http://esridevbeijing.maps.arcgis.com

If the appConfig has a portalUrl , it will be copied to this property, or we'll get the portalUrl through other logic, such as via the browser URL, user input, etc.

The portalUrl can have a null value. However, the portalUrl in appConfig will always be set via the builder.

queryObject

Interface Property

queryObject: UrlParameters

The parsed object of the location.search. The immutable UrlParameters interface JSON object. This includes the locale , the app id, the page id, etc.

userLocaleChanged

Interface Property

userLocaleChanged: boolean

To track the user's locale and refresh the app once it has changed.

widgetsState

Interface Property

widgetsState: { [widgetId: string]: any }

widgetsState is an immutable object containing the widget id and its state.

Type declaration

[widgetId: string]: any