Dashboard configuration

Example

apiVersion: leapview.dev/v1
kind: Dashboard
metadata:
  id: dashboard:executive-sales
  name: executive-sales
  displayName: Executive Sales
  description: Revenue, AOV, category, and order volume overview.
  owner: Analytics
  tags:
  - sales
  - revenue
spec:
  appearance:
    icon: chart-no-axes-combined
    color: purple
  semanticModel: sales
  filters:
  - id: purchase_date
    label: Purchase date
    dimension: purchase_date
    control:
      type: dateRange
    urlParameter: period
    operators: []
  - id: state
    label: State
    dimension: state
    control:
      type: multiSelect
      maxSelectedValues: 50
      options:
        type: distinct
        dataset: sales_orders
        limit: 50
    operators:
    - in
    - notIn
    urlParameter: state
  - id: category
    label: Category
    dimension: category
    control:
      type: text
    operators:
    - contains
    - equals
    - startsWith
    - notContains
    urlParameter: category
  visuals:
    - id: revenue_kpi
      type: kpi
      title: Revenue
      query:
        type: aggregate
        dimensions: []
        metrics:
        - revenue
      presentation:
        type: kpi
        note: Payment value
        tone: success
    - id: aov_kpi
      type: kpi
      title: Average order value
      query:
        type: aggregate
        dimensions: []
        metrics:
        - aov
      presentation:
        type: kpi
        note: Revenue per order
        tone: warning
    - id: total_orders
      type: kpi
      title: Total orders
      query:
        type: aggregate
        dimensions: []
        metrics:
        - order_count
      presentation:
        type: kpi
        note: Filtered order count
        tone: ink
    - id: revenue_by_month
      type: area
      query:
        type: aggregate
        dimensions:
        - dimension: purchase_date
          grain: month
          alias: purchase_month
        metrics:
        - revenue
        sort:
        - field: purchase_month
          direction: asc
        limit: 30
      title: Revenue by month
      presentation:
        type: cartesian
    - id: category_revenue
      type: bar
      query:
        type: aggregate
        dimensions:
        - category
        metrics:
        - revenue
        sort:
        - field: revenue
          direction: desc
        limit: 10
      title: Top categories by revenue
      presentation:
        type: cartesian
    - id: orders_table
      type: table
      query:
        type: records
        dataset: sales_orders
        fields:
        - order_id
        - purchase_date
        - status
        - category
        - revenue
      title: Orders
      presentation:
        type: table
        rowHeight: 32
        showHeader: true
        striped: false
  pages:
  - id: overview
    title: Overview
    components:
    - id: purchase-date-filter
      placement:
        column: 1
        row: 1
        columnSpan: 4
        rowSpan: 2
      type: filter
      filter: purchase_date
    - id: state-filter
      placement:
        column: 5
        row: 1
        columnSpan: 4
        rowSpan: 2
      type: filter
      filter: state
    - id: category-filter
      placement:
        column: 9
        row: 1
        columnSpan: 4
        rowSpan: 2
      type: filter
      filter: category
    - id: total-orders
      placement:
        column: 1
        row: 3
        columnSpan: 4
        rowSpan: 3
      type: visual
      visual: total_orders
    - id: revenue
      placement:
        column: 5
        row: 3
        columnSpan: 4
        rowSpan: 3
      type: visual
      visual: revenue_kpi
    - id: aov
      placement:
        column: 9
        row: 3
        columnSpan: 4
        rowSpan: 3
      type: visual
      visual: aov_kpi
    - id: revenue-trend
      placement:
        column: 1
        row: 6
        columnSpan: 12
        rowSpan: 6
      type: visual
      visual: revenue_by_month
    - id: categories
      placement:
        column: 1
        row: 12
        columnSpan: 12
        rowSpan: 6
      type: visual
      visual: category_revenue
    - id: orders_table
      placement:
        column: 1
        row: 18
        columnSpan: 12
        rowSpan: 8
      type: visual
      visual: orders_table
  layout:
    columns: 12
    rowHeight: 48
    gap: 16
    padding: 16

Fields

Field	Type	Required	Rules

Nested definitions

AggregateDashboardQuery

Field	Type	Required	Rules
`dimensions`	array of `DashboardDimensionSelection`	Yes
`limit`	integer	No
`metrics`	array of `DashboardMetricSelection`	Yes
`sort`	array of `DashboardSort`	No
`type`	string	Yes	one of `aggregate`

BooleanDashboardFilterValue

Field	Type	Required	Rules
`type`	string	Yes	one of `boolean`
`value`	boolean	Yes

CartesianDashboardPresentation

