powerbi-client package

  • Reference

Classes

AdvancedFilterBuilder

Power BI Advanced filter builder component
BasicFilterBuilder

Power BI Basic filter builder component
FilterBuilder

Generic filter builder for BasicFilter, AdvancedFilter, RelativeDate, RelativeTime and TopN
RelativeDateFilterBuilder

Power BI Relative Date filter builder component
RelativeTimeFilterBuilder

Power BI Relative Time filter builder component
TopNFilterBuilder

Power BI Top N filter builder component
BookmarksManager

Manages report bookmarks.
Create

A Power BI Report creator component
Dashboard

A Power BI Dashboard embed component
Page

A Power BI report page
AdvancedFilter
BasicFilter
BasicFilterWithKeys
Filter
HierarchyFilter
IdentityFilter
IncludeExcludeFilter
NotSupportedFilter
PageSelector
RelativeDateFilter
RelativeTimeFilter
Selector
SlicerTargetSelector
TopNFilter
TupleFilter
VisualSelector
VisualTypeSelector
Qna

The Power BI Q&A embed component
QuickCreate

A Power BI Quick Create component
Report

The Power BI Report embed component
Service

The Power BI Service embed component, which is the entry point to embed all other Power BI components into your application
Tile

The Power BI tile embed component
MIMEParams

The MIMEParams API provides read and write access to the parameters of aMIMEType.
MIMEType

An implementation of the MIMEType class.

In accordance with browser conventions, all properties of MIMEType objects are implemented as getters and setters on the class prototype, rather than as data properties on the object itself.

A MIME string is a structured string containing multiple meaningful components. When parsed, a MIMEType object is returned containing properties for each of these components.
TextDecoder

An implementation of the WHATWG Encoding Standard TextDecoder API.

const decoder = new TextDecoder();
const u8arr = new Uint8Array([72, 101, 108, 108, 111]);
console.log(decoder.decode(u8arr)); // Hello
TextEncoder

An implementation of the WHATWG Encoding Standard TextEncoder API. All instances of TextEncoder only support UTF-8 encoding.

const encoder = new TextEncoder();
const uint8array = encoder.encode('this is some data');

The TextEncoder class is also available on the global object.
Visual

The Power BI Visual embed component
VisualDescriptor

A Power BI visual within a page

Interfaces

IBookmarksManager

APIs for managing the report bookmarks.
IDashboardNode

A Dashboard node within a dashboard hierarchy
IFilterable

Decorates embed components that support filters Examples include reports and pages
IPageNode

A Page node within a report hierarchy
EventHooks
IActionBar
IAddBookmarkRequest
IAdvancedFilter
IAdvancedFilterCondition
IAggregationTarget
IApplyBookmarkByNameRequest
IApplyBookmarkStateRequest
IBaseFilterTarget
IBaseTarget
IBasicFilter
IBasicFilterWithKeys
IBetweenDataReference
IBookmarksPane
IBootstrapEmbedConfiguration
ICanvasStyle
ICaptureBookmarkOptions
ICaptureBookmarkRequest
ICavasItemsSelection
ICloneVisualRequest
ICloneVisualResponse
ICollapsible
IColumnAggrTarget
IColumnSchema
IColumnTarget
ICommandExtension
ICommandSettings
ICommandsSettings
ICommonEmbedConfiguration
ICreateVisualRequest
ICreateVisualResponse
ICredential
ICustomLayout
ICustomPageSize
ICustomTheme
IDashboardEmbedConfiguration
IDashboardLoadConfiguration
IDataReference
IDatasetBinding
IDatasetCreateConfiguration
IDatasourceConnectionConfiguration
IDataTable
IDefaultProperty
IEmbedConfiguration
IEmbedConfigurationBase
IEqualsDataReference
IError
IExportDataRequest
IExportDataResult
IExtension
IExtensionItem
IExtensionPoint
IExtensionPoints
IExtensions
IFieldsPane
IFilter
IFilterAggregationTarget
IFilterColumnAggrTarget
IFilterColumnTarget
IFilterDisplaySettings
IFilterGroupedColumnsTarget
IFilterHierarchyAggrTarget
IFilterHierarchyTarget
IFilterKeyColumnsTarget
IFilterKeyHierarchyTarget
IFilterMeasureTarget
IFiltersPane
IFlatMenuExtension
IGroupedMenuExtension
IHideable
IHierarchyFilter
IHierarchyFilterNode
IHierarchyLevelAggrTarget
IHierarchyLevelTarget
IIdentityFilter
IIdentityValue
IIncludeExcludeFilter
IKeyColumnsTarget
IKeyHierarchyTarget
ILoadQnaConfiguration
ILocaleSettings
IMeasureTarget
IMenuExtensionBase
IMenuGroupExtension
INotSupportedFilter
INotSupportedFilterTarget
INotSupportedTarget
IPage
IPageBackground
IPageLayout
IPageNavigationPane
IPageSelector
IPageSize
IPageWallpaper
IPaginatedReportDatasetBinding
IPaginatedReportLoadConfiguration
IPaginatedReportParameter
IPaginatedReportsCommandSettings
IPaginatedReportsCommandsSettings
IPaginatedReportSettings
IPanes
IParametersPanelCommandSettings
IPercentOfGrandTotalTarget
IPlayBookmarkRequest
IPosition
IPrintSettings
IQnaEmbedConfiguration
IQnaInterpretInputData
IQnaPanes
IQnaSettings
IQnaVisualRenderedEvent
IQuickCreateConfiguration
IRelativeDateFilter
IRelativeDateTimeFilter
IRelativeTimeFilter
IReport
IReportBars
IReportBookmark
IReportCreateConfiguration
IReportEmbedConfiguration
IReportLoadConfiguration
IReportPanes
IReportTheme
ISaveAsParameters
ISelection
ISelectionPane
ISelector
ISettings
ISlicer
ISlicerState
ISlicerTargetSelector
ISmartNarratives
ISortByVisualRequest
IStatusBar
ISwipeEvent
ISyncSlicersPane
ITableSchema
ITechnicalDetails
IThemeColorProperty
ITileEmbedConfiguration
ITileLoadConfiguration
ITopNFilter
ITupleElementValue
ITupleFilter
IUpdateFiltersRequest
IValueDataReference
IVisual
IVisualCapabilities
IVisualContainerDisplayState
IVisualCustomCommandEvent
IVisualDataRole
IVisualEmbedConfiguration
IVisualHeader
IVisualHeaderSettings
IVisualizationsPane
IVisualLayout
IVisualPropertySelector
IVisualPropertyValue
IVisualResponse
IVisualSelector
IVisualSettings
IVisualTypeSelector
OnLoadFilters
OnLoadFiltersBase
PageOnLoadFilters
ReportOnLoadFilters
IReportNode

