Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IReceiveDimensions

Hierarchy

  • IVisual
    • IReceiveDimensions

Index

Methods

Methods

Optional canResizeTo

  • canResizeTo(viewport: IViewport): boolean

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

    Parameters

    • viewport: IViewport

    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

  • enumerateObjectInstances(options: EnumerateVisualObjectInstancesOptions): VisualObjectInstanceEnumeration

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

    Parameters

    • options: EnumerateVisualObjectInstancesOptions

    Returns VisualObjectInstanceEnumeration

Optional enumerateObjectRepetition

  • enumerateObjectRepetition(): VisualObjectRepetition[]

  • Gets the set of object repetitions that the visual can display.

    Returns VisualObjectRepetition[]

init

  • init(options: VisualInitOptions): void

  • Initializes an instance of the IVisual.

    Parameters

    • options: VisualInitOptions

      Initialization options for the visual.

    Returns void

Optional onClearSelection

  • onClearSelection(): void

  • Notifies the IVisual to clear any selection.

    Returns 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

Optional 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

  • Notifies the IVisual to change view mode if applicable.

    Parameters

    • viewMode: ViewMode

    Returns void

setDimensions

Optional update

  • update(options: VisualUpdateOptions): void

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

    Parameters

    • options: VisualUpdateOptions

    Returns void

Generated using TypeDoc