Class StructureRepresentationBuilder

Hierarchy

StructureRepresentationBuilder

Index

Constructors

constructor

new StructureRepresentationBuilder(plugin: PluginContext): <internal>.StructureRepresentationBuilder
Parameters
- plugin: PluginContext
Returns <internal>.StructureRepresentationBuilder
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:62

Properties

`Private` _providers

_providers: any

`Readonly` defaultProvider

defaultProvider: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>

plugin

plugin: PluginContext

`Private` providerMap

providerMap: any

Accessors

`Private` dataState

get dataState(): any
Returns any
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:17

providers

get providers(): readonly <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>[]
Returns readonly <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>[]
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:49

Methods

addRepresentation

addRepresentation<P>(structure: StateObjectRef<<internal>.Structure>, props: P, options?: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>): Promise<StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>>
Type Parameters
- P extends StructureRepresentationBuiltInProps<"label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill", "uniform" | "occupancy" | "element-index" | "element-symbol" | "shape-group" | "uncertainty" | "atom-id" | "carbohydrate-symbol" | "chain-id" | "operator-name" | "entity-id" | "entity-source" | "hydrophobicity" | "molecule-type" | "illustrative" | "model-index" | "operator-hkl" | "partial-charge" | "polymer-id" | "polymer-index" | "residue-name" | "secondary-structure" | "sequence-id" | "unit-index" | "volume-value", "uniform" | "physical" | "shape-group" | "uncertainty", P>
Parameters
- structure: StateObjectRef<<internal>.Structure>
- props: P
- Optional options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>
Returns Promise<StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:58
addRepresentation<P>(structure: StateObjectRef<<internal>.Structure>, props: P, options?: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>): Promise<StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>>
Type Parameters
- P extends StructureRepresentationProps<RepresentationProvider<<internal>.Structure, any, any, string>, <internal>.Provider<any, string, ColorType>, <internal>.Provider<any, string>, P>
Parameters
- structure: StateObjectRef<<internal>.Structure>
- props: P
- Optional options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>
Returns Promise<StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:59

applyPreset

