powerbi-models package

Classes

AdvancedFilter

BasicFilter

BasicFilterWithKeys

Filter

HierarchyFilter

HierarchyIdentityFilter

IdentityFilter

IncludeExcludeFilter

NotSupportedFilter

PageSelector

RelativeDateFilter

RelativeTimeFilter

Selector

SlicerTargetSelector

TopNFilter

TupleFilter

VisualSelector

VisualTypeSelector

Interfaces

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

IDataTable

IDatasetBinding

IDatasetCreateConfiguration

IDatasourceConnectionConfiguration

IDefaultProperty

IEmbedConfiguration

IEmbedConfigurationBase

IEqualsDataReference

IError

IExportDataCompletedEvent

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

IHierarchyIdentityFilter

IHierarchyIdentityFilterNode

IHierarchyLevelAggrTarget

IHierarchyLevelTarget

IIdentityFilter

IIdentityValue

IIncludeExcludeFilter

IIncludeExcludeTargetValue

IKeyColumnsTarget

IKeyHierarchyTarget

ILoadQnaConfiguration

ILocaleSettings

IMeasureTarget

IMenuExtensionBase

IMenuGroupExtension

INotSupportedFilter

INotSupportedFilterTarget

INotSupportedTarget

IPage

IPageBackground

IPageLayout

IPageNavigationPane

IPageSelector

IPageSize

IPageWallpaper

IPaginatedReportDatasetBinding

IPaginatedReportLoadConfiguration

IPaginatedReportParameter

IPaginatedReportSettings

IPaginatedReportsCommandSettings

IPaginatedReportsCommandsSettings

IPanes

IParametersPanelCommandSettings

IPercentOfGrandTotalTarget

IPlayBookmarkRequest

IPosition

IPrintSettings

IQnaEmbedConfiguration

IQnaInterpretInputData

IQnaPanes

IQnaSettings

IQnaVisualRenderedEvent

IQueryNameTarget

IQuickCreateConfiguration

IRelativeDateFilter

IRelativeDateTimeFilter

IRelativeTimeFilter

IReport

IReportBars

IReportBookmark

IReportCreateConfiguration

IReportCreateFromDefinitionConfiguration

IReportDefinition

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

IVisualCalculationTarget

IVisualCapabilities

IVisualContainerDisplayState

IVisualCustomCommandEvent

IVisualDataRole

IVisualEmbedConfiguration

IVisualHeader

IVisualHeaderSettings

IVisualLayout

IVisualPropertySelector

IVisualPropertyValue

IVisualResponse

IVisualSelector

IVisualSettings

IVisualTypeSelector

IVisualizationsPane

OnLoadFilters

OnLoadFiltersBase

PageOnLoadFilters

ReportOnLoadFilters

Type Aliases

AdvancedFilterConditionOperators

AdvancedFilterLogicalOperators

BasicFilterOperators

CommandExtensionSelector

Extensions

HierarchyFilterNodeOperators

IApplyBookmarkRequest

IFilterGeneralTarget

IFilterKeyTarget

IFilterTarget

IHierarchyIdentityFilterTarget

IIdentityFilterTarget

IIncludeExcludeFilterTarget

IKeyTarget

IMenuExtension

ISelectable

ISlicerFilter

ITarget

ITupleFilterTarget

IdentityFilterOperators

IncludeExcludeFilterValuesType

IncludeExcludePointType

IncludeExcludePointsGroupType

KeyValuePair

PageLevelFilters

PageView

PagesLayout

PrimitiveValueType

ReportLevelFilters

SlicerSelector

SlicerTarget

TopNFilterOperators

TupleFilterOperators

TupleValueType

VisualCommandSelector

VisualHeaderSelector

VisualLevelFilters

VisualsHeaderSelector

VisualsLayout

Enums

AggregateFunction

BackgroundType

BookmarksPlayMode

BrowserPrintAdjustmentsMode

CommandDisplayOption

ContrastMode

CredentialType

DataCacheMode

DataType

DisplayOption

ExportDataCompletedStatus

ExportDataResultFormat

ExportDataResultType

ExportDataType

FiltersLevel

FiltersOperations

FilterType

HyperlinkClickBehavior

LayoutType

MenuLocation

PageNavigationPosition

PageSizeType

Permissions

QnaMode

RelativeDateFilterTimeUnit

RelativeDateOperators

ReportAlignment

ReportCreationMode

SectionVisibility

SortDirection

TokenType

TraceType

ViewMode

VisualContainerDisplayMode

VisualDataRoleKind

VisualDataRoleKindPreference

Functions