Field	Type	Required	Rules
`axes`	array of `DashboardAxisConfiguration`	No
`dataZoom`	boolean	No
`displayUnits`	`VisualizationDisplayUnits`	No
`eventAnnotations`	array of `DashboardEventAnnotation`	No
`gainColor`	`VisualizationColorIntent`	No
`labelPosition`	`DashboardLabelPosition`	No
`labels`	`DashboardLabelPolicy`	No
`legend`	`DashboardLegendPosition`	No
`legendItems`	array of `DashboardLegendItem`	No
`legendTitle`	string	No
`lossColor`	`VisualizationColorIntent`	No
`orientation`	`DashboardOrientation`	No
`referenceBands`	array of `DashboardReferenceBand`	No
`referenceLines`	array of `DashboardReferenceLine`	No
`series`	array of `DashboardComboSeries`	No
`seriesIntent`	array of `DashboardSeriesIntent`	No
`showSymbols`	boolean	No
`smooth`	boolean	No
`stacking`	`DashboardStackingMode`	No
`step`	boolean	No
`symbolSize`	number	No
`tooltip`	array of `DashboardTooltip`	No
`type`	string	Yes	one of `cartesian`

CompactVisualizationFormat

Field	Type	Required	Rules
`kind`	string	Yes	one of `compact`
`maximumFractionDigits`	integer	No

ComparisonDashboardFilterExpression

Field	Type	Required	Rules
`operator`	`DashboardFilterOperator`	Yes
`type`	string	Yes	one of `comparison`
`value`	`DashboardFilterValue`	Yes

CurrencyVisualizationFormat

Field	Type	Required	Rules
`currency`	string	Yes
`kind`	string	Yes	one of `currency`
`maximumFractionDigits`	integer	No
`minimumFractionDigits`	integer	No

DashboardAccessibility

Field	Type	Required
`announceChanges`	boolean	No
`description`	string	No
`summary`	string	No
`title`	string	No

DashboardApiVersion

Field	Type	Required	Rules

DashboardAppearance

Field	Type	Required	Rules
`color`	`DashboardAppearanceColor`	No
`icon`	string	No

DashboardAppearanceColor

Field	Type	Required	Rules

DashboardAxisConfiguration

Field	Type	Required
`dateUnit`	`VisualizationDateDisplayUnit`	No
`displayUnits`	`VisualizationDisplayUnits`	No
`grid`	`VisualizationAxisGridVisibility`	No
`id`	`VisualizationCartesianAxis`	Yes
`inversion`	`VisualizationAxisInversion`	No
`labelRotation`	`VisualizationAxisLabelRotation`	No
`maximum`	number	No
`minimum`	number	No
`scale`	`VisualizationAxisScale`	Yes
`tickDensity`	`VisualizationAxisTickDensity`	Yes
`ticks`	`VisualizationAxisTickVisibility`	No
`title`	string	No
`type`	`VisualizationAxisType`	No
`unit`	string	No
`zero`	`VisualizationAxisZeroPolicy`	Yes

DashboardCalculation

Field	Type	Required	Rules
`axis`	`VisualizationCalculationAxis`	No
`hidden`	boolean	No
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`label`	string	No
`lookup`	`DashboardCalculationLookup`	No
`offset`	integer	No
`orderBy`	array of `DashboardSort`	No
`parent`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`partitionBy`	array of string	No
`reset`	`VisualizationCalculationReset`	No
`source`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`template`	`VisualizationCalculationTemplate`	Yes
`window`	integer	No

DashboardCalculationLookup

Field	Type	Required	Rules
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`value`	string	Yes

DashboardChoroplethGeographicLayer

Field	Type	Required	Rules
`category`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`color`	`DashboardMapColorScale`	No
`geometryAsset`	string	Yes
`join`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`kind`	string	Yes	one of `choropleth`
`label`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`opacity`	number	No
`stroke`	`DashboardMapStroke`	No
`value`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardComboSeries

Field	Type	Required	Rules
`axis`	`DashboardComboSeriesAxis`	Yes
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`mark`	`DashboardComboSeriesMark`	Yes

DashboardComboSeriesAxis

Field	Type	Required	Rules

DashboardComboSeriesMark

Field	Type	Required	Rules

DashboardConditionalFormat

Field	Type	Required	Rules
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`rule`	`DashboardConditionalRule`	Yes
`target`	`VisualizationConditionalTarget`	Yes

DashboardConditionalRule

Field	Type	Required	Rules

DashboardConditionalRuleBase

Field	Type	Required	Rules
`kind`	string	Yes

DashboardConditionalStyle

Field	Type	Required	Rules
`color`	`VisualizationColorIntent`	No
`icon`	`VisualizationIconIntent`	No

DashboardConditionalThreshold

Field	Type	Required
`operator`	`VisualizationComparisonOperator`	Yes
`style`	`DashboardConditionalStyle`	Yes
`value`	number	Yes

DashboardDataBudget

Field	Type	Required	Rules
`maxRows`	integer	Yes
`requiredCompleteness`	`VisualizationCompleteness`	No

DashboardDensityGeographicLayer

Field	Type	Required	Rules
`color`	`DashboardMapColorScale`	No
`heat`	`DashboardMapHeatStyle`	No
`kind`	string	Yes	one of `density`
`latitude`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`longitude`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`opacity`	number	No
`value`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardDimensionReference

