Skip to main content

Component YAML

Defines a reusable dashboard component that can be embedded in canvas dashboards

Properties​

type​

[string] - Refers to the resource type and must be component (required)

display_name​

[string] - Refers to the display name for the component

description​

[string] - Detailed description of the component's purpose and functionality

input​

[array of object] - List of input variables that can be passed to the component

  • name - [string] - Unique identifier for the variable (required)

  • type - [string] - Data type of the variable (e.g., string, number, boolean) (required)

  • value - [string, number, boolean, object, array] - Default value for the variable. Can be any valid JSON value type

output​

[object] - Output variable that the component produces

  • name - [string] - Unique identifier for the variable (required)

  • type - [string] - Data type of the variable (e.g., string, number, boolean) (required)

  • value - [string, number, boolean, object, array] - Default value for the variable. Can be any valid JSON value type

line_chart​

[object] - (no description)

  • config - [object] - (no description) (required)

    • metrics_view - [string] - Reference to the metrics view to use (required)

    • x - [object] - (no description)

      • field - [string] - Field name from the metrics view (required)

      • title - [string] - Display title for the field

      • format - [string] - Format string for the field

      • type - [string] - Data type of the field (required)

      • timeUnit - [string] - Time unit for temporal fields

    • y - [object] - (no description)

      • field - [string] - Field name from the metrics view (required)

      • title - [string] - Display title for the field

      • format - [string] - Format string for the field

      • type - [string] - Data type of the field (required)

      • timeUnit - [string] - Time unit for temporal fields

    • color - [oneOf] - (no description)

      • option 1 - [object] - (no description)

        • field - [string] - Field name from the metrics view (required)

        • title - [string] - Display title for the field

        • format - [string] - Format string for the field

        • type - [string] - Data type of the field (required)

        • timeUnit - [string] - Time unit for temporal fields

      • option 2 - [string] - (no description)

    • tooltip - [object] - (no description)

      • field - [string] - Field name from the metrics view (required)

      • title - [string] - Display title for the field

      • format - [string] - Format string for the field

      • type - [string] - Data type of the field (required)

      • timeUnit - [string] - Time unit for temporal fields

  • title - [string] - Chart title

  • description - [string] - Chart description

bar_chart​

[object] - (no description)

  • config - [object] - (no description) (required)

    • metrics_view - [string] - Reference to the metrics view to use (required)

    • x - [object] - (no description)

      • field - [string] - Field name from the metrics view (required)

      • title - [string] - Display title for the field

      • format - [string] - Format string for the field

      • type - [string] - Data type of the field (required)

      • timeUnit - [string] - Time unit for temporal fields

    • y - [object] - (no description)

      • field - [string] - Field name from the metrics view (required)

      • title - [string] - Display title for the field

      • format - [string] - Format string for the field

      • type - [string] - Data type of the field (required)

      • timeUnit - [string] - Time unit for temporal fields

    • color - [oneOf] - (no description)

      • option 1 - [object] - (no description)

        • field - [string] - Field name from the metrics view (required)

        • title - [string] - Display title for the field

        • format - [string] - Format string for the field

        • type - [string] - Data type of the field (required)

        • timeUnit - [string] - Time unit for temporal fields

      • option 2 - [string] - (no description)

    • tooltip - [object] - (no description)

      • field - [string] - Field name from the metrics view (required)

      • title - [string] - Display title for the field

      • format - [string] - Format string for the field

      • type - [string] - Data type of the field (required)

      • timeUnit - [string] - Time unit for temporal fields

  • title - [string] - Chart title

  • description - [string] - Chart description

stacked_bar_chart​

[object] - (no description)

  • config - [object] - (no description) (required)

    • metrics_view - [string] - Reference to the metrics view to use (required)

    • x - [object] - (no description)

      • field - [string] - Field name from the metrics view (required)

      • title - [string] - Display title for the field

      • format - [string] - Format string for the field

      • type - [string] - Data type of the field (required)

      • timeUnit - [string] - Time unit for temporal fields

    • y - [object] - (no description)

      • field - [string] - Field name from the metrics view (required)

      • title - [string] - Display title for the field

      • format - [string] - Format string for the field

      • type - [string] - Data type of the field (required)

      • timeUnit - [string] - Time unit for temporal fields

    • color - [oneOf] - (no description)

      • option 1 - [object] - (no description)

        • field - [string] - Field name from the metrics view (required)

        • title - [string] - Display title for the field

        • format - [string] - Format string for the field

        • type - [string] - Data type of the field (required)

        • timeUnit - [string] - Time unit for temporal fields

      • option 2 - [string] - (no description)

    • tooltip - [object] - (no description)

      • field - [string] - Field name from the metrics view (required)

      • title - [string] - Display title for the field

      • format - [string] - Format string for the field

      • type - [string] - Data type of the field (required)

      • timeUnit - [string] - Time unit for temporal fields

  • title - [string] - Chart title

  • description - [string] - Chart description

vega_lite​

[object] - (no description)

  • spec - [string] - Vega-Lite specification as a string (required)

kpi​

[object] - (no description)

  • metrics_view - [string] - Reference to the metrics view to use (required)

  • measure - [string] - Measure to display (required)

  • time_range - [string] - Time range for the KPI (required)

  • comparison_range - [string] - Comparison time range

  • filter - [string] - Filter expression

  • title - [string] - KPI title

  • description - [string] - KPI description

table​

[object] - (no description)

  • metrics_view - [string] - Reference to the metrics view to use (required)

  • measures - [array of string] - List of measures to display (required)

  • time_range - [string] - Time range for the table (required)

  • row_dimensions - [array of string] - Dimensions for table rows

  • col_dimensions - [array of string] - Dimensions for table columns

  • comparison_range - [string] - Comparison time range

  • filter - [string] - Filter expression

  • title - [string] - Table title

  • description - [string] - Table description

markdown​

[object] - (no description)

  • content - [string] - Markdown content (required)

  • css - [object] - CSS styles

  • title - [string] - Markdown title

  • description - [string] - Markdown description

image​

[object] - (no description)

  • url - [string] - Image URL (required)

  • css - [object] - CSS styles

  • title - [string] - Image title

  • description - [string] - Image description