getFilterType(IFilter)
isBasicFilterWithKeys(IFilter)
isColumn(any)
isColumnAggr(any)
isFilterKeyColumnsTarget(IFilterTarget)
isFlatMenuExtension(IMenuExtension)
isGroupedMenuExtension(IMenuExtension)
isHierarchyLevel(any)
isHierarchyLevelAggr(any)
isIExtensionArray(Extensions)
isIExtensions(Extensions)
isMeasure(any)
isOnLoadFilters(OnLoadFilters | ReportLevelFilters[])
isPercentOfGrandTotal(any)
isReportFiltersArray(OnLoadFilters | ReportLevelFilters[])
isVisualCalculation(any)
validateAddBookmarkRequest(any)
validateApplyBookmarkByNameRequest(any)
validateApplyBookmarkStateRequest(any)
validateBookmarksPane(any)
validateCaptureBookmarkRequest(any)
validateCommandsSettings(any)
validateCreateReport(any)
validateCreateReportFromDefinition(any)
validateCustomPageSize(any)
validateCustomTheme(any)
validateDashboardLoad(any)
validateExportDataRequest(any)
validateExtension(any)
validateFieldsPane(any)
validateFilter(any)
validateFiltersPane(any)
validateLoadQnaConfiguration(any)
validateMenuGroupExtension(any)
validatePage(any)
validatePageNavigationPane(any)
validatePaginatedReportLoad(any)
validatePanes(any)
validatePlayBookmarkRequest(any)
validatePrintSettings(any)
validateQnaInterpretInputData(any)
validateQuickCreate(any)
validateReportLoad(any)
validateSaveAsParameters(any)
validateSelectionPane(any)
validateSettings(any)
validateSlicer(any)
validateSlicerState(any)
validateSyncSlicersPane(any)
validateTileLoad(any)
validateUpdateFiltersRequest(any)
validateVisualHeader(any)
validateVisualizationsPane(any)
validateVisualSelector(any)
validateVisualSettings(any)
validateZoomLevel(any)

Variables

CommonErrorCodes
LegendPosition
TextAlignment

Function Details

getFilterType(IFilter)

function getFilterType(filter: IFilter): FilterType

Parameters

filter

IFilter

Returns

FilterType

isBasicFilterWithKeys(IFilter)

function isBasicFilterWithKeys(filter: IFilter): boolean

Parameters

filter

IFilter

Returns

boolean

isColumn(any)

function isColumn(arg: any): arg is IColumnTarget

Parameters

arg

any

Returns

arg is IColumnTarget

isColumnAggr(any)

function isColumnAggr(arg: any): arg is IColumnAggrTarget

Parameters

arg

any

Returns

arg is IColumnAggrTarget

isFilterKeyColumnsTarget(IFilterTarget)

function isFilterKeyColumnsTarget(target: IFilterTarget): boolean

Parameters

target

IFilterTarget

Returns

boolean

isFlatMenuExtension(IMenuExtension)

function isFlatMenuExtension(menuExtension: IMenuExtension): menuExtension is IFlatMenuExtension

Parameters

menuExtension

IMenuExtension

Returns

menuExtension is IFlatMenuExtension

isGroupedMenuExtension(IMenuExtension)

function isGroupedMenuExtension(menuExtension: IMenuExtension): menuExtension is IGroupedMenuExtension

Parameters

menuExtension

IMenuExtension

Returns

menuExtension is IGroupedMenuExtension

isHierarchyLevel(any)

function isHierarchyLevel(arg: any): arg is IHierarchyLevelTarget

Parameters

arg

any

Returns

arg is IHierarchyLevelTarget

isHierarchyLevelAggr(any)

function isHierarchyLevelAggr(arg: any): arg is IHierarchyLevelAggrTarget

Parameters

arg

any

Returns

arg is IHierarchyLevelAggrTarget

isIExtensionArray(Extensions)

function isIExtensionArray(extensions: Extensions): extensions is IExtension[]

Parameters

extensions

Extensions

Returns

extensions is IExtension[]

isIExtensions(Extensions)

function isIExtensions(extensions: Extensions): extensions is IExtensions

Parameters

extensions

Extensions

Returns

extensions is IExtensions

isMeasure(any)

function isMeasure(arg: any): arg is IMeasureTarget

Parameters

arg

any

Returns

arg is IMeasureTarget

isOnLoadFilters(OnLoadFilters | ReportLevelFilters[])

function isOnLoadFilters(filters: OnLoadFilters | ReportLevelFilters[]): filters is OnLoadFilters

Parameters

filters

OnLoadFilters | ReportLevelFilters[]

Returns

filters is OnLoadFilters

isPercentOfGrandTotal(any)