Field	Type	Required	Rules
`alias`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`dimension`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`grain`	`DashboardTimeGrain`	No

DashboardDimensionSelection

Field	Type	Required	Rules

DashboardDistributionOutlierPolicy

Field	Type	Required	Rules

DashboardDistributionWhiskers

Field	Type	Required	Rules
`lower`	number	Yes
`upper`	number	Yes

DashboardDocument

Field	Type	Required
`apiVersion`	`DashboardApiVersion`	Yes
`kind`	`DashboardResourceKind`	Yes
`metadata`	`DashboardMetadata`	Yes
`spec`	`DashboardSpec`	Yes

DashboardEventAnnotation

Field	Type	Required	Rules
`axis`	`VisualizationCartesianAxis`	Yes
`description`	string	No
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`label`	string	Yes
`tone`	`VisualizationTone`	Yes
`value`	`DashboardReferenceValue`	Yes

DashboardFieldConditionalRule

Field	Type	Required	Rules
`defaultStyle`	`DashboardConditionalStyle`	Yes
`kind`	string	Yes	one of `field`
`nullStyle`	`DashboardConditionalStyle`	Yes
`source`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`values`	object	Yes

DashboardFilter

Field	Type	Required	Rules
`control`	`DashboardFilterControl`	Yes
`default`	`DashboardFilterExpression`	No
`description`	string	No
`dimension`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`label`	string	Yes
`operators`	array of `DashboardFilterOperator`	No
`readerEditable`	boolean	No
`required`	boolean	No
`targets`	array of string	No
`urlParameter`	string	No	pattern `^[A-Za-z][A-Za-z0-9_-]{0,63}$`

DashboardFilterBound

Field	Type	Required	Rules
`inclusive`	boolean	Yes
`value`	`DashboardFilterValue`	Yes

DashboardFilterControl

Field	Type	Required	Rules

DashboardFilterControlBase

Field	Type	Required	Rules
`type`	string	Yes

DashboardFilterExpression

Field	Type	Required	Rules

DashboardFilterExpressionBase

Field	Type	Required	Rules
`type`	string	Yes

DashboardFilterOperator

Field	Type	Required	Rules

DashboardFilterOption

Field	Type	Required	Rules
`label`	string	Yes
`value`	`DashboardFilterValue`	Yes

DashboardFilterOptions

Field	Type	Required	Rules

DashboardFilterOptionsBase

Field	Type	Required	Rules
`type`	string	Yes

DashboardFilterValue

Field	Type	Required	Rules

DashboardFilterValueBase

Field	Type	Required	Rules
`type`	string	Yes

DashboardGeographicLayer

Field	Type	Required	Rules

DashboardGeographicLayerBase

Field	Type	Required	Rules
`kind`	string	Yes

DashboardGeographicLayerOptions

Field	Type	Required	Rules
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`maximumZoom`	number	No
`minimumZoom`	number	No
`position`	`VisualizationMapLayerPosition`	No
`tooltip`	array of `DashboardTooltip`	No

DashboardGradientConditionalRule

Field	Type	Required	Rules
`high`	`DashboardConditionalStyle`	Yes
`kind`	string	Yes	one of `gradient`
`low`	`DashboardConditionalStyle`	Yes
`maximum`	number	Yes
`minimum`	number	Yes
`nullStyle`	`DashboardConditionalStyle`	Yes

DashboardHeatGeographicLayer

Field	Type	Required	Rules
`color`	`DashboardMapColorScale`	No
`heat`	`DashboardMapHeatStyle`	No
`kind`	string	Yes	one of `heat`
`latitude`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`longitude`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`opacity`	number	No
`value`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardHistogramApproximation

Field	Type	Required	Rules

DashboardHistogramDomain

Field	Type	Required	Rules
`maximum`	number	No
`minimum`	number	No

DashboardHistogramNullPolicy

Field	Type	Required	Rules

DashboardIncludes

Field	Type	Required
`components`	array of string	No
`filters`	array of string	No
`pages`	array of string	No
`visuals`	array of string	No

DashboardInteraction

Field	Type	Required	Rules

DashboardInteractionBase

Field	Type	Required	Rules
`targets`	array of string	No
`type`	string	Yes

DashboardInteractionMapping

Field	Type	Required	Rules
`dataset`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`grain`	`DashboardTimeGrain`	No
`label`	string	No
`value`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardKPITrendBinding

Field	Type	Required	Rules
`category`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`dataset`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`value`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardKPIValueBinding

Field	Type	Required	Rules
`dataset`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`label`	string	Yes
`reducer`	`VisualizationReferenceReducer`	No

DashboardLabelDensity

Field	Type	Required	Rules

DashboardLabelPolicy

Field	Type	Required
`density`	`DashboardLabelDensity`	Yes
`maxCharacters`	integer	No
`minimumSpacing`	integer	No
`priority`	array of `DashboardLabelPriority`	No
`tooltipFallback`	boolean	No

DashboardLabelPosition

Field	Type	Required	Rules

DashboardLabelPriority

Field	Type	Required	Rules

