Edit

Power BI visuals API changelog

  • Article

This page contains a short summary of the existing API versions and what to expect in the upcoming version. Versions listed here are considered stable and don't change.

Coming soon

  • Hierarchial identity filter
  • Authentication API extensions

API v5.8.0

  • Local storage API: A new version of local storage API available for all custom visuals and controlled by a global admin setting that is on by default. The admin can Turn off the global setting to disable both the legacy API and the new version of the API.
  • On-object support for custom visuals: On object support for custom visuals to optimize the user experience and provide a unified authoring experience on par with out of the box visuals.
  • Supports Desktop February 2024

API v5.7.0

  • Power BI Custom Visuals Authentication API: Allows Custom Visuals to obtain Microsoft Entra access tokens through single sign-on (SSO), facilitating secure and efficient user-contextual operations.
  • Dynamic drill control: Allows the visual to enable or disable the drill feature dynamically using an API call.
    • When the drill feature is enabled, all the functionalities of drilldown and expand/collapse features are available. These functionalities include API calls, context menu commands, header drill buttons, and support for hierarchy data.
    • When the drill feature is disabled, these functionalities aren't available.
  • Supports Desktop December 2023

API v5.4.0

API v5.3.0

  • SelectionId's update-fix for matrix dataView.

    Note

    The selectionId's core data might change. Therefore, a persisted selectionId/identityIndex using an older API version might not be relevant in matrix visuals.

  • downloadService: Adds a new method exportVisualsContentExtended that returns expanded result information of the download.
  • Supports Desktop March 2023

API v5.2.0

API v5.1.0

  • Custom sorting - improved custom sorting for tables
  • Subtotals - new Subtotals Type indicates if totals should be retrieved before or after the rest of the data
  • Identity filter - filter categorical data
  • New format pane - design a custom visual that supports the new format pane design
  • Supports Desktop October 2022

API v4.7.0

  • Licensing API - Sell, manage, and enforce licenses directly through the commercial marketplace.
  • Drilldown API - Create a visual that can trigger a drilldown operation on its own, without user interaction.
  • Supports Desktop July 2022

API v4.6.0

  • New capabilities property: privileges and two privileges:
    • web access
    • download file from custom visual
  • Added two corresponding tenant admin switches
  • Download API to allow downloading visual to file
  • Supports Desktop June 2022

API v4.2.0

API v3.8.0

  • Supports Desktop May 2021 and later.

API v3.7.0

  • Supports Desktop April 2021 and later.

API v3.6.0

API v3.4.0

  • fetchMoreData : new aggregateSegments parameter (default true), for supporting no-aggregation fetchMoreData
  • Supports Desktop 2020 November and later.
  • Supports Desktop RS January 2021 and later.

API v3.2.0

API v2.6.0

  • Adds isInFocus to update option and switchFocusModeState method to visual host
  • Supports subtotals customization
  • Supports Desktop 2019 June and later.
  • Supports Desktop RS May 2019 and later.

API v2.5.0

  • Supports Analytics Pane
  • Supports SelectionIdBuilder withMatrixNode and withTable methods
  • No longer supports DataRepetitionSelector interface, replaced with data.CustomVisualOpaqueIdentity interface

API v2.3.0

API v2.2.0

API v2.1.0

  • Performance enhancements:
    • Faster load times
    • Smaller memory footprint
    • Optimized data and event transactions

Release notes

  • Refactored filtering APIs will be available in API 2.2 and are not supported in API 2.1.

  • Visuals will only receive the dataView type that was declared in their capabilities. Visuals that used multiple dataView types will break as a result of this update.

  • No longer supports DataViewScopeIdentity interface, replaced with data.DataRepetitionSelector interface. If you used key property of the DataViewScopeIdentity interface, you can replace it with JSON.stringify(identity)

  • undefined is replaced with null inside the dataView. When iterating over an array using var item in myArray it skips on undefined, but doesn’t skip on null. Visuals that use this pattern may be broken by this update. Make sure to check for null in arrays:

    for (var item in myArray) {
   if (!item) {
     continue;
   }
   console.log(item);
}

  • The proto property no longer stores hidden metadata\data inside the dataView. Visuals that access properties via proto may be broken by this update.

API v1.13.0

API v1.12.0

API v1.11.0

API v1.10.0

  • Adds ILocalizationManager
  • Authentication API

API v1.9.0

API v1.8.0

  • Supports new type fillRule (gradient) in capabilities schema
  • Supports rule property in capabilities schema for object properties

API v1.7.0

API v1.6.2

API v1.5.0

API v1.4.0

API v1.3.0

API v1.2.0

  • Adds colorPalette to manage the colors used on your visual.
  • Supports Multiple selection - selectionManager can accept an array of SelectionId.
  • Supports R visuals using R scripts

API v1.1.0

  • Supports debug visual in iFrame
  • Adds light weight sandbox with faster initialization of the iFrame
  • Fixes Capabilities.objects does not support "text" type issue
  • Supports pbiviz update to update visual API type definitions and schema
  • Supports --api-version flag in pbiviz new to create visuals with a specific api version
  • Supports alpha release of API v1.2.0

Visual Host

  • Adds createSelectionIdBuilder to create unique identifiers used for data selection
  • Adds createSelectionManager to manage the selection state of the visual and communicates changes to the visual host
  • Adds an array of default colors to use in visuals

API v1.0.0

  • Initial API release