Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SaguaroPluginPublicInterface

Hierarchy

Index

Methods

Methods

cameraFocus

  • cameraFocus(modelId: string, labelAsymId: string, positions: Array<number>, operatorName?: undefined | string): void
  • cameraFocus(modelId: string, labelAsymId: string, begin: number, end: number, operatorName?: undefined | string): void

  • Parameters

    • modelId: string
    • labelAsymId: string
    • positions: Array<number>
    • Optional operatorName: undefined | string

    Returns void

  • Parameters

    • modelId: string
    • labelAsymId: string
    • begin: number
    • end: number
    • Optional operatorName: undefined | string

    Returns void

clearFocus

  • clearFocus(): void

  • Returns void

clearSelection

  • clearSelection(mode: "select" | "hover", option?: SaguaroChain): void

  • Parameters

    Returns void

colorComponent

  • colorComponent(componentId: string, color: ColorTheme.BuiltIn): Promise<void>

  • Parameters

    • componentId: string
    • color: ColorTheme.BuiltIn

    Returns Promise<void>

createComponent

  • createComponent(componentId: string, modelId: string, labelAsymId: string, begin: number, end: number, representationType: StructureRepresentationRegistry.BuiltIn, operatorName?: undefined | string): Promise<void>
  • createComponent(componentId: string, modelId: string, labelAsymId: string, representationType: StructureRepresentationRegistry.BuiltIn, operatorName?: undefined | string): Promise<void>
  • createComponent(componentId: string, residues: Array<SaguaroPosition>, representationType: StructureRepresentationRegistry.BuiltIn): Promise<void>
  • createComponent(componentId: string, residues: Array<SaguaroRange>, representationType: StructureRepresentationRegistry.BuiltIn): Promise<void>

  • Parameters

    • componentId: string
    • modelId: string
    • labelAsymId: string
    • begin: number
    • end: number
    • representationType: StructureRepresentationRegistry.BuiltIn
    • Optional operatorName: undefined | string

    Returns Promise<void>

  • Parameters

    • componentId: string
    • modelId: string
    • labelAsymId: string
    • representationType: StructureRepresentationRegistry.BuiltIn
    • Optional operatorName: undefined | string

    Returns Promise<void>

  • Parameters

    • componentId: string
    • residues: Array<SaguaroPosition>
    • representationType: StructureRepresentationRegistry.BuiltIn

    Returns Promise<void>

  • Parameters

    • componentId: string
    • residues: Array<SaguaroRange>
    • representationType: StructureRepresentationRegistry.BuiltIn

    Returns Promise<void>

displayComponent

  • displayComponent(componentLabel: string, visibilityFlag: boolean): void
  • displayComponent(componentLabel: string): boolean

  • Parameters

    • componentLabel: string
    • visibilityFlag: boolean

    Returns void

  • Parameters

    • componentLabel: string

    Returns boolean

getComponentSet

  • getComponentSet(): Set<string>

  • Returns Set<string>

isComponent

  • isComponent(componentId: string): boolean

  • Parameters

    • componentId: string

    Returns boolean

removeComponent

  • removeComponent(componentId?: undefined | string): void

  • Parameters

    • Optional componentId: undefined | string

    Returns void

resetCamera

  • resetCamera(): void

  • Returns void

select

  • select(modelId: string, labelAsymId: string, x: number, y: number, mode: "select" | "hover", operation: "set" | "add", operatorName?: undefined | string): void
  • select(selection: Array<SaguaroPosition>, mode: "select" | "hover", operation: "add" | "set"): void
  • select(selection: Array<SaguaroRange>, mode: "select" | "hover", operation: "add" | "set"): void

  • Parameters

    • modelId: string
    • labelAsymId: string
    • x: number
    • y: number
    • mode: "select" | "hover"
    • operation: "set" | "add"
    • Optional operatorName: undefined | string

    Returns void

  • Parameters

    • selection: Array<SaguaroPosition>
    • mode: "select" | "hover"
    • operation: "add" | "set"

    Returns void

  • Parameters

    • selection: Array<SaguaroRange>
    • mode: "select" | "hover"
    • operation: "add" | "set"

    Returns void

setFocus

  • setFocus(modelId: string, labelAsymId: string, begin: number, end: number, operatorName?: undefined | string): void

  • Parameters

    • modelId: string
    • labelAsymId: string
    • begin: number
    • end: number
    • Optional operatorName: undefined | string

    Returns void

Generated using TypeDoc