DashboardLayoutDefaults

Field	Type	Required
`columns`	integer	Yes
`gap`	integer	Yes
`padding`	integer	Yes
`rowHeight`	integer	Yes

DashboardLayoutOverride

Field	Type	Required
`columns`	integer	No
`gap`	integer	No
`padding`	integer	No
`rowHeight`	integer	No

DashboardLegendItem

Field	Type	Required	Rules
`label`	string	No
`value`	string	Yes

DashboardLegendPosition

Field	Type	Required	Rules

DashboardMapCamera

Field	Type	Required
`center`	array of number	No
`maximumZoom`	number	No
`minimumZoom`	number	No
`mode`	`VisualizationMapCameraMode`	No
`padding`	integer	No
`zoom`	number	No

DashboardMapCluster

Field	Type	Required
`enabled`	boolean	No
`maximumZoom`	integer	No
`minimumPoints`	integer	No
`radius`	integer	No
`showCount`	boolean	No

DashboardMapColorScale

Field	Type	Required
`domainMaximum`	number	No
`domainMidpoint`	number	No
`domainMinimum`	number	No
`kind`	`VisualizationMapColorScaleKind`	No
`nullColor`	string	No
`palette`	string	No
`reverse`	boolean	No

DashboardMapControls

Field	Type	Required
`compass`	boolean	No
`reset`	boolean	No
`zoom`	boolean	No

DashboardMapHeatStyle

Field	Type	Required	Rules
`intensity`	number	No
`radius`	number	No

DashboardMapLineStyle

Field	Type	Required	Rules
`width`	number	No

DashboardMapSizeScale

Field	Type	Required
`domainMaximum`	number	No
`domainMinimum`	number	No
`maximumRadius`	number	No
`minimumRadius`	number	No

DashboardMapStroke

Field	Type	Required
`color`	string	No
`opacity`	number	No
`width`	number	No

DashboardMetadata

