Main benefits of the Foundation SDK

Using the Foundation SDK provides two main benefits: strong typing and builder blocks.

Catch errors early with strong typing

The Foundation SDK is strongly typed, so the compiler can check your dashboard as you write it. Instead of discovering a broken dashboard after deployment, you see problems while you’re still writing code:

  • Invalid unit values: You catch invalid units during development, before they reach production dashboards.
  • Wrong data types for fields: If a field expects one type and gets another, the compiler fails fast with a clear error.
  • Missing required configuration: Required settings are enforced up front, so incomplete panel definitions do not ship.

Use option builders for complex settings

An option builder is a typed helper the SDK provides to configure one nested part of a panel or dashboard.

When configuration gets nested, option builders provide typed helpers for those subsections. They keep complex configuration readable while still giving you typed validation:

Option builderControls
ReduceDataOptionsHow to reduce time series into single values (last, avg, sum)
VizLegendOptionsLegend display mode, placement, values shown
ThresholdsConfigColor-coded value thresholds
FieldConfigPer-field display overrides

Script

The Foundation SDK uses strong typing, so the compiler catches invalid units, wrong field types, and missing required configuration before deployment.

For nested settings, the SDK provides option builders such as ReduceDataOptions, VizLegendOptions, ThresholdsConfig, and FieldConfig. These keep complex configuration readable while still using typed validation.