Documentation

Ataytis Vega Studio documentation.

Build, inspect, refine, and share Vega-powered Power BI visuals.

Templates

Create and export a template

Turn a working Vega visual into a portable, documented template without packaging the report data.

Prepare the source visual

  • Apply and save the latest specification; export is unavailable while unapplied changes make the visual ineligible.
  • Confirm the visual works with representative filters, viewport sizes, and interaction states.
  • Remove model-specific assumptions that are not portable to another report.
  • Use stable field references and confirm every required field is visible in the Data table.
  • Review the preview for sensitive values before choosing to embed a preview image.

Generate the template

  1. 1

    Open Generate JSON template

    Use the export action or press Ctrl+Alt+T.

  2. 2

    Wait for field processing

    The Studio tracks field use and replaces model-specific field references with template placeholders.

  3. 3

    Name the template

    Use a clear product-style name of up to 100 characters.

  4. 4

    Describe its purpose

    Explain the analytical question, expected behavior, and important assumptions in up to 300 characters.

  5. 5

    Add the author

    Provide a recognisable author or team name of up to 100 characters.

  6. 6

    Document every field

    Give placeholders purpose-led names and concise notes explaining the expected column or measure.

  7. 7

    Choose whether to include a preview

    The Studio can capture and resize the current visual to a maximum of 150 × 150 pixels.

  8. 8

    Download or copy

    Download the generated JSON file, or copy it to the clipboard when the Power BI host blocks custom-visual downloads.

Screenshot placeholder

Generate JSON template dialog

Show template name, description, author, preview-image option, and the dataset field metadata table.

Planned alt text: Ataytis Vega Studio template export dialog with information and field metadata controls.

Data and preview-image privacy

The template generation process stores field metadata and placeholder references but does not store Power BI dataset rows. The optional preview image is different: it is a raster capture of the rendered visual and can therefore visibly contain labels or values.

Manage template files

  • Keep the .ataytisVegaStudio.json suffix so files remain recognisable.
  • Use version control or a controlled document library for team-owned templates.
  • Record a version and change summary in the surrounding catalogue even when the template filename stays stable.
  • Retest templates after major changes to Vega Studio, Vega, the semantic model, or the intended Power BI interaction behavior.
  • Keep an original source PBIX or development report alongside the exported template for maintenance.
Create and export a template | AtaytisTech