Share via

VisualDescriptor class

  • Ссылка
Пакет:
powerbi-client

Визуальный элемент Power BI на странице

Свойства

layout

Визуальный макет: положение, размер и видимость.
name

Имя визуального элемента
page

Родительская страница Power BI, содержащая этот визуальный элемент
title

Заголовок визуального элемента
type

Тип визуального элемента

Методы

clone(ICloneVisualRequest)

Клонируйте существующий визуальный элемент в новый экземпляр.
exportData(ExportDataType, number)

Экспорт визуальных данных. Может экспортировать до 30 000 строк.
getFilters()

Возвращает все фильтры на уровне визуальных элементов текущего визуального элемента.

visual.getFilters()
 .then(filters => { ... });
getSlicerState()

Получение состояния среза. Работает только для визуальных элементов типа slicer.

visual.getSlicerState()
 .then(state => { ... });
getSmartNarrativeInsights()

Получение аналитических сведений для одного визуального элемента

visual.getSmartNarrativeInsights();
moveVisual(number, number, number)

Обновления положение визуального элемента.

visual.moveVisual(x, y, z)
  .catch(error => { ... });
removeFilters()

Удаляет все фильтры из текущего визуального элемента.

visual.removeFilters();
resizeVisual(number, number)

Изменение размера визуального элемента.

visual.resizeVisual(width, height)
  .catch(error => { ... });
setFilters(IFilter[])

Устанавливает фильтры в текущем визуальном элементе в значение "фильтры".

visual.setFilters(filters);
  .catch(errors => { ... });
setSlicerState(ISlicerState)

Задать состояние среза. Работает только для визуальных элементов типа slicer.
setVisualDisplayState(VisualContainerDisplayMode)

Обновления состояние отображения визуального элемента.

visual.setVisualDisplayState(displayState)
  .catch(error => { ... });
sortBy(ISortByVisualRequest)

Сортируйте визуальный элемент по dataField и направлению.
updateFilters(FiltersOperations, IFilter[])

Обновите фильтры для текущего визуального элемента в соответствии с операцией: добавить, заменить все, заменить на целевой или удалить.

visual.updateFilters(FiltersOperations.Add, filters)
  .catch(errors => { ... });

Сведения о свойстве

layout

Визуальный макет: положение, размер и видимость.

layout: IVisualLayout

Значение свойства

IVisualLayout

name

Имя визуального элемента

name: string

Значение свойства

string

page

Родительская страница Power BI, содержащая этот визуальный элемент

page: IPageNode

Значение свойства

IPageNode

title

Заголовок визуального элемента

title: string

Значение свойства

string

type

Тип визуального элемента

type: string

Значение свойства

string

Сведения о методе

clone(ICloneVisualRequest)

Клонируйте существующий визуальный элемент в новый экземпляр.

function clone(request?: ICloneVisualRequest): Promise<ICloneVisualResponse>

Параметры

request
ICloneVisualRequest

Возвращаемое значение

Promise<ICloneVisualResponse>

exportData(ExportDataType, number)

Экспорт визуальных данных. Может экспортировать до 30 000 строк.

function exportData(exportDataType?: ExportDataType, rows?: number): Promise<IExportDataResult>

Параметры

exportDataType
ExportDataType
rows

number

Возвращаемое значение

Promise<IExportDataResult>

getFilters()

Возвращает все фильтры на уровне визуальных элементов текущего визуального элемента.

visual.getFilters()
 .then(filters => { ... });

function getFilters(): Promise<IFilter[]>

Возвращаемое значение

Promise<IFilter[]>

getSlicerState()

Получение состояния среза. Работает только для визуальных элементов типа slicer.

visual.getSlicerState()
 .then(state => { ... });

function getSlicerState(): Promise<ISlicerState>

Возвращаемое значение

Promise<ISlicerState>

getSmartNarrativeInsights()

Получение аналитических сведений для одного визуального элемента

visual.getSmartNarrativeInsights();

function getSmartNarrativeInsights(): Promise<ISmartNarratives>

Возвращаемое значение

Promise<ISmartNarratives>

moveVisual(number, number, number)

Обновления положение визуального элемента.

visual.moveVisual(x, y, z)
  .catch(error => { ... });

function moveVisual(x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>>

Параметры

x

number

y

number

z

number

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

removeFilters()

Удаляет все фильтры из текущего визуального элемента.

visual.removeFilters();

function removeFilters(): Promise<IHttpPostMessageResponse<void>>

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

resizeVisual(number, number)

Изменение размера визуального элемента.

visual.resizeVisual(width, height)
  .catch(error => { ... });

function resizeVisual(width: number, height: number): Promise<IHttpPostMessageResponse<void>>

Параметры

width

number

height

number

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

setFilters(IFilter[])

Устанавливает фильтры в текущем визуальном элементе в значение "фильтры".

visual.setFilters(filters);
  .catch(errors => { ... });

function setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>>

Параметры

filters

IFilter[]

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

setSlicerState(ISlicerState)

Задать состояние среза. Работает только для визуальных элементов типа slicer.

function setSlicerState(state: ISlicerState): Promise<IHttpPostMessageResponse<void>>

Параметры

state
ISlicerState

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

setVisualDisplayState(VisualContainerDisplayMode)

Обновления состояние отображения визуального элемента.

visual.setVisualDisplayState(displayState)
  .catch(error => { ... });

function setVisualDisplayState(displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>>

Параметры

displayState
VisualContainerDisplayMode

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

sortBy(ISortByVisualRequest)

Сортируйте визуальный элемент по dataField и направлению.

function sortBy(request: ISortByVisualRequest): Promise<IHttpPostMessageResponse<void>>

Параметры

request
ISortByVisualRequest

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>

updateFilters(FiltersOperations, IFilter[])

Обновите фильтры для текущего визуального элемента в соответствии с операцией: добавить, заменить все, заменить на целевой или удалить.

visual.updateFilters(FiltersOperations.Add, filters)
  .catch(errors => { ... });

function updateFilters(operation: FiltersOperations, filters?: IFilter[]): Promise<IHttpPostMessageResponse<void>>

Параметры

operation
FiltersOperations
filters

IFilter[]

Возвращаемое значение

Promise<IHttpPostMessageResponse<void>>