Skip to content

Interface

The redux store state.

Properties

PropertyTypeNotes
appConfigAppConfig

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

appContextAppContext

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

appIdstring

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.

appInfoAppInfo

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

appPathstring

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

appRuntimeInfoAppRuntimeInfo

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

clientIdstring

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

dataSourcesInfo{}

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

isNetworkOffLineboolean

Indicator as to whether network is offline.

isWebTierboolean

Whether the portal is a Web-tier portal.

jimuMapViewsInfo{}

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

portalSelfany

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.

portalUrlstring

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

queryObjectUrlParameters

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

userLocaleChangedboolean

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

widgetsState{}

widgetsState is an immutable object containing the widget id and its state. A widget can put any state here to preserve the state when the widget is destroyed. There are two special state keys when a widget has layouts:

appConfig

Interface Property

appContext

Interface Property

appId

Interface Property

appInfo

Interface Property

appPath

Interface Property

appRuntimeInfo

Interface Property

clientId

optional
Interface Property

dataSourcesInfo

Interface Property

isNetworkOffLine

Interface Property

isWebTier

optional
Interface Property

jimuMapViewsInfo

Interface Property

portalSelf

Interface Property

portalUrl

optional
Interface Property

queryObject

Interface Property

userLocaleChanged

Interface Property

widgetsState

Interface Property

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