astrato-app-filter-bar operations

Reference for @astrato-io/visualizations@0.6.5.

All visualization types

Use each schema below for the request’s payload, not for the whole operation request. Names and payloads are specific to this visualization type. An operation can still require particular fields or chart state; see its description.

Available operations

• setAppFilterBarAddingFiltersEnabled
• setAppFilterBarAssociativeFilterEnabled
• setAppFilterBarChartBreakdownEnabled
• setAppFilterBarClearAllEnabled
• setAppFilterBarOrientation
• setAppFilterBarOverflow
• setAppFilterBarSelectableFieldKeys
• setAppFilterBarSelectionMode

setAppFilterBarAddingFiltersEnabled

App filter bar add filters

Allow or prevent adding new filters from the app filter bar.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "boolean",
  "title": "App filter bar add filters enabled"
}

setAppFilterBarAssociativeFilterEnabled

App filter bar associative filtering

Allow or prevent associative filtering from the app filter bar.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "boolean",
  "title": "App filter bar associative filtering enabled"
}

setAppFilterBarChartBreakdownEnabled

App filter bar chart breakdown

Opt in to chart breakdown switching for apps that use dimension groups. Hidden by default; requires a group with multiple available fields.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "boolean",
  "title": "App filter bar chart breakdown enabled"
}

setAppFilterBarClearAllEnabled

App filter bar clear all

Show or hide the control that clears selections for the whole group.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "boolean",
  "title": "App filter bar clear all"
}

setAppFilterBarOrientation

App filter bar orientation

Switch between a horizontal filter bar and stacked vertical sidebar filters.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string",
  "enum": ["horizontal", "vertical"],
  "title": "App filter bar orientation"
}

setAppFilterBarOverflow

App filter bar overflow

Choose wrapping chips in an auto-height section (default), a single row with hidden filters accessible through +N, or a Filters (N) button that opens the complete bar in a modal. Responsive collapse-button and wrap-collapse-button switch at the bar width breakpoints. Collapse applies to horizontal bars; button applies in both orientations.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string",
  "enum": ["wrap", "collapse", "button", "collapse-button", "wrap-collapse-button"],
  "title": "App filter bar overflow"
}

setAppFilterBarSelectableFieldKeys

App filter bar selectable fields

Restrict newly created filters to these engine field keys; pass null or an empty list to allow all fields.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "anyOf": [
    {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    {
      "type": "null"
    }
  ],
  "title": "App filter bar selectable field keys or null to clear the restriction"
}

setAppFilterBarSelectionMode

App filter bar selection mode

Set selection behavior to inherit from the host, apply immediately, or stage for manual apply.

Payload schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string",
  "enum": ["inherit", "auto", "manual"],
  "title": "App filter bar selection mode"
}