Skip to main content

configuration

Passes runtime configuration to the SDK panels, overriding server-side defaults.

Description​

Setting configuration delivers an assocArray of panel configuration data to the SDK. The configuration is applied immediately to any panels already built and is automatically applied to panels built afterward. This is the field-based equivalent of calling setConfiguration() — either surface may be used.

Type​

assocArray

Usage​

m.lib.configuration = {
stats: {
refreshInterval: 30
}
}

Best Practices​

  • Set configuration before or after setting config — the SDK applies it whenever it arrives, including after panels are already built.
  • Update configuration at any time to change panel settings dynamically without restarting the SDK.
  • Prefer the configuration field when applying settings declaratively at setup; prefer setConfiguration() when you need to inspect the return value to confirm the object was accepted.
  • Pass only the keys your integration needs; the SDK preserves server-side defaults for any keys not present in the supplied object.

See also: setConfiguration()