Share via


powerbi-client package

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

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 a MIMEType.

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

IReportNode

A Report node within a report hierarchy

IDebugOptions
IEvent
IPowerBiElement
IService
IServiceConfiguration
CallSiteObject
CustomPromisifyLegacy
CustomPromisifySymbol
DebugLogger
EncodeIntoResult
InspectOptions
InspectOptionsStylized
IsDeepStrictEqualOptions
ParseArgsConfig
ParseArgsOptionDescriptor
ParseArgsOptionsConfig
StyleTextOptions
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
IComponentEmbedConfiguration
CustomInspectFunction
CustomPromisify
DebugLoggerFunction
DiffEntry
ParseArgsOptionsType

Type of argument used in parseArgs.

Style