A Report node within a report hierarchy
IDebugOptions
IEvent
IPowerBiElement
IService
IServiceConfiguration
CustomPromisifyLegacy
CustomPromisifySymbol
DebugLogger
EncodeIntoResult
InspectOptions
InspectOptionsStylized
ParseArgsConfig
IVisualNode

A Visual node within a report hierarchy
Document

Any web page loaded in the browser and serves as an entry point into the web page's content, which is the DOM tree.
HTMLIFrameElement

Provides special properties and methods (beyond those of the HTMLElement interface it also has available to it by inheritance) for manipulating the layout and presentation of inline frame elements.
Window

A window containing a DOM document; the document property points to the DOM document loaded in that window.

Type Aliases

IBootstrapEmbedConfiguration
IDashboardEmbedConfiguration
IEmbedConfiguration
IEmbedConfigurationBase
IEmbedSettings
ILocaleSettings
IQnaEmbedConfiguration
IQnaSettings
IQuickCreateConfiguration
IReportCreateConfiguration
IReportEmbedConfiguration
ITileEmbedConfiguration
IVisualEmbedConfiguration
AdvancedFilterConditionOperators
AdvancedFilterLogicalOperators
BasicFilterOperators
CommandExtensionSelector
Extensions
HierarchyFilterNodeOperators
IApplyBookmarkRequest
IdentityFilterOperators
IFilterGeneralTarget
IFilterKeyTarget
IFilterTarget
IIdentityFilterTarget
IKeyTarget
IMenuExtension
ISelectable
ISlicerFilter
ITarget
ITupleFilterTarget
KeyValuePair
PageLevelFilters
PagesLayout
PageView
PrimitiveValueType
ReportLevelFilters
SlicerSelector
SlicerTarget
TopNFilterOperators
TupleFilterOperators
TupleValueType
VisualCommandSelector
VisualHeaderSelector
VisualLevelFilters
VisualsHeaderSelector
VisualsLayout
IComponentEmbedConfiguration
CustomInspectFunction
CustomPromisify
DebugLoggerFunction
Style

Enums

AggregateFunction
BackgroundType
BookmarksPlayMode
BrowserPrintAdjustmentsMode
CommandDisplayOption
ContrastMode
CredentialType
DataCacheMode
DataType
DisplayOption
ExportDataType
FiltersLevel
FiltersOperations
FilterType
HyperlinkClickBehavior
LayoutType
MenuLocation
PageNavigationPosition
PageSizeType
Permissions
QnaMode
RelativeDateFilterTimeUnit
RelativeDateOperators
ReportAlignment
ReportCreationMode
SectionVisibility
SortDirection
TokenType
TraceType
ViewMode
VisualContainerDisplayMode
VisualDataRoleKind
VisualDataRoleKindPreference