YAML Editor

The YAML editor is a tool for advanced users. It allows you to edit view and widget settings using the YAML data serialization format. To open the YAML editor, switch to dashboard Edit mode and click the button with angular arrows and a slash on the header panel.

When you open the YAML editor, a navigation panel listing all views created in the dashboard appears on the left, without element hierarchy. Clicking a view in this panel opens its structure in the YAML editor.

If a view contains no elements yet, it has the following structure:

schema: 6
metadata:
  autoUpdate:
    enabled: false
  color:
    mode: AUTO
  spacing: false
  cornerRadius: null
  dividersHeight:
    mode: FIXED
    value: 18
widgetsSetting:
  titleColor:
    mode: AUTO
  titleSize: 14
  paddings: 8
  titleWeight: NORMAL
  textSize: 12
  filterMode: DEFAULT
  ignoreFilters: false
  stateName: null
layout:
  rows: []

After modifying the code, the Publish button in the header panel becomes inactive. To publish the dashboard, save your changes by clicking the Save button in the upper-right corner of the editor. If the code contains an error, you cannot save changes or publish the view until you fix it. An error message appears at the top of the editor, indicating the cause and the line numbers where the issue occurs.

To populate a view with elements, use keys and parameters. View layout configuration in YAML is described on the page Configuring a View in YAML. Widget creation in YAML and common parameters are described on the page Configuring Widgets in YAML.

Variables

The variables tab is located on the left.

Actions and Keyboard Shortcuts

To see available code actions and keyboard shortcuts, click the context menu icon in the editor’s header panel.