Skip to main content

# kater dashboard layout suggest

Suggests a place and a size for the tile of each chart you name, as Kater lays out a dashboard.

{/* Written by apps/landing-page/scripts/docs/write_cli_reference.py from the kater CLI's own help and scripts/docs/cli-reference.md. Do not edit it by hand: change those, then run the script. */}

It writes nothing, so use it to plan tiles before you save `dashboard.yaml`.

## Examples

```bash
# Suggest a place and a size for the tiles of spend_by_platform and spend_mix
kater dashboard layout suggest --request-file layout_spend.json
```

## Arguments

<div class="cli-options">

| Argument | Description |
| --- | --- |
| `<path>` | Optional. In place of `--request-file`: the workspace, the query file or the chart file the request names. |

</div>

## Options

<div class="cli-options">

| Option | Description |
| --- | --- |
| `--request-file <file>` | The workspace and the charts, as JSON. Give `-` to read it from standard input. See [The request](#the-request). |

</div>

It also takes the [global options](https://kater.ai/docs/cli-reference/global-options/) `--json`, `--kater-root`, `--scope` and `--help`.

## The request

| Field | What it holds |
| --- | --- |
| `namespace` | The workspace, by its full `path`. |
| `charts` | The saved charts, by their names. |

```json title="layout_spend.json"
{"namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}, "charts": ["spend_by_platform", "spend_mix"]}
```

## What it shows

The answer's `tiles` give each chart its `kind`, and three values as `dashboard.yaml` writes them. `x` is the column the tile starts at, from 0 to 11. `span` is how many of the dashboard's 12 columns it takes. `height` is from 160 to 960, in steps of 16.

## See also

- [`kater dashboard layout`](https://kater.ai/docs/cli-reference/dashboard/layout/)
- [All commands](https://kater.ai/docs/cli-reference/kater/)

On this page

Examples
Arguments
Options
The request
What it shows
See also

Kater CLI Present and share dashboard layout

kater dashboard layout suggest

Suggests a place and a size for the tile of each chart you name, as Kater lays out a dashboard.

It writes nothing, so use it to plan tiles before you save dashboard.yaml.

Examples

# Suggest a place and a size for the tiles of spend_by_platform and spend_mix
kater dashboard layout suggest --request-file layout_spend.json

Arguments

Argument	Description
`<path>`	Optional. In place of `--request-file`: the workspace, the query file or the chart file the request names.

Options

Option	Description
`--request-file <file>`	The workspace and the charts, as JSON. Give `-` to read it from standard input. See The request.

It also takes the global options --json, --kater-root, --scope and --help.

The request

Field	What it holds
`namespace`	The workspace, by its full `path`.
`charts`	The saved charts, by their names.

{"namespace": {"path": "connections/snowflake_prod_connection/workspaces/ad_reporting"}, "charts": ["spend_by_platform", "spend_mix"]}

What it shows

The answer’s tiles give each chart its kind, and three values as dashboard.yaml writes them. x is the column the tile starts at, from 0 to 11. span is how many of the dashboard’s 12 columns it takes. height is from 160 to 960, in steps of 16.

See also