Microsoft PowerBI Custom Visuals API

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Change Log - Power BI Custom Visuals API

5.11.0

• Removes storageService.

  5.10.0

• sourceFieldParameters : New DataViewMetadataColumn property indicates that the current field is the result of a field parameter.

5.9.1

• acquireAADTokenService : Enhanced to support multiple clouds.

5.9.0

• AcquireAADTokenResult : Extended with additional properties.
• createOpaqueUtils : Create an encapsulated utility for the visual.
• Filter API : Exposing new filter type for hierarchy data - HierarchyIdentity.
• areHierarchicallyRelated : Requires that the items in the role are hierarchically related.
• CustomVisualHostEnv: Extended with DashboardHost type for representing tiles and dashboards in embedded environments.

5.8.0

• storageV2Service : Enables visuals to use the browser's local storage.
• Support For OnObject Formatting:
  • Adds OnObject Formatting interfaces.
  • visualOnObjectFormatting: Contains the get APIs of the onObject.
  • subSelectionService: Enables visuals to send subSelections and outlines to PowerBI.
  • Adds 2 capabilities: supportsOnObjectFormatting and enablePointerEventsFormatMode.
  • Adds subSelections and formatMode in VisualUpdateOptions interface.

5.7.0

• acquireAADTokenService : Enables visuals to obtain Microsoft Entra ID (formerly known as Azure AD) access tokens for signed-in users.
• Dynamic drill control : Adds new API and capability to dynamically control the drill and expand collapse features.

5.4.0

• Adds isDataFilterApplied into DataViewMetadata, to provide a boolean value of whether any applied filter affects the visual.

5.3.0

• SelectionId's update-fix for matrix dataView.
  Note: the selectionId's core data might change therefore a persisted selectionIds/identityIndex using an older API version might not be relevant in matrix dataView.
• downloadService: Adds a new method exportVisualsContentExtended which returns expanded reuslt information of the download.
• Extended VisualUpdateType enum with 3 new types: FormattingSubSelectionChange, FormatModeChange and FilterOptionsChange.

5.2.0

• Adds dataReductionCustomization into schema for capabilities.json, this capability offers a declarative way of customizing some data reduction behavior at query generation time.

5.1.0

• Adds Subtotal position type API
• Adds Custom Sorting API
• Adds new formatting pane FormattingModel interfaces

4.7.0

• Adds drill API

4.6.0

• Adds privileges into schema for capabilities.json

4.0.0

• openModalDialog enhancements: allow defining the dialog's size, position and title.

3.8.4

• Fixed create interface.

3.8.3

• supportEnhancedTooltips : added the "supportEnhancedTooltips" as a capability, it enables modern visual tooltip which includes data point drill actions and updated styling.

3.8.2

• openModalDialog : display an interactive modal dialog window.

3.7.0

• displayWarningIcon : enables visuals to display a warning icon with customized text and details.

3.6.0

• supportsEmptyDataView : added the "supportsEmptyDataView" as a capability, enables visuals to receive formatting properties even if they don't have any data roles.

3.5.1

• VisualEnumerationInstanceKinds : add enum to support different formatting types
• VisualObjectInstance : new propertyInstanceKind and altConstantValueSelector optional properties to support conditional formatting.

3.4.0

• fetchMoreData : new aggregateSegments parameter (default true), for supporting no-aggregation fetchMoreData.

3.2.0

• supportsMultiVisualSelection multi selection capabilities for custom visuals

2.6.2

• Now visuals are able to use two and more dataViewMappings at the same time.

2.6.1

• Add fontFamily as one of required properties of formatting object type.
• Add supportsMultiVisualSelection to schema.

2.6.0

• subtotals property specifies subtotal customizations applied in customizeQuery method

2.5.0

• Analytics Pane Support
• New methods to generate selections for Table rows and Matrix nodes have been added

2.3.2

• Change enums to const enums

2.3.1

• Stronger filtering capabilities with tuple-filter

2.3.0 alpha

• Landing page capabilities for custom visuals

2.2.2

• Adds fontFamily into schema for capabilities.json

2.2.1

• Fix CV API version for patch packages

2.2.0

• Custom visuals now support context menu
• Deprecated applySelectionFilter from ISelectionManager
• jsonFilters in VisualUpdateOptions interface.

2.1.0

• SelectionID's update: use Custom Visuals Selection id's instead of old Selection id's
• Remove Semantic Query dependency inside the iFrame
• Serialize DataView and remove multiple DataView types