Type alias AppConfig

AppConfig: object

Application configuration

Type declaration

accessibilityConfig

accessibilityConfig?: object

Accessibility configuration. Set the accessibilityConfig.enabled property to true to enable accessibility features for charts built with Highcharts.

Once the accessibility configuration in enabled, you can use the default descriptions or choose to create custom configurations for the descriptions of a chart, its axes, its series, and values description formatting. To create custom configurations, use the highchartsOptions object that is passed to the BeforeRenderHandler of the chart's onBeforeRender callback. Modify the object using the accessibility options as described in the Accessibility module documentation (opens new window).

Note that enabling accessibility also causes markers to appear in charts even if they are disabled using the chart's styleOptions.

This feature is in alpha.

accessibilityConfig.enabled

enabled?: boolean

Whether to enable accessibility features

If not specified, the default value is false

---

dateConfig

dateConfig?: DateConfig

Date Configurations

---

errorBoundaryConfig

errorBoundaryConfig?: object

Configuration of the component that is rendered in case of an error

errorBoundaryConfig.alwaysShowErrorText

alwaysShowErrorText?: boolean

Whether to show error text without hovering over the error icon

If not specified, the default value is false

---

jumpToDashboardConfig

jumpToDashboardConfig?: object

Configuration of the Jump To Dashboard feature

This feature is currently in Beta.

Note: Only widgets that are configured using the Fusion UI as documented here (opens new window) are supported in Compose SDK.

Widgets that are configured using an older version of Jump To Dashboard, or via scripts, are not supported.

Known limitations:

• Jump To Dashboard is not currently supported for Pivot widgets.
• Target dashboards are always opened in a popup window, options to open in new tab and new window are not supported.
• Show 'Header' and 'Dashboards panel' options are not supported (only relevant to Fusion).
• 'Reset filters after JTD' is not supported, since changes are never saved to the target dashboard using Compose SDK.

The following Jump To Dashboard configuration is supported:

• Target dashboard set by Id, with configurable display title
• 'Popup window' display type ('Allow Resize' not supported)
• Display filter panel on the target dashboard (true/false)
• Navigation setting (Click / Right click)
  • Note: 'Keep changes made by user' is not supported, since changes are never saved to the target dashboard using Compose SDK.
• Apply filters to the target dashboard (select)
• Merge target dashboard filters (true/false)

jumpToDashboardConfig.enabled

enabled?: boolean

Whether to enable or disable the Jump To Dashboard feature

If not specified, the default value is true

---

loadingIndicatorConfig

loadingIndicatorConfig?: LoadingIndicatorConfig

Loading Indicator Configurations

---

locale

locale?: Locale

A date-fns Locale (opens new window)

---

queryCacheConfig

queryCacheConfig?: object

Query Cache Configurations.

See Client query caching guide for more details.

queryCacheConfig.enabled

enabled?: boolean

Whether to enable client-side query caching.

If not specified, the default value is false

---

queryLimit

queryLimit?: number

Query limit (max rows count that will be fetched in query)

Default

20000

---

tabberConfig

tabberConfig?: object

Configuration of the tabber widgets feature

Only tabber widgets that are configured using the Fusion UI as documented here (opens new window) are supported.

tabberConfig.enabled

enabled?: boolean

Whether to enable tabber widget support

If not specified, the default value is true

Deprecated

Tabber widgets are now supported by default and this property is no longer needed.

---

trackingConfig

trackingConfig?: object

Tracking configuration

trackingConfig.onTrackingEvent

onTrackingEvent?: (payload) => void

Callback to be invoked when tracking event occurs

Parameters

Parameter	Type
payload	TrackingEventDetails

Returns

void

---

translationConfig

translationConfig?: TranslationConfig

Translation Configuration