Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IVisual

Represents a visualization displayed within an application (PowerBI dashboards, ad-hoc reporting, etc.). This interface does not make assumptions about the underlying JS/HTML constructs the visual uses to render itself.

Hierarchy

  • IVisual

Implemented by

Index

Methods

Optional canResizeTo

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

    Parameters

    Returns boolean

Optional destroy

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

    Returns void

Optional enumerateObjectInstances

init

  • Initializes an instance of the IVisual.

    Parameters

    Returns void

Optional onClearSelection

  • onClearSelection(): void
  • Notifies the IVisual to clear any selection.

    Returns void

Optional onDataChanged

  • 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

    Returns void

onResizing

  • Notifies the IVisual to resize.

    Parameters

    • finalViewport: IViewport

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

    Returns void

Optional onSelectObject

Optional onStyleChanged

  • Notifies the IVisual of changes to the color, font, theme, and style related values that the visual should use.

    Parameters

    Returns void

Optional onViewModeChanged

  • onViewModeChanged(viewMode: ViewMode): void
  • Notifies the IVisual to change view mode if applicable.

    Parameters

    Returns void

Optional update

Generated using TypeDoc