@rcsb/rcsb-saguaro-3d
    Preparing search index...
    interface StructureViewerPublicInterface<R, L> {
        cameraFocus(
            modelId: string,
            labelAsymId: string,
            positions: number[],
            operatorName?: string,
        ): void;
        cameraFocus(
            modelId: string,
            labelAsymId: string,
            begin: number,
            end: number,
            operatorName?: string,
        ): void;
        clear(): Promise<void>;
        clearFocus(): void;
        clearSelection(mode: "select" | "hover", option?: SaguaroChain): void;
        colorComponent(
            componentLabel: string,
            color:
                | "cartoon"
                | "atom-id"
                | "carbohydrate-symbol"
                | "chain-id"
                | "element-index"
                | "element-symbol"
                | "entity-id"
                | "entity-source"
                | "external-structure"
                | "external-volume"
                | "formal-charge"
                | "hydrophobicity"
                | "illustrative"
                | "model-index"
                | "molecule-type"
                | "occupancy"
                | "operator-hkl"
                | "operator-name"
                | "partial-charge"
                | "polymer-id"
                | "polymer-index"
                | "residue-charge"
                | "residue-name"
                | "secondary-structure"
                | "sequence-id"
                | "shape-group"
                | "structure-index"
                | "trajectory-index"
                | "uncertainty"
                | "unit-index"
                | "uniform"
                | "volume-instance"
                | "volume-segment"
                | "volume-value",
        ): Promise<void>;
        createComponent(
            componentLabel: string,
            modelId: string,
            labelAsymId: string,
            begin: number,
            end: number,
            representationType:
                | "cartoon"
                | "backbone"
                | "ball-and-stick"
                | "carbohydrate"
                | "ellipsoid"
                | "gaussian-surface"
                | "gaussian-volume"
                | "label"
                | "line"
                | "molecular-surface"
                | "orientation"
                | "plane"
                | "point"
                | "putty"
                | "spacefill"
                | "polyhedron",
            operatorName?: string,
        ): Promise<void>;
        createComponent(
            componentLabel: string,
            modelId: string,
            labelAsymId: string,
            representationType:
                | "cartoon"
                | "backbone"
                | "ball-and-stick"
                | "carbohydrate"
                | "ellipsoid"
                | "gaussian-surface"
                | "gaussian-volume"
                | "label"
                | "line"
                | "molecular-surface"
                | "orientation"
                | "plane"
                | "point"
                | "putty"
                | "spacefill"
                | "polyhedron",
            operatorName?: string,
        ): Promise<void>;
        createComponent(
            componentLabel: string,
            residues: SaguaroPosition[],
            representationType:
                | "cartoon"
                | "backbone"
                | "ball-and-stick"
                | "carbohydrate"
                | "ellipsoid"
                | "gaussian-surface"
                | "gaussian-volume"
                | "label"
                | "line"
                | "molecular-surface"
                | "orientation"
                | "plane"
                | "point"
                | "putty"
                | "spacefill"
                | "polyhedron",
        ): Promise<void>;
        createComponent(
            componentLabel: string,
            residues: SaguaroRange[],
            representationType:
                | "cartoon"
                | "backbone"
                | "ball-and-stick"
                | "carbohydrate"
                | "ellipsoid"
                | "gaussian-surface"
                | "gaussian-volume"
                | "label"
                | "line"
                | "molecular-surface"
                | "orientation"
                | "plane"
                | "point"
                | "putty"
                | "spacefill"
                | "polyhedron",
        ): Promise<void>;
        displayComponent(componentLabel: string): boolean;
        displayComponent(componentLabel: string, visibilityFlag: boolean): void;
        exportLoadedStructures(): Promise<void>;
        getComponentSet(): Set<string>;
        isComponent(componentLabel: string): boolean;
        load(loadConfig: R): Promise<undefined | L>;
        load(loadConfig: R[]): Promise<(undefined | L)[]>;
        removeComponent(componentLabel?: string): Promise<void>;
        removeStructure(removeConfig: R | R[]): Promise<void>;
        resetCamera(): void;
        select(
            modelId: string,
            labelAsymId: string,
            begin: number,
            end: number,
            mode: "select" | "hover",
            operation: "set" | "add",
            operatorName?: string,
        ): void;
        select(
            selection: SaguaroPosition[],
            mode: "select" | "hover",
            operation: "set" | "add",
        ): void;
        select(
            selection: SaguaroRange[],
            mode: "select" | "hover",
            operation: "set" | "add",
        ): void;
        setFocus(
            modelId: string,
            labelAsymId: string,
            begin: number,
            end: number,
            operatorName?: string,
        ): void;
    }

    Type Parameters

    • R
    • L

    Hierarchy (View Summary)

    Index

    Methods

    • Parameters

      • componentLabel: string
      • color:
            | "cartoon"
            | "atom-id"
            | "carbohydrate-symbol"
            | "chain-id"
            | "element-index"
            | "element-symbol"
            | "entity-id"
            | "entity-source"
            | "external-structure"
            | "external-volume"
            | "formal-charge"
            | "hydrophobicity"
            | "illustrative"
            | "model-index"
            | "molecule-type"
            | "occupancy"
            | "operator-hkl"
            | "operator-name"
            | "partial-charge"
            | "polymer-id"
            | "polymer-index"
            | "residue-charge"
            | "residue-name"
            | "secondary-structure"
            | "sequence-id"
            | "shape-group"
            | "structure-index"
            | "trajectory-index"
            | "uncertainty"
            | "unit-index"
            | "uniform"
            | "volume-instance"
            | "volume-segment"
            | "volume-value"

      Returns Promise<void>

    • Parameters

      • componentLabel: string
      • modelId: string
      • labelAsymId: string
      • begin: number
      • end: number
      • representationType:
            | "cartoon"
            | "backbone"
            | "ball-and-stick"
            | "carbohydrate"
            | "ellipsoid"
            | "gaussian-surface"
            | "gaussian-volume"
            | "label"
            | "line"
            | "molecular-surface"
            | "orientation"
            | "plane"
            | "point"
            | "putty"
            | "spacefill"
            | "polyhedron"
      • OptionaloperatorName: string

      Returns Promise<void>

    • Parameters

      • componentLabel: string
      • modelId: string
      • labelAsymId: string
      • representationType:
            | "cartoon"
            | "backbone"
            | "ball-and-stick"
            | "carbohydrate"
            | "ellipsoid"
            | "gaussian-surface"
            | "gaussian-volume"
            | "label"
            | "line"
            | "molecular-surface"
            | "orientation"
            | "plane"
            | "point"
            | "putty"
            | "spacefill"
            | "polyhedron"
      • OptionaloperatorName: string

      Returns Promise<void>

    • Parameters

      • componentLabel: string
      • residues: SaguaroPosition[]
      • representationType:
            | "cartoon"
            | "backbone"
            | "ball-and-stick"
            | "carbohydrate"
            | "ellipsoid"
            | "gaussian-surface"
            | "gaussian-volume"
            | "label"
            | "line"
            | "molecular-surface"
            | "orientation"
            | "plane"
            | "point"
            | "putty"
            | "spacefill"
            | "polyhedron"

      Returns Promise<void>

    • Parameters

      • componentLabel: string
      • residues: SaguaroRange[]
      • representationType:
            | "cartoon"
            | "backbone"
            | "ball-and-stick"
            | "carbohydrate"
            | "ellipsoid"
            | "gaussian-surface"
            | "gaussian-volume"
            | "label"
            | "line"
            | "molecular-surface"
            | "orientation"
            | "plane"
            | "point"
            | "putty"
            | "spacefill"
            | "polyhedron"

      Returns Promise<void>