function isPercentOfGrandTotal(arg: any): arg is IPercentOfGrandTotalTarget

Parameters

arg

any

Returns

arg is IPercentOfGrandTotalTarget

isReportFiltersArray(OnLoadFilters | ReportLevelFilters[])

function isReportFiltersArray(filters: OnLoadFilters | ReportLevelFilters[]): filters is ReportLevelFilters[]

Parameters

filters

OnLoadFilters | ReportLevelFilters[]

Returns

filters is ReportLevelFilters[]

isVisualCalculation(any)

function isVisualCalculation(arg: any): arg is IVisualCalculationTarget

Parameters

arg

any

Returns

arg is IVisualCalculationTarget

validateAddBookmarkRequest(any)

function validateAddBookmarkRequest(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateApplyBookmarkByNameRequest(any)

function validateApplyBookmarkByNameRequest(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateApplyBookmarkStateRequest(any)

function validateApplyBookmarkStateRequest(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateBookmarksPane(any)

function validateBookmarksPane(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateCaptureBookmarkRequest(any)

function validateCaptureBookmarkRequest(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateCommandsSettings(any)

function validateCommandsSettings(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateCreateReport(any)

function validateCreateReport(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateCreateReportFromDefinition(any)

function validateCreateReportFromDefinition(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateCustomPageSize(any)

function validateCustomPageSize(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateCustomTheme(any)

function validateCustomTheme(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateDashboardLoad(any)

function validateDashboardLoad(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateExportDataRequest(any)

function validateExportDataRequest(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateExtension(any)

function validateExtension(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateFieldsPane(any)

function validateFieldsPane(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateFilter(any)

function validateFilter(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateFiltersPane(any)

function validateFiltersPane(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateLoadQnaConfiguration(any)

function validateLoadQnaConfiguration(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateMenuGroupExtension(any)

function validateMenuGroupExtension(input: any): IError[]

Parameters

input

any

Returns

IError[]

validatePage(any)

function validatePage(input: any): IError[]

Parameters

input

any

Returns

IError[]

validatePageNavigationPane(any)

function validatePageNavigationPane(input: any): IError[]

Parameters

input

any

Returns

IError[]

validatePaginatedReportLoad(any)

function validatePaginatedReportLoad(input: any): IError[]

Parameters

input

any

Returns

IError[]

validatePanes(any)

function validatePanes(input: any): IError[]

Parameters

input

any

Returns

IError[]

validatePlayBookmarkRequest(any)

function validatePlayBookmarkRequest(input: any): IError[]

Parameters

input

any

Returns

IError[]

validatePrintSettings(any)

function validatePrintSettings(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateQnaInterpretInputData(any)

function validateQnaInterpretInputData(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateQuickCreate(any)

function validateQuickCreate(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateReportLoad(any)

function validateReportLoad(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateSaveAsParameters(any)

function validateSaveAsParameters(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateSelectionPane(any)

function validateSelectionPane(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateSettings(any)

function validateSettings(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateSlicer(any)

function validateSlicer(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateSlicerState(any)

function validateSlicerState(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateSyncSlicersPane(any)

function validateSyncSlicersPane(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateTileLoad(any)

function validateTileLoad(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateUpdateFiltersRequest(any)

function validateUpdateFiltersRequest(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateVisualHeader(any)

function validateVisualHeader(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateVisualizationsPane(any)

function validateVisualizationsPane(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateVisualSelector(any)

function validateVisualSelector(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateVisualSettings(any)

function validateVisualSettings(input: any): IError[]

Parameters

input

any

Returns

IError[]

validateZoomLevel(any)

function validateZoomLevel(input: any): IError[]

Parameters

input

any

Returns

IError[]

Variable Details

CommonErrorCodes

CommonErrorCodes: { FailedToLoadModel: string, InvalidParameters: string, LoadReportFailed: string, NotAuthorized: string, NotFound: string, TokenExpired: string }

Type

{ FailedToLoadModel: string, InvalidParameters: string, LoadReportFailed: string, NotAuthorized: string, NotFound: string, TokenExpired: string }

LegendPosition

LegendPosition: { Bottom: string, BottomCenter: string, Left: string, LeftCenter: string, Right: string, RightCenter: string, Top: string, TopCenter: string }

Type

{ Bottom: string, BottomCenter: string, Left: string, LeftCenter: string, Right: string, RightCenter: string, Top: string, TopCenter: string }

TextAlignment

TextAlignment: { Center: string, Left: string, Right: string }

Type

{ Center: string, Left: string, Right: string }