molstar
Version:
A comprehensive macromolecular library.
24 lines (23 loc) • 1.36 kB
TypeScript
/**
* Copyright (c) 2023-2024 mol* contributors, licensed under MIT, See LICENSE file for more info.
*
* @author Adam Midlik <midlik@gmail.com>
*/
import type { ColorTheme } from '../../../mol-theme/color';
import type { ThemeDataContext } from '../../../mol-theme/theme';
import { ParamDefinition as PD } from '../../../mol-util/param-definition';
/** Parameter definition for color theme "MVS Annotation" */
export declare const MVSAnnotationColorThemeParams: {
annotationId: PD.Text<string>;
fieldName: PD.Text<string>;
background: PD.Color;
};
export type MVSAnnotationColorThemeParams = typeof MVSAnnotationColorThemeParams;
/** Parameter values for color theme "MVS Annotation" */
export type MVSAnnotationColorThemeProps = PD.Values<MVSAnnotationColorThemeParams>;
/** Return color theme that assigns colors based on an annotation file.
* The annotation file itself is handled by a custom model property (`MVSAnnotationsProvider`),
* the color theme then just uses this property. */
export declare function MVSAnnotationColorTheme(ctx: ThemeDataContext, props: MVSAnnotationColorThemeProps): ColorTheme<MVSAnnotationColorThemeParams>;
/** A thingy that is needed to register color theme "MVS Annotation" */
export declare const MVSAnnotationColorThemeProvider: ColorTheme.Provider<MVSAnnotationColorThemeParams, 'mvs-annotation'>;