pdbe-molstar/lib/extensions/state-gallery/config.d.ts

Molstar implementation for PDBe

import { PluginContext } from 'molstar/lib/mol-plugin/context';
import { PluginConfigUtils } from '../../helpers';
/** Default values of plugin config items for the `StateGallery` extension */
export declare const StateGalleryConfigDefaults: {
    /** Base URL of the state API (list of states will be downloaded from `{ServerUrl}/{entryId}.json`, states from `{ServerUrl}/{stateName}.molj`) */
    ServerUrl: string;
    /** Load canvas properties, such as background, axes indicator, fog, outline (if false, keep current canvas properties) */
    LoadCanvasProps: boolean;
    /** Load camera orientation when loading state (if false, keep current orientation) */
    LoadCameraOrientation: boolean;
    /** Time in miliseconds between loading state and starting camera transition */
    CameraPreTransitionMs: number;
    /** Duration of the camera transition in miliseconds */
    CameraTransitionMs: number;
};
/** Values of plugin config items for the `StateGallery` extension */
export type StateGalleryConfigValues = typeof StateGalleryConfigDefaults;
/** Definition of plugin config items for the `StateGallery` extension */
export declare const StateGalleryConfig: PluginConfigUtils.ConfigFor<StateGalleryConfigValues>;
/** Retrieve config values the `StateGallery` extension from the current plugin config */
export declare function getStateGalleryConfig(plugin: PluginContext): StateGalleryConfigValues;