Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PluginContext

Index

Constructors

Properties

animationLoop: PluginAnimationLoop
behaviors: { canvas3d: { initialized: Observable<boolean> }; interaction: { click: BehaviorSubject<<internal>.InteractivityManager.ClickEvent>; drag: BehaviorSubject<<internal>.InteractivityManager.DragEvent>; hover: BehaviorSubject<<internal>.InteractivityManager.HoverEvent>; selectionMode: BehaviorSubject<boolean> }; labels: { highlight: BehaviorSubject<{ labels: readonly LociLabel[] }> }; layout: { leftPanelTabName: BehaviorSubject<LeftPanelTabName> }; state: { isAnimating: BehaviorSubject<boolean>; isBusy: BehaviorSubject<boolean>; isUpdating: BehaviorSubject<boolean> } }

Type declaration

builders: { data: DataBuilder; structure: <internal>.StructureBuilder }

Type declaration

canvas3d: undefined | Canvas3D
canvas3dContext: undefined | Canvas3DContext
canvas3dInit: any
customImportControls: Map<string, new () => any>
customModelProperties: <internal>.Registry<<internal>.Model>
customState: unknown

Used to store application specific custom state which is then available to State Actions and similar constructs via the PluginContext.

customStructureControls: Map<string, new () => any>
customStructureProperties: <internal>.Registry<<internal>.Structure>
dataFormats: DataFormatRegistry
disposed: any
ev: any
events: { canvas3d: { settingsUpdated: Subject<unknown> }; log: Subject<LogEntry>; task: { finished: Subject<{ id: number }>; progress: Subject<<internal>.TaskManager.ProgressEvent> } }

Type declaration

fetch: { (url: string): Task<DataValue>; <T>(params: AjaxGetParams<T>): Task<DataResponse<T>> }

Type declaration

genericRepresentationControls: Map<string, (selection: { models: readonly ModelRef[]; structures: readonly StructureRef[]; trajectories: readonly TrajectoryRef[] }) => [StructureHierarchyRef[], string]>
helpers: { substructureParent: SubstructureParentHelper; viewportScreenshot: undefined | ViewportScreenshotHelper }

Type declaration

initAnimations: any
initBehaviorEvents: any
initBehaviors: any
initBuiltInBehavior: any
initCustomFormats: any
initDataActions: any
layout: PluginLayout
log: { entries: <internal>.List<LogEntry>; entry: any; error: any; info: any; message: any; warn: any }

Type declaration

  • entries: <internal>.List<LogEntry>
  • entry:function
    • Parameters

      Returns void

  • error:function
    • error(msg: string): void
    • Parameters

      • msg: string

      Returns void

  • info:function
    • info(msg: string): void
    • Parameters

      • msg: string

      Returns void

  • message:function
    • message(msg: string): void
    • Parameters

      • msg: string

      Returns void

  • warn:function
    • warn(msg: string): void
    • Parameters

      • msg: string

      Returns void

managers: { animation: PluginAnimationManager; asset: AssetManager; camera: CameraManager; interactivity: InteractivityManager; lociLabels: LociLabelManager; snapshot: PluginStateSnapshotManager; structure: { component: StructureComponentManager; focus: StructureFocusManager; hierarchy: StructureHierarchyManager; measurement: StructureMeasurementManager; selection: StructureSelectionManager }; task: TaskManager; toast: PluginToastManager; volume: { hierarchy: VolumeHierarchyManager } }

Type declaration

query: { structure: { registry: StructureSelectionQueryRegistry } }

Type declaration

representation: { structure: { registry: StructureRepresentationRegistry; themes: ThemeRegistryContext }; volume: { registry: VolumeRepresentationRegistry; themes: ThemeRegistryContext } }

Type declaration

resolveTask: <T>(object: undefined | T | Task<T>) => undefined | T | Promise<T>

Type declaration

    • <T>(object: undefined | T | Task<T>): undefined | T | Promise<T>
    • Type parameters

      • T

      Parameters

      • object: undefined | T | Task<T>

      Returns undefined | T | Promise<T>

runTask: <T>(task: Task<T>, params?: { useOverlay?: boolean }) => Promise<T>

Type declaration

    • <T>(task: Task<T>, params?: { useOverlay?: boolean }): Promise<T>
    • Type parameters

      • T

      Parameters

      • task: Task<T>
      • Optional params: { useOverlay?: boolean }
        • Optional useOverlay?: boolean

      Returns Promise<T>

Accessors

  • get isBusy(): boolean
  • return true is animating or updating

    Returns boolean

  • get selectionMode(): boolean
  • set selectionMode(mode: boolean): void
  • Returns boolean

  • Parameters

    • mode: boolean

    Returns void

Methods

  • Returns <internal>.Root

  • clear(resetViewportSettings?: boolean): Promise<void>
  • Parameters

    • Optional resetViewportSettings: boolean

    Returns Promise<void>

  • dataTransaction(f: (ctx: RuntimeContext) => void | Promise<void>, options?: { canUndo?: string | boolean; rethrowErrors?: boolean }): Promise<void>
  • Parameters

    • f: (ctx: RuntimeContext) => void | Promise<void>
    • Optional options: { canUndo?: string | boolean; rethrowErrors?: boolean }
      • Optional canUndo?: string | boolean
      • Optional rethrowErrors?: boolean

    Returns Promise<void>

  • dispose(options?: { doNotForceWebGLContextLoss?: boolean }): void
  • Parameters

    • Optional options: { doNotForceWebGLContextLoss?: boolean }
      • Optional doNotForceWebGLContextLoss?: boolean

    Returns void

  • handleResize(): void
  • Returns void

  • init(): Promise<void>
  • Returns Promise<void>

  • initViewer(canvas: HTMLCanvasElement, container: HTMLDivElement, canvas3dContext?: Canvas3DContext): boolean
  • Parameters

    • canvas: HTMLCanvasElement
    • container: HTMLDivElement
    • Optional canvas3dContext: Canvas3DContext

    Returns boolean

Generated using TypeDoc