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.
API v5.10.0
DataViewMetadataColumn has a new property called sourceFieldParameters. This property indicates if the current field is the result of a field parameter. If a single field can originate from multiple field parameters, this property lists all the related field parameters.
Hierarchical identity filter API: Allows you to create a visual that uses Matrix DataView Mapping to filter data based on data points that use a hierarchical structure. This is useful for custom visuals that leverage group-on keys semantic models and want to filter hierarchies based on data points.
Local storage API: A new version of local storage API available for all custom visuals and controlled by a global 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
Improved keyboard navigation: Improves accessibility and usability of your visuals by providing more options for interacting with visual using the keyboard.
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
Customized data reduction - This feature added to capabilities.json schema allows the data fetch window to be modified dynamically by the custom visual code the report author.
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:
TypeScript
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
Supports Sync Slicers, note this only works for single field slicers due to PBI current code state, read more.