Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CatchingVisualBase

A base implementation of IVisual that adds try/catch hooks around common lifecycle methods.

Optional functions in the interfaces have an empty default delegate implementation. Required methods have abstract delegates.

Hierarchy

Implements

  • IVisual

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected throwErrors

throwErrors: boolean

Protected visualName

visualName: string

Methods

canResizeTo

  • canResizeTo(viewport: IViewport): boolean

  • Gets a value indicating whether the IVisual can be resized to the given viewport.

    Parameters

    • viewport: IViewport

    Returns boolean

destroy

  • destroy(): void

  • Notifies the visual that it is being destroyed, and to do any cleanup necessary (such as unsubscribing event handlers).

    Returns void

Protected doDestroy

  • doDestroy(): void

Protected doInit

  • doInit(options: VisualInitOptions): void

Protected doOnResizing

  • doOnResizing(finalViewport: IViewport, resizeMode?: ResizeMode): void

Protected doUpdate

  • doUpdate(options: VisualUpdateOptions): void

enumerateObjectInstances

  • enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions): powerbi.VisualObjectInstanceEnumeration

  • Gets the set of objects that the visual is currently displaying.

    Parameters

    • options: EnumerateVisualObjectInstancesOptions

    Returns powerbi.VisualObjectInstanceEnumeration

enumerateObjectRepetition

  • enumerateObjectRepetition(): VisualObjectRepetition[]

Protected handleCanResizeTo

  • handleCanResizeTo(viewport: IViewport): boolean

Protected handleEnumerateObjectInstances

  • handleEnumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions): powerbi.VisualObjectInstanceEnumeration

  • Parameters

    • options: EnumerateVisualObjectInstancesOptions

    Returns powerbi.VisualObjectInstanceEnumeration

Protected handleEnumerateObjectRepetition

  • handleEnumerateObjectRepetition(): VisualObjectRepetition[]

Protected handleOnClearSelection

  • handleOnClearSelection(): void

Protected handleOnDataChanged

  • handleOnDataChanged(options: VisualDataChangedOptions): void

Protected handleOnViewModeChanged

  • handleOnViewModeChanged(viewMode: ViewMode): void

init

  • init(options: VisualInitOptions): void

  • Initializes an instance of the IVisual.

    Parameters

    • options: VisualInitOptions

      Initialization options for the visual.

    Returns void

onClearSelection

  • onClearSelection(): void

Optional onDataChanged

  • onDataChanged(options: VisualDataChangedOptions): void

  • Notifies the IVisual of new data being provided. This is an optional method that can be omitted if the visual is in charge of providing its own data.

    Parameters

    • options: VisualDataChangedOptions

    Returns void

onResizing

  • onResizing(finalViewport: IViewport, resizeMode?: ResizeMode): void

  • Notifies the IVisual to resize.

    Parameters

    • finalViewport: IViewport

      This is the viewport that the visual will eventually be resized to.

    • Optional resizeMode: ResizeMode

    Returns void

Optional onViewModeChanged

  • onViewModeChanged(viewMode: ViewMode): void

Private rethrow

  • rethrow(err: any): void

update

  • update(options: VisualUpdateOptions): void

  • Notifies the IVisual of an update (data, viewmode, size change).

    Parameters

    • options: VisualUpdateOptions

    Returns void

Generated using TypeDoc