Field	Type	Required	Rules
`description`	string	No
`displayName`	string	No
`documentation`	string	No
`domain`	string	No
`id`	string	Yes	pattern `^[A-Za-z0-9][A-Za-z0-9_.:-]*$`
`name`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_.-]*$`
`owner`	string	No
`tags`	array of string	No

DashboardMetadataBindings

Field	Type	Required
`description`	`DashboardTextBinding`	No
`subtitle`	`DashboardTextBinding`	No
`summary`	`DashboardTextBinding`	No
`title`	`DashboardTextBinding`	No

DashboardMetricReference

Field	Type	Required	Rules
`alias`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`metric`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardMetricSelection

Field	Type	Required	Rules

DashboardOrientation

Field	Type	Required	Rules

DashboardPage

Field	Type	Required	Rules
`components`	array of `DashboardPageComponent`	Yes
`description`	string	No
`filterBindings`	array of `DashboardPageFilterBinding`	No
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`layout`	`DashboardLayoutOverride`	No
`title`	string	Yes

DashboardPageComponent

Field	Type	Required	Rules

DashboardPageComponentBase

Field	Type	Required	Rules
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`placement`	`DashboardPlacement`	Yes
`type`	string	Yes

DashboardPageFilterBinding

Field	Type	Required	Rules
`default`	`DashboardFilterExpression`	No
`filter`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`readerEditable`	boolean	No
`required`	boolean	No
`targets`	array of string	No
`urlParameter`	string	No	pattern `^[A-Za-z][A-Za-z0-9_-]{0,63}$`

DashboardPathGeographicLayer

Field	Type	Required	Rules
`category`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`color`	`DashboardMapColorScale`	No
`kind`	string	Yes	one of `path`
`latitude`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`line`	`DashboardMapLineStyle`	No
`longitude`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`opacity`	number	No
`order`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`path`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`stroke`	`DashboardMapStroke`	No
`value`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardPivotTotals

Field	Type	Required
`columns`	boolean	No
`grand`	boolean	No
`rows`	boolean	No

DashboardPivotWindow

Field	Type	Required	Rules
`limit`	integer	Yes
`offset`	integer	No

DashboardPlacement

Field	Type	Required
`column`	integer	Yes
`columnSpan`	integer	Yes
`row`	integer	Yes
`rowSpan`	integer	Yes

DashboardPointGeographicLayer

Field	Type	Required	Rules
`category`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`cluster`	`DashboardMapCluster`	No
`color`	`DashboardMapColorScale`	No
`kind`	string	Yes	one of `point`
`label`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`latitude`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`longitude`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`opacity`	number	No
`size`	`DashboardMapSizeScale`	No
`stroke`	`DashboardMapStroke`	No
`value`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardPresentation

Field	Type	Required	Rules

DashboardPresentationBase

Field	Type	Required
`axisVisible`	boolean	No
`conditionalFormatting`	array of `DashboardConditionalFormat`	No
`type`	string	Yes

DashboardProportionalAlignment

Field	Type	Required	Rules

DashboardQuery

Field	Type	Required	Rules

DashboardQueryBase

Field	Type	Required	Rules
`type`	string	Yes

DashboardRecordFieldReference

Field	Type	Required	Rules
`alias`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardRecordFieldSelection

Field	Type	Required	Rules

DashboardReferenceBand

Field	Type	Required	Rules
`axis`	`VisualizationCartesianAxis`	Yes
`from`	`DashboardReferenceValue`	Yes
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`label`	string	No
`to`	`DashboardReferenceValue`	Yes
`tone`	`VisualizationTone`	Yes

DashboardReferenceGeographicLayer

Field	Type	Required	Rules
`color`	`DashboardMapColorScale`	No
`geometryAsset`	string	Yes
`kind`	string	Yes	one of `reference`
`opacity`	number	No
`stroke`	`DashboardMapStroke`	No

DashboardReferenceLine

Field	Type	Required	Rules
`axis`	`VisualizationCartesianAxis`	Yes
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`label`	string	No
`tone`	`VisualizationTone`	Yes
`value`	`DashboardReferenceValue`	Yes

DashboardReferenceValue

Field	Type	Required	Rules

DashboardReferenceValueBase

Field	Type	Required	Rules
`kind`	string	Yes

DashboardRelativeAnchor

Field	Type	Required	Rules

DashboardRelativeDirection

Field	Type	Required	Rules

DashboardRelativeUnit

Field	Type	Required	Rules

DashboardResourceKind

Field	Type	Required	Rules

DashboardRulesConditionalRule

Field	Type	Required	Rules
`defaultStyle`	`DashboardConditionalStyle`	Yes
`kind`	string	Yes	one of `rules`
`nullStyle`	`DashboardConditionalStyle`	Yes
`rules`	array of `DashboardConditionalThreshold`	Yes

DashboardSelectionMode

Field	Type	Required	Rules

DashboardSeriesIntent

Field	Type	Required
`color`	`VisualizationColorIntent`	No
`order`	integer	No
`value`	string	Yes

DashboardSort

Field	Type	Required	Rules
`direction`	`DashboardSortDirection`	Yes
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardSortDirection

Field	Type	Required	Rules

DashboardSpatialGesture

Field	Type	Required	Rules

DashboardSpatialMapping

Field	Type	Required	Rules
`dataset`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`source`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

DashboardSpec

Field	Type	Required	Rules
`appearance`	`DashboardAppearance`	No
`filters`	array of `DashboardFilter`	Yes
`includes`	`DashboardIncludes`	No
`layout`	`DashboardLayoutDefaults`	No
`pages`	array of `DashboardPage`	Yes
`semanticModel`	string	Yes	pattern `^[A-Za-z0-9][A-Za-z0-9_.:-]*$`
`visuals`	array of `NamedDashboardVisual`	Yes

DashboardStackingMode

Field	Type	Required	Rules

DashboardTextBinding

Field	Type	Required	Rules
`dataset`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`fallback`	string	No
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`prefix`	string	No
`reducer`	`VisualizationReferenceReducer`	No
`suffix`	string	No

DashboardTimeGrain

Field	Type	Required	Rules

DashboardTooltip

Field	Type	Required	Rules

DashboardTooltipItem

Field	Type	Required	Rules
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`format`	`VisualizationFormat`	No
`label`	string	No

DashboardVisual

Field	Type	Required
`accessibility`	`DashboardAccessibility`	No
`calculations`	array of `DashboardCalculation`	No
`dataBudget`	`DashboardDataBudget`	No
`datasets`	object	No
`description`	string	No
`interactions`	array of `DashboardInteraction`	No
`metadata`	`DashboardMetadataBindings`	No
`presentation`	`DashboardPresentation`	Yes
`query`	`DashboardQuery`	Yes
`subtitle`	string	No
`title`	string	No
`titleVisible`	boolean	No
`type`	`DashboardVisualType`	Yes

DashboardVisualType

Field	Type	Required	Rules

DateDashboardFilterValue

Field	Type	Required	Rules
`type`	string	Yes	one of `date`
`value`	string	Yes

DateRangeDashboardFilterControl

Field	Type	Required	Rules
`type`	string	Yes	one of `dateRange`

DecimalDashboardFilterValue

Field	Type	Required	Rules
`type`	string	Yes	one of `decimal`
`value`	string	Yes

DistinctDashboardFilterOptions

Field	Type	Required	Rules
`dataset`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`dependsOn`	array of string	No
`includeNull`	boolean	No
`limit`	integer	No
`type`	string	Yes	one of `distinct`

DistributionDashboardQuery

Field	Type	Required	Rules
`approximation`	`DashboardHistogramApproximation`	Yes
`field`	`DashboardMetricSelection`	Yes
`group`	`DashboardDimensionSelection`	No
`limit`	integer	No
`outliers`	`DashboardDistributionOutlierPolicy`	Yes
`quantiles`	array of number	Yes
`type`	string	Yes	one of `distribution`
`whiskers`	`DashboardDistributionWhiskers`	No

DurationVisualizationFormat

Field	Type	Required	Rules
`kind`	string	Yes	one of `duration`
`unit`	string	Yes

FieldDashboardReferenceValue

Field	Type	Required	Rules
`field`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`kind`	string	Yes	one of `field`
`reducer`	`VisualizationReferenceReducer`	Yes

FilterDashboardPageComponent

Field	Type	Required	Rules
`filter`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`type`	string	Yes	one of `filter`

GeographicDashboardPresentation

Field	Type	Required	Rules
`basemap`	string	No
`camera`	`DashboardMapCamera`	No
`controls`	`DashboardMapControls`	No
`labelDensity`	`VisualizationMapLabelDensity`	No
`layers`	array of `DashboardGeographicLayer`	No
`roam`	boolean	No
`theme`	`VisualizationMapTheme`	No
`type`	string	Yes	one of `geographic`

GridLevelHierarchy

Field	Type	Required	Rules
`fields`	array of string	Yes
`label`	string	No
`mode`	string	Yes	one of `levels`

GridNestedHierarchy

Field	Type	Required	Rules
`childrenField`	string	Yes
`idField`	string	No
`labelField`	string	Yes
`mode`	string	Yes	one of `nested`

GridParentChildHierarchy

Field	Type	Required	Rules
`idField`	string	Yes
`labelField`	string	Yes
`mode`	string	Yes	one of `parent_child`
`parentField`	string	Yes

GridRowHierarchy

Field	Type	Required	Rules

GridRowHierarchyBase

Field	Type	Required	Rules
`defaultExpandedDepth`	integer	No
`mode`	string	Yes

HeaderDashboardPageComponent

Field	Type	Required	Rules
`description`	string	No
`title`	string	No
`type`	string	Yes	one of `header`

HierarchyDashboardPresentation

Field	Type	Required	Rules
`breadcrumb`	boolean	No
`curveness`	number	No
`focus`	`VisualizationGraphFocus`	No
`initialDepth`	integer	No
`labels`	`DashboardLabelPolicy`	No
`layout`	`VisualizationHierarchyLayout`	No
`legend`	`DashboardLegendPosition`	No
`legendItems`	array of `DashboardLegendItem`	No
`legendTitle`	string	No
`nodeGap`	number	No
`orientation`	`DashboardOrientation`	No
`roam`	boolean	No
`type`	string	Yes	one of `hierarchy`

HistogramDashboardQuery

Field	Type	Required	Rules
`approximation`	`DashboardHistogramApproximation`	Yes
`bins`	integer	Yes
`domain`	`DashboardHistogramDomain`	No
`field`	`DashboardMetricSelection`	Yes
`nullPolicy`	`DashboardHistogramNullPolicy`	Yes
`type`	string	Yes	one of `histogram`

IntegerDashboardFilterValue

Field	Type	Required	Rules
`type`	string	Yes	one of `integer`
`value`	string	Yes

KPIDashboardPresentation

Field	Type	Required	Rules
`comparison`	`DashboardKPIValueBinding`	No
`delta`	`VisualizationKPIDeltaMode`	No
`displayUnits`	`VisualizationDisplayUnits`	No
`favorableDirection`	`VisualizationKPIDirection`	No
`goal`	`DashboardKPIValueBinding`	No
`missingComparison`	`VisualizationKPIMissingComparison`	No
`mode`	`VisualizationKPIMode`	No
`note`	string	No
`ranges`	array of `VisualizationKPIQualitativeRange`	No
`tone`	`VisualizationTone`	No
`trend`	`DashboardKPITrendBinding`	No
`type`	string	Yes	one of `kpi`

MultiSelectDashboardFilterControl

Field	Type	Required	Rules
`maxSelectedValues`	integer	No
`options`	`DashboardFilterOptions`	No
`type`	string	Yes	one of `multiSelect`

NamedDashboardVisual

Field	Type	Required	Rules
`id`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`