applyPreset<K>(parent: StateObjectRef<<internal>.Structure>, preset: K, params?: <internal>.Params<{ atomic-detail: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; showCarbohydrateSymbol: boolean; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; auto: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; coarse-surface: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { lipid: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { lipid: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; empty: <internal>.StructureRepresentationPresetProvider<unknown, {}>; illustrative: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; showCarbohydrateSymbol: boolean; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; polymer-and-ligand: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { branched: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; coarse: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ion: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ligand: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; lipid: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; nonStandard: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; water: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { branchedBallAndStick: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branchedSnfg3d: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; coarse: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ion: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ligand: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; lipid: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; nonStandard: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; water: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; polymer-cartoon: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; protein-and-nucleic: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { nucleic: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; protein: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { nucleic: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; protein: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }> }[K]>): undefined | Promise<<internal>.StructureRepresentationPresetProvider.State<{ atomic-detail: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; showCarbohydrateSymbol: boolean; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; auto: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; coarse-surface: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { lipid: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { lipid: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; empty: <internal>.StructureRepresentationPresetProvider<unknown, {}>; illustrative: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; showCarbohydrateSymbol: boolean; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; polymer-and-ligand: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { branched: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; coarse: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ion: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ligand: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; lipid: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; nonStandard: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; water: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { branchedBallAndStick: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branchedSnfg3d: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; coarse: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ion: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ligand: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; lipid: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; nonStandard: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; water: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; polymer-cartoon: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; protein-and-nucleic: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { nucleic: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; protein: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { nucleic: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; protein: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }> }[K]>>
Type Parameters
- K extends "auto" | "empty" | "illustrative" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface"
Parameters
- parent: StateObjectRef<<internal>.Structure>
- preset: K
- Optional params: <internal>.Params<{ atomic-detail: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; showCarbohydrateSymbol: boolean; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; auto: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; coarse-surface: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { lipid: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { lipid: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; empty: <internal>.StructureRepresentationPresetProvider<unknown, {}>; illustrative: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; showCarbohydrateSymbol: boolean; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; polymer-and-ligand: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { branched: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; coarse: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ion: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ligand: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; lipid: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; nonStandard: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; water: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { branchedBallAndStick: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branchedSnfg3d: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; coarse: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ion: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ligand: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; lipid: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; nonStandard: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; water: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; polymer-cartoon: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; protein-and-nucleic: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { nucleic: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; protein: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { nucleic: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; protein: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }> }[K]>
Returns undefined | Promise<<internal>.StructureRepresentationPresetProvider.State<{ atomic-detail: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; showCarbohydrateSymbol: boolean; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; auto: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; coarse-surface: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { lipid: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { lipid: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; empty: <internal>.StructureRepresentationPresetProvider<unknown, {}>; illustrative: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; showCarbohydrateSymbol: boolean; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { all: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branched: undefined }; representations: { all: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; polymer-and-ligand: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { branched: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; coarse: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ion: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ligand: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; lipid: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; nonStandard: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; water: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { branchedBallAndStick: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; branchedSnfg3d: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; coarse: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ion: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; ligand: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; lipid: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; nonStandard: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; water: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; polymer-cartoon: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { polymer: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { polymer: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }>; protein-and-nucleic: <internal>.StructureRepresentationPresetProvider<{ ignoreHydrogens: undefined | boolean; ignoreLight: undefined | boolean; quality: undefined | "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; theme: undefined | Normalize<{ carbonColor: any; focus: any; globalName: any; symmetryColor: any }> }, { components?: undefined; representations?: undefined } | { components: { nucleic: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; protein: undefined | StateObjectSelector<<internal>.Structure, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> }; representations: { nucleic: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>; protein: StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>> } }> }[K]>>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:55
applyPreset<P, S>(parent: StateObjectRef<<internal>.Structure>, provider: <internal>.StructureRepresentationPresetProvider<P, S>, params?: P): undefined | Promise<S>
Type Parameters
- P = any
- S = {}
Parameters
- parent: StateObjectRef<<internal>.Structure>
- provider: <internal>.StructureRepresentationPresetProvider<P, S>
- Optional params: P
Returns undefined | Promise<S>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:56
applyPreset(parent: StateObjectRef<<internal>.Structure>, providerId: string, params?: any): undefined | Promise<any>
Parameters
- parent: StateObjectRef<<internal>.Structure>
- providerId: string
- Optional params: any
Returns undefined | Promise<any>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:57

buildRepresentation

buildRepresentation<P>(builder: <internal>.Root, structure: undefined | StateObjectRef<<internal>.Structure>, props: P, options?: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>): StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
Type Parameters
- P extends StructureRepresentationBuiltInProps<"label" | "line" | "orientation" | "carbohydrate" | "ellipsoid" | "cartoon" | "backbone" | "ball-and-stick" | "gaussian-surface" | "gaussian-volume" | "molecular-surface" | "point" | "putty" | "spacefill", "uniform" | "occupancy" | "element-index" | "element-symbol" | "shape-group" | "uncertainty" | "atom-id" | "carbohydrate-symbol" | "chain-id" | "operator-name" | "entity-id" | "entity-source" | "hydrophobicity" | "molecule-type" | "illustrative" | "model-index" | "operator-hkl" | "partial-charge" | "polymer-id" | "polymer-index" | "residue-name" | "secondary-structure" | "sequence-id" | "unit-index" | "volume-value", "uniform" | "physical" | "shape-group" | "uncertainty", P>
Parameters
- builder: <internal>.Root
- structure: undefined | StateObjectRef<<internal>.Structure>
- props: P
- Optional options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>
Returns StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:60
buildRepresentation<P>(builder: <internal>.Root, structure: undefined | StateObjectRef<<internal>.Structure>, props: P, options?: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>): StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
Type Parameters
- P extends StructureRepresentationProps<RepresentationProvider<<internal>.Structure, any, any, string>, <internal>.Provider<any, string, ColorType>, <internal>.Provider<any, string>, P>
Parameters
- builder: <internal>.Root
- structure: undefined | StateObjectRef<<internal>.Structure>
- props: P
- Optional options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>
Returns StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:61

getPresetSelect

getPresetSelect(s?: <internal>.Structure): <internal>.Select<string>
Parameters
- Optional s: <internal>.Structure
Returns <internal>.Select<string>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:51

getPresets

getPresets(s?: <internal>.Structure): readonly <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>[]
Parameters
- Optional s: <internal>.Structure
Returns readonly <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>[]
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:50

getPresetsWithOptions

getPresetsWithOptions(s: <internal>.Structure): <internal>.Mapped<NamedParams<any, string>>
Parameters
- s: <internal>.Structure
Returns <internal>.Mapped<NamedParams<any, string>>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:52

hasPreset

hasPreset(s: <internal>.Structure): boolean
Parameters
- s: <internal>.Structure
Returns boolean
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:48

registerPreset

registerPreset(provider: <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>): void
Parameters
- provider: <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:53

resolveProvider

resolveProvider(ref: <internal>.StructureRepresentationPresetProviderRef): <internal>.StructureRepresentationPresetProvider<unknown, {}>
Parameters
- ref: <internal>.StructureRepresentationPresetProviderRef
Returns <internal>.StructureRepresentationPresetProvider<unknown, {}>
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:47

unregisterPreset

unregisterPreset(provider: <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>): void
Parameters
- provider: <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>
Returns void
- Defined in node_modules/molstar/lib/mol-plugin-state/builder/structure/representation.d.ts:54

Class StructureRepresentationBuilder

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

plugin: PluginContext

Returns <internal>.StructureRepresentationBuilder

Properties

Private _providers

Readonly defaultProvider

plugin

Private providerMap

Accessors

Private dataState

Returns any

providers

Returns readonly <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>[]

Methods

addRepresentation

Type Parameters

Parameters

structure: StateObjectRef<<internal>.Structure>

props: P

Optional options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>

Returns Promise<StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>>

Type Parameters

P extends StructureRepresentationProps<RepresentationProvider<<internal>.Structure, any, any, string>, <internal>.Provider<any, string, ColorType>, <internal>.Provider<any, string>, P>

Parameters

structure: StateObjectRef<<internal>.Structure>

props: P

Optional options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>

Returns Promise<StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>>

applyPreset

Type Parameters

K extends "auto" | "empty" | "illustrative" | "atomic-detail" | "polymer-cartoon" | "polymer-and-ligand" | "protein-and-nucleic" | "coarse-surface"

Parameters

parent: StateObjectRef<<internal>.Structure>

preset: K

Type Parameters

P = any

S = {}

Parameters

parent: StateObjectRef<<internal>.Structure>

provider: <internal>.StructureRepresentationPresetProvider<P, S>

Optional params: P

Returns undefined | Promise<S>

Parameters

parent: StateObjectRef<<internal>.Structure>

providerId: string

Optional params: any

Returns undefined | Promise<any>

buildRepresentation

Type Parameters

Parameters

builder: <internal>.Root

structure: undefined | StateObjectRef<<internal>.Structure>

props: P

Optional options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>

Returns StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>

Type Parameters

P extends StructureRepresentationProps<RepresentationProvider<<internal>.Structure, any, any, string>, <internal>.Provider<any, string, ColorType>, <internal>.Provider<any, string>, P>

Parameters

builder: <internal>.Root

structure: undefined | StateObjectRef<<internal>.Structure>

props: P

Optional options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>

Returns StateObjectSelector<<internal>.Structure.Representation3D, <internal>.Transformer<StateObject<any, <internal>.StateObject.Type<any>>, StateObject<any, <internal>.StateObject.Type<any>>, any>>

getPresetSelect

Parameters

Optional s: <internal>.Structure

Returns <internal>.Select<string>

getPresets

Parameters

Optional s: <internal>.Structure

Returns readonly <internal>.StructureRepresentationPresetProvider<any, <internal>.StructureRepresentationPresetProvider.Result>[]

`Private` _providers

`Readonly` defaultProvider

`Private` providerMap

`Private` dataState

`Optional` options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>

`Optional` options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>

`Optional` params: P

`Optional` params: any

`Optional` options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>

`Optional` options: Partial<<internal>.StructureRepresentationBuilder.AddRepresentationOptions>

`Optional` s: <internal>.Structure

`Optional` s: <internal>.Structure