Type Alias ViewerRef

ViewerRef: {
    bimInfo: BimInfoPanelRef;
    camera: CameraRef;
    container: Container;
    contextMenu: ContextMenuRef;
    controlBar: ControlBarRef;
    core: Core.Webgl.Viewer;
    dispose: () => void;
    isolation: IsolationRef;
    isolationPanel: GenericPanelHandle;
    loader: ComponentLoader;
    modal: ModalHandle;
    sectionBox: SectionBoxRef;
    sectionBoxPanel: GenericPanelHandle;
    settings: SettingsRef;
}

Root-level API of the Vim viewer.

Type declaration

  • bimInfo: BimInfoPanelRef

    API To interact with the BIM info panel.

  • camera: CameraRef

    Camera API to interact with the viewer camera at a higher level.

  • container: Container

    HTML structure containing the viewer.

  • contextMenu: ContextMenuRef

    Context menu API managing the content and behavior of the context menu.

  • controlBar: ControlBarRef

    Control bar API managing the content and behavior of the control bar.

  • core: Core.Webgl.Viewer

    Vim WebGL viewer around which the WebGL viewer is built.

  • dispose: () => void

    Cleans up and releases resources used by the viewer.

  • isolation: IsolationRef

    Isolation API managing isolation state in the viewer.

  • isolationPanel: GenericPanelHandle

    API to interact with the isolation panel.

  • loader: ComponentLoader

    Vim WebGL loader to download VIMs.

  • modal: ModalHandle

    Message API to interact with the loading box.

  • sectionBox: SectionBoxRef

    Section box API managing the section box in the viewer.

  • sectionBoxPanel: GenericPanelHandle

    API to interact with the isolation panel.

  • settings: SettingsRef

    Settings API managing settings applied to the viewer.