NullCheckDashboardFilterExpression

Field	Type	Required	Rules
`operator`	`DashboardFilterOperator`	Yes
`type`	string	Yes	one of `nullCheck`

NumberDashboardReferenceValue

Field	Type	Required	Rules
`kind`	string	Yes	one of `number`
`value`	number	Yes

NumberVisualizationFormat

Field	Type	Required	Rules
`kind`	string	Yes	one of `number`
`maximumFractionDigits`	integer	No
`minimumFractionDigits`	integer	No

NumericRangeDashboardFilterControl

Field	Type	Required	Rules
`type`	string	Yes	one of `numericRange`

PercentVisualizationFormat

Field	Type	Required	Rules
`kind`	string	Yes	one of `percent`
`maximumFractionDigits`	integer	No
`minimumFractionDigits`	integer	No

PivotDashboardQuery

Field	Type	Required	Rules
`columns`	array of `DashboardDimensionSelection`	Yes
`metrics`	array of `DashboardMetricSelection`	Yes
`rows`	array of `DashboardDimensionSelection`	Yes
`sort`	array of `DashboardSort`	No
`totals`	`DashboardPivotTotals`	No
`type`	string	Yes	one of `pivot`
`window`	`DashboardPivotWindow`	No

PointDashboardColorScale

Field	Type	Required
`kind`	`VisualizationPointColorScaleKind`	Yes
`maximum`	number	No
`minimum`	number	No

