Documentation

Ataytis Vega Studio documentation.

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

Authoring fundamentals

Data, fields, and the Power BI dataset

Understand how Power BI fields become Vega data, which helper fields the Studio adds, and how to design specifications that remain reliable as reports change.

From the Values well to Vega

Ataytis Vega Studio exposes one Power BI data role named Values. It accepts grouping columns and measures. The visual converts the resulting Power BI data view into a Vega dataset named dataset, which is the stable entry point for most specifications.

Vega JSON
"data": [
  { "name": "dataset" }
]

Referencing field names safely

  • Use the exact field name shown in the inspector Data table, including spaces, punctuation, aggregation labels, and capitalization.
  • Use bracket notation such as datum['Gross Margin %'] in Vega expressions when a name contains spaces or punctuation.
  • Prefer stable, intentional display names in Power BI before investing in a reusable specification.
  • Open the Data table after changing the Values well; it is the quickest way to confirm the current schema and sample values.
  • When creating a reusable template, give each field placeholder a purpose-led name and author note rather than relying on a model-specific name.
Power BI Values fields compared with matching columns in the Ataytis Vega Studio Data table.
The Power BI Values well and Studio Data table show the exact field names available to the Vega specification.

Studio-managed helper fields

Field patternPurpose
__row__Zero-based internal row identifier used to reconcile Vega data items with Power BI selection identities.
__selected__Selection state for the row: neutral, on, or off.
<measure>__formattedPower BI-formatted text representation of a measure value.
<measure>__formatThe Power BI format string associated with a measure.
<measure>__highlightThe current cross-highlight value supplied for a measure.
<measure>__highlightStatusCross-highlight state: neutral, on, or off.
<measure>__highlightComparatorComparison between highlight and base values: eq, lt, gt, or neq.

The Power BI container signal

The Studio patches a signal named pbiContainer into the Vega view. It describes the current host container and scrolling state, which can support responsive or scroll-aware designs.

PropertyMeaning
pbiContainer.width / heightCurrent visible container dimensions.
pbiContainer.scrollWidth / scrollHeightTotal dimensions of scrollable content.
pbiContainer.scrollLeft / scrollTopCurrent horizontal and vertical scroll positions.
Data, fields, and the Power BI dataset | AtaytisTech