pdbe-molstar/lib/plugin-custom-state.d.ts

Molstar implementation for PDBe

import { SymmetryOperator } from 'molstar/lib/mol-math/geometry';
import { Mat4 } from 'molstar/lib/mol-math/linear-algebra';
import { PluginContext } from 'molstar/lib/mol-plugin/context';
import { StateSelection, StateTransform } from 'molstar/lib/mol-state';
import { JSXElementConstructor } from 'react';
import { Subject } from 'rxjs';
import { InitParams } from './spec';
export interface PluginCustomState {
    initParams?: InitParams;
    events?: {
        segmentUpdate: Subject<boolean>;
        superpositionInit: Subject<boolean>;
        isBusy: Subject<boolean>;
    };
    superpositionState?: {
        models: {
            [molId: string]: string;
        };
        entries: {
            [pdbId: string]: StateSelection.Selector;
        };
        refMaps: {
            [ref: string]: string;
        };
        segmentData: Segment[] | undefined;
        matrixData: {
            [key: string]: {
                matrix: number[][];
            };
        };
        activeSegment: number;
        loadedStructs: string[][];
        visibleRefs: StateTransform.Ref[][];
        invalidStruct: string[];
        noMatrixStruct: string[];
        hets: {
            [key: string]: unknown[];
        };
        /** Counts how many colors have been assigned, per segment */
        colorCounters: number[];
        alphafold: {
            apiData: {
                /** URL of BCIF file */
                bcif: string;
                /** URL of CIF file */
                cif: string;
                /** URL of PAE image */
                pae: string;
                /** Length of UniProt sequence */
                length: number;
            };
            length: number;
            ref: string;
            traceOnly: boolean;
            visibility: boolean[];
            transforms: Mat4[];
            rmsds: string[][];
            coordinateSystems: (SymmetryOperator | undefined)[];
        };
    };
    superpositionError?: string;
    /** Space for extensions to save their plugin-bound custom state. Only access via `ExtensionCustomState`! */
    extensions?: {
        [extensionId: string]: {} | undefined;
    };
    /** Registry for custom UI components. Only access via `PluginCustomControls`! */
    customControls?: {
        [region in PluginCustomControlRegion]?: PluginCustomControlRegistry;
    };
}
export interface ClusterMember {
    pdb_id: string;
    auth_asym_id: string;
    struct_asym_id: string;
    entity_id: number;
    is_representative: boolean;
}
export interface Segment {
    segment_start: number;
    segment_end: number;
    clusters: ClusterMember[][];
    isHetView?: boolean;
    isBinary?: boolean;
}
/** Access `plugin.customState` only through this function to get proper typing.
 * Supports getting and setting properties. */
export declare function PluginCustomState(plugin: PluginContext): PluginCustomState;
/** Functions for accessing plugin-bound custom state for extensions. */
export declare const ExtensionCustomState: {
    /** Get plugin-bound custom state for a specific extension. If not present, initialize with empty object. */
    get<T extends {}>(plugin: PluginContext, extensionId: string): Partial<T>;
    /** Remove plugin-bound custom state for a specific extension (if present). */
    clear(plugin: PluginContext, extensionId: string): void;
    /** Return function which gets plugin-bound custom state for a specific extension. */
    getter<StateType extends {}>(extensionId: string): (plugin: PluginContext) => Partial<StateType>;
};
/** UI region where custom controls can be registered */
export type PluginCustomControlRegion = 'structure-tools' | 'viewport-top-center' | 'viewport-top-left';
/** Collection of registered custom controls in a UI region */
export type PluginCustomControlRegistry = Map<string, JSXElementConstructor<{}>>;
/** Functions for registering/unregistering custom UI controls */
export declare const PluginCustomControls: {
    /** Get custom controls in the specified UI `region`. */
    get(plugin: PluginContext, region: PluginCustomControlRegion): PluginCustomControlRegistry;
    /** Register a custom control in the specified UI `region`. */
    add(plugin: PluginContext, region: PluginCustomControlRegion, name: string, control: JSXElementConstructor<{}>): {
        delete: () => void;
    };
    /** Unregister a custom control in the specified UI `region`. */
    delete(plugin: PluginContext, region: PluginCustomControlRegion, name: string): void;
    /** Register/unregister a custom control in the specified UI `region`. */
    toggle(plugin: PluginContext, region: PluginCustomControlRegion, name: string, control: JSXElementConstructor<{}>, show: boolean): void;
};