PointDashboardOverplot

Field	Type	Required
`largeMode`	`VisualizationPointLargeMode`	No
`largeThreshold`	integer	No
`opacity`	number	No
`strategy`	`VisualizationPointOverplotStrategy`	Yes

PointDashboardPresentation

Field	Type	Required	Rules
`axes`	array of `DashboardAxisConfiguration`	No
`brush`	array of `VisualizationPointBrushGesture`	No
`color`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`colorScale`	`PointDashboardColorScale`	No
`eventAnnotations`	array of `DashboardEventAnnotation`	No
`identity`	array of string	Yes
`label`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`labels`	`DashboardLabelPolicy`	No
`legend`	`DashboardLegendPosition`	No
`legendItems`	array of `DashboardLegendItem`	No
`legendTitle`	string	No
`overplot`	`PointDashboardOverplot`	No
`referenceBands`	array of `DashboardReferenceBand`	No
`referenceLines`	array of `DashboardReferenceLine`	No
`size`	string	No	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`sizeScale`	`PointDashboardSizeScale`	No
`tooltip`	array of `DashboardTooltip`	No
`type`	string	Yes	one of `point`
`x`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`
`y`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_]*$`

PointDashboardSizeScale

Field	Type	Required
`maximum`	number	No
`maximumPixels`	number	Yes
`minimum`	number	No
`minimumPixels`	number	Yes

PolarDashboardPresentation

Field	Type	Required	Rules
`area`	boolean	No
`displayUnits`	`VisualizationDisplayUnits`	No
`labels`	`DashboardLabelPolicy`	No
`legend`	`DashboardLegendPosition`	No
`legendItems`	array of `DashboardLegendItem`	No
`legendTitle`	string	No
`maximum`	number	No
`minimum`	number	No
`progressWidth`	number	No
`showPointer`	boolean	No
`target`	number	No
`thresholds`	array of `VisualizationThreshold`	No
`type`	string	Yes	one of `polar`

ProportionalDashboardPresentation

Field	Type	Required	Rules
`align`	`DashboardProportionalAlignment`	No
`centerLabel`	string	No
`displayUnits`	`VisualizationDisplayUnits`	No
`innerRadius`	number	No
`labelPosition`	`DashboardLabelPosition`	No
`labels`	`DashboardLabelPolicy`	No
`legend`	`DashboardLegendPosition`	No
`legendItems`	array of `DashboardLegendItem`	No
`legendTitle`	string	No
`orientation`	`DashboardOrientation`	No
`outerRadius`	number	No
`rose`	boolean	No
`sort`	`VisualizationSortDirection`	No
`tooltip`	array of `DashboardTooltip`	No
`type`	string	Yes	one of `proportional`

RangeDashboardFilterExpression

Field	Type	Required	Rules
`lower`	`DashboardFilterBound`	No
`type`	string	Yes	one of `range`
`upper`	`DashboardFilterBound`	No

RecordsDashboardQuery

