pdbe-molstar/lib/extensions/state-gallery/config.js

Molstar implementation for PDBe

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.StateGalleryConfig = exports.StateGalleryConfigDefaults = void 0;
exports.getStateGalleryConfig = getStateGalleryConfig;
const config_1 = require("molstar/lib/mol-plugin/config");
const helpers_1 = require("../../helpers");
/** Default values of plugin config items for the `StateGallery` extension */
exports.StateGalleryConfigDefaults = {
    /** Base URL of the state API (list of states will be downloaded from `{ServerUrl}/{entryId}.json`, states from `{ServerUrl}/{stateName}.molj`) */
    ServerUrl: 'https://www.ebi.ac.uk/pdbe/static/entry',
    /** Load canvas properties, such as background, axes indicator, fog, outline (if false, keep current canvas properties) */
    LoadCanvasProps: false,
    /** Load camera orientation when loading state (if false, keep current orientation) */
    LoadCameraOrientation: true,
    /** Time in miliseconds between loading state and starting camera transition */
    CameraPreTransitionMs: 100,
    /** Duration of the camera transition in miliseconds */
    CameraTransitionMs: 400,
};
/** Definition of plugin config items for the `StateGallery` extension */
exports.StateGalleryConfig = {
    ServerUrl: new config_1.PluginConfigItem('pdbe-state-gallery.server-url', exports.StateGalleryConfigDefaults.ServerUrl),
    LoadCanvasProps: new config_1.PluginConfigItem('pdbe-state-gallery.load-canvas-props', exports.StateGalleryConfigDefaults.LoadCanvasProps),
    LoadCameraOrientation: new config_1.PluginConfigItem('pdbe-state-gallery.load-camera-orientation', exports.StateGalleryConfigDefaults.LoadCameraOrientation),
    CameraPreTransitionMs: new config_1.PluginConfigItem('pdbe-state-gallery.camera-pre-transition-ms', exports.StateGalleryConfigDefaults.CameraPreTransitionMs),
    CameraTransitionMs: new config_1.PluginConfigItem('pdbe-state-gallery.camera-transition-ms', exports.StateGalleryConfigDefaults.CameraTransitionMs),
};
/** Retrieve config values the `StateGallery` extension from the current plugin config */
function getStateGalleryConfig(plugin) {
    return helpers_1.PluginConfigUtils.getConfigValues(plugin, exports.StateGalleryConfig, exports.StateGalleryConfigDefaults);
}