QuickCreate class

Power BI 快速创建组件

扩展

Embed

构造函数

QuickCreate(Service, HTMLElement, IQuickCreateConfiguration, boolean, boolean)

方法

getId()

重写 getId 抽象函数 QuickCreate 不需要任何 ID

validate(IEmbedConfigurationBase)

验证创建报表配置。

继承的方法

exitFullscreen()

请求浏览器退出全屏模式。

fullscreen()

请求浏览器以全屏模式呈现组件的 iframe。

getCorrelationId()

获取当前嵌入会话的 correlationId。

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });
off<T>(string, IEventHandler<T>)

从处理程序列表中删除一个或多个事件处理程序。 如果指定了对现有句柄函数的引用,请删除特定的处理程序。 如果未指定处理程序,请删除指定事件名称的所有处理程序。

report.off('pageChanged')

or

const logHandler = function (event) {
   console.log(event);
};

report.off('pageChanged', logHandler);
on<T>(string, IEventHandler<T>)

为特定事件添加事件处理程序。

report.on('pageChanged', (event) => {
  console.log('PageChanged: ', event.page.name);
});
reload()

使用现有配置重新加载嵌入。 例如,对于报表,这会有效地清除所有筛选器,并使第一页处于活动状态,从而模拟将报表重置回加载状态。

report.reload();
removeComponentTabIndex(number)

删除元素的 tabindex 属性

save()

保存报表。

saveAs(ISaveAsParameters)

SaveAs 报表。

setAccessToken(string)

设置 accessToken。

setComponentTabIndex(number)

设置元素的 tabindex 属性

setComponentTitle(string)

设置辅助功能的组件标题。 对于 iframe,此方法将更改 iframe 标题。

构造函数详细信息

QuickCreate(Service, HTMLElement, IQuickCreateConfiguration, boolean, boolean)

new QuickCreate(service: Service, element: HTMLElement, config: IQuickCreateConfiguration, phasedRender?: boolean, isBootstrap?: boolean)

参数

service
Service
element

HTMLElement

phasedRender

boolean

isBootstrap

boolean

方法详细信息

getId()

重写 getId 抽象函数 QuickCreate 不需要任何 ID

function getId(): string

返回

string

validate(IEmbedConfigurationBase)

验证创建报表配置。

function validate(config: IEmbedConfigurationBase): IError[]

参数

返回

IError[]

继承的方法详细信息

exitFullscreen()

请求浏览器退出全屏模式。

function exitFullscreen()

继承自 Embed.exitFullscreen

fullscreen()

请求浏览器以全屏模式呈现组件的 iframe。

function fullscreen()

继承自 Embed.fullscreen

getCorrelationId()

获取当前嵌入会话的 correlationId。

// Get the correlationId for the current embed session
report.getCorrelationId()
  .then(correlationId => {
    ...
  });
function getCorrelationId(): Promise<string>

返回

Promise<string>

继承自 Embed.getCorrelationId

off<T>(string, IEventHandler<T>)

从处理程序列表中删除一个或多个事件处理程序。 如果指定了对现有句柄函数的引用,请删除特定的处理程序。 如果未指定处理程序,请删除指定事件名称的所有处理程序。

report.off('pageChanged')

or

const logHandler = function (event) {
   console.log(event);
};

report.off('pageChanged', logHandler);
function off<T>(eventName: string, handler?: IEventHandler<T>)

参数

eventName

string

handler

IEventHandler<T>

继承自 Embed.off

on<T>(string, IEventHandler<T>)

为特定事件添加事件处理程序。

report.on('pageChanged', (event) => {
  console.log('PageChanged: ', event.page.name);
});
function on<T>(eventName: string, handler: IEventHandler<T>)

参数

eventName

string

handler

IEventHandler<T>

继承自 Embed.on 的

reload()

使用现有配置重新加载嵌入。 例如,对于报表,这会有效地清除所有筛选器,并使第一页处于活动状态,从而模拟将报表重置回加载状态。

report.reload();
function reload(): Promise<void>

返回

Promise<void>

继承自 Embed.reload

removeComponentTabIndex(number)

删除元素的 tabindex 属性

function removeComponentTabIndex(_tabIndex?: number)

参数

_tabIndex

number

继承自 Embed.removeComponentTabIndex

save()

保存报表。

function save(): Promise<void>

返回

Promise<void>

继承自 Embed.save

saveAs(ISaveAsParameters)

SaveAs 报表。

function saveAs(saveAsParameters: ISaveAsParameters): Promise<void>

参数

saveAsParameters
ISaveAsParameters

返回

Promise<void>

继承自 Embed.saveAs

setAccessToken(string)

设置 accessToken。

function setAccessToken(accessToken: string): Promise<void>

参数

accessToken

string

返回

Promise<void>

继承自 Embed.setAccessToken

setComponentTabIndex(number)

设置元素的 tabindex 属性

function setComponentTabIndex(tabIndex?: number)

参数

tabIndex

number

继承自 Embed.setComponentTabIndex

setComponentTitle(string)

设置辅助功能的组件标题。 对于 iframe,此方法将更改 iframe 标题。

function setComponentTitle(title: string)

参数

title

string

继承自 Embed.setComponentTitle