Field	Type	Required	Rules
`dataset`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`
`fields`	array of `DashboardRecordFieldSelection`	Yes
`limit`	integer	No
`sort`	array of `DashboardSort`	No
`type`	string	Yes	one of `records`

RelativePeriodDashboardFilterControl

Field	Type	Required	Rules
`type`	string	Yes	one of `relativePeriod`

RelativePeriodDashboardFilterExpression

Field	Type	Required	Rules
`anchor`	`DashboardRelativeAnchor`	Yes
`anchorValue`	`DashboardFilterValue`	No
`count`	integer	Yes
`direction`	`DashboardRelativeDirection`	Yes
`includeCurrent`	boolean	Yes
`type`	string	Yes	one of `relativePeriod`
`unit`	`DashboardRelativeUnit`	Yes

SelectionDashboardInteraction

Field	Type	Required	Rules
`highlightTargets`	array of string	No
`mappings`	array of `DashboardInteractionMapping`	Yes
`mode`	`DashboardSelectionMode`	Yes
`noneTargets`	array of string	No
`toggle`	boolean	Yes
`type`	string	Yes	one of `selection`

SetDashboardFilterExpression

Field	Type	Required	Rules
`operator`	`DashboardFilterOperator`	Yes
`type`	string	Yes	one of `set`
`values`	array of `DashboardFilterValue`	Yes

SingleSelectDashboardFilterControl

Field	Type	Required	Rules
`options`	`DashboardFilterOptions`	No
`type`	string	Yes	one of `singleSelect`

SpatialSelectionDashboardInteraction

Field	Type	Required	Rules
`gestures`	array of `DashboardSpatialGesture`	Yes
`highlightTargets`	array of string	No
`latitude`	`DashboardSpatialMapping`	Yes
`longitude`	`DashboardSpatialMapping`	Yes
`noneTargets`	array of string	No
`type`	string	Yes	one of `spatialSelection`

StaticDashboardFilterOptions

Field	Type	Required	Rules
`type`	string	Yes	one of `static`
`values`	array of `DashboardFilterOption`	Yes

StringDashboardFilterValue

Field	Type	Required	Rules
`type`	string	Yes	one of `string`
`value`	string	Yes

TableCellContent

Field	Type	Required	Rules

TableCellContentBase

Field	Type	Required	Rules
`kind`	string	Yes

TableDashboardPresentation

Field	Type	Required	Rules
`cellContent`	object	No
`hierarchy`	`GridRowHierarchy`	No
`rowHeight`	integer	Yes
`showHeader`	boolean	Yes
`striped`	boolean	Yes
`type`	string	Yes	one of `table`

TableImageCellContent

Field	Type	Required	Rules
`altField`	string	No
`display`	`TableImageDisplay`	Yes
`height`	integer	No
`kind`	string	Yes	one of `image`
`width`	integer	No

TableImageDisplay

Field	Type	Required	Rules

TableLinkCellContent

Field	Type	Required	Rules
`kind`	string	Yes	one of `link`
`labelField`	string	No
`newTab`	boolean	No

TemporalVisualizationFormat

Field	Type	Required	Rules
`dateStyle`	string	No
`kind`	string	Yes	one of `temporal`
`timeStyle`	string	No

TextDashboardFilterControl

Field	Type	Required	Rules
`type`	string	Yes	one of `text`

TextDashboardReferenceValue

Field	Type	Required	Rules
`kind`	string	Yes	one of `text`
`value`	string	Yes

TimestampDashboardFilterValue

Field	Type	Required	Rules
`type`	string	Yes	one of `timestamp`
`value`	string	Yes

UnfilteredDashboardFilterExpression

Field	Type	Required	Rules
`type`	string	Yes	one of `unfiltered`

VisualDashboardPageComponent

Field	Type	Required	Rules
`type`	string	Yes	one of `visual`
`visual`	string	Yes	pattern `^[A-Za-z_][A-Za-z0-9_-]*$`

VisualizationAxisGridVisibility

Field	Type	Required	Rules

VisualizationAxisInversion

Field	Type	Required	Rules

VisualizationAxisLabelRotation

Field	Type	Required	Rules

VisualizationAxisScale

Field	Type	Required	Rules

VisualizationAxisTickDensity

Field	Type	Required	Rules

VisualizationAxisTickVisibility

Field	Type	Required	Rules

VisualizationAxisType

Field	Type	Required	Rules

VisualizationAxisZeroPolicy

Field	Type	Required	Rules

VisualizationCalculationAxis

Field	Type	Required	Rules

VisualizationCalculationReset

Field	Type	Required	Rules

VisualizationCalculationTemplate

Field	Type	Required	Rules

VisualizationCartesianAxis

Field	Type	Required	Rules

VisualizationColorIntent

Field	Type	Required	Rules

VisualizationComparisonOperator

Field	Type	Required	Rules

VisualizationCompleteness

Field	Type	Required	Rules

VisualizationConditionalTarget

Field	Type	Required	Rules

VisualizationDateDisplayUnit

Field	Type	Required	Rules

VisualizationDisplayUnits

Field	Type	Required	Rules

VisualizationFormat

Field	Type	Required	Rules

VisualizationFormatBase

Field	Type	Required	Rules
`kind`	string	Yes

VisualizationGraphFocus

Field	Type	Required	Rules

VisualizationHierarchyLayout

Field	Type	Required	Rules

VisualizationIconIntent

Field	Type	Required	Rules

VisualizationKPIDeltaMode

Field	Type	Required	Rules

VisualizationKPIDirection

Field	Type	Required	Rules

VisualizationKPIMissingComparison

Field	Type	Required	Rules

VisualizationKPIMode

Field	Type	Required	Rules

VisualizationKPIQualitativeRange

Field	Type	Required
`label`	string	Yes
`maximum`	number	No
`minimum`	number	No
`tone`	`VisualizationTone`	Yes

VisualizationMapCameraMode

Field	Type	Required	Rules

VisualizationMapColorScaleKind

Field	Type	Required	Rules

VisualizationMapLabelDensity

Field	Type	Required	Rules

VisualizationMapLayerPosition

Field	Type	Required	Rules

VisualizationMapTheme

Field	Type	Required	Rules

VisualizationPointBrushGesture

Field	Type	Required	Rules

VisualizationPointColorScaleKind

Field	Type	Required	Rules

VisualizationPointLargeMode

Field	Type	Required	Rules

VisualizationPointOverplotStrategy

Field	Type	Required	Rules

VisualizationReferenceReducer

Field	Type	Required	Rules

VisualizationSortDirection

Field	Type	Required	Rules

VisualizationThreshold

Field	Type	Required	Rules
`tone`	`VisualizationTone`	Yes
`value`	number	Yes

VisualizationTone

Field	Type	Required	Rules