VolumeStreaming | @rcsb/rcsb-saguaro-3d

Index

Classes

Behavior

Interfaces

Type aliases

Variables

Functions

Type aliases

ChannelType

ChannelType: "em" | "2fo-fc" | "fo-fc(+ve)" | "fo-fc(-ve)"

Channels

Channels: { [ name in ChannelType]?: ChannelInfo }

DefaultChannelParams

DefaultChannelParams: { [ name in ChannelType]?: Partial<ChannelParams> }

EntryParamDefinition

EntryParamDefinition: ReturnType<typeof createEntryParams>

EntryParams

EntryParams: <internal>.Values<EntryParamDefinition>

ParamDefinition

ParamDefinition: ReturnType<typeof createParams>

Params

Params: <internal>.Values<ParamDefinition>

ViewTypes

ViewTypes: "off" | "box" | "selection-box" | "cell" | "auto"

Variables

Const ChannelTypeOptions

ChannelTypeOptions: [ChannelType, string][]

Const RootTag

RootTag: "volume-streaming-info" = "volume-streaming-info"

Const ViewTypeOptions

ViewTypeOptions: [ViewTypes, string][]

Functions

createEntryParams

createEntryParams(options: { channelParams?: DefaultChannelParams; defaultView?: ViewTypes; entryData?: EntryData; structure?: <internal>.Structure }): { channels: <internal>.Group<Normalize<{ em: Normalize<ChannelParams> }>> | <internal>.Group<Normalize<{ 2fo-fc: Normalize<ChannelParams>; fo-fc(+ve): Normalize<ChannelParams>; fo-fc(-ve): Normalize<ChannelParams> }>>; detailLevel: <internal>.Select<number>; view: <internal>.Mapped<NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; isSelection: boolean; radius: number; selectionDetailLevel: number; topRight: <internal>.Vec3 }>, "auto"> | NamedParams<Normalize<{}>, "cell"> | NamedParams<Normalize<{}>, "off"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; topRight: <internal>.Vec3 }>, "box"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; radius: number; topRight: <internal>.Vec3 }>, "selection-box">> }

- Defined in node_modules/molstar/lib/mol-plugin/behavior/dynamic/volume-streaming/behavior.d.ts:78
Parameters
- options: { channelParams?: DefaultChannelParams; defaultView?: ViewTypes; entryData?: EntryData; structure?: <internal>.Structure }
  - Optional channelParams?: DefaultChannelParams
  - Optional defaultView?: ViewTypes
  - Optional entryData?: EntryData
  - Optional structure?: <internal>.Structure
Returns { channels: <internal>.Group<Normalize<{ em: Normalize<ChannelParams> }>> | <internal>.Group<Normalize<{ 2fo-fc: Normalize<ChannelParams>; fo-fc(+ve): Normalize<ChannelParams>; fo-fc(-ve): Normalize<ChannelParams> }>>; detailLevel: <internal>.Select<number>; view: <internal>.Mapped<NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; isSelection: boolean; radius: number; selectionDetailLevel: number; topRight: <internal>.Vec3 }>, "auto"> | NamedParams<Normalize<{}>, "cell"> | NamedParams<Normalize<{}>, "off"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; topRight: <internal>.Vec3 }>, "box"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; radius: number; topRight: <internal>.Vec3 }>, "selection-box">> }
- channels: <internal>.Group<Normalize<{ em: Normalize<ChannelParams> }>> | <internal>.Group<Normalize<{ 2fo-fc: Normalize<ChannelParams>; fo-fc(+ve): Normalize<ChannelParams>; fo-fc(-ve): Normalize<ChannelParams> }>>
- detailLevel: <internal>.Select<number>
- view: <internal>.Mapped<NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; isSelection: boolean; radius: number; selectionDetailLevel: number; topRight: <internal>.Vec3 }>, "auto"> | NamedParams<Normalize<{}>, "cell"> | NamedParams<Normalize<{}>, "off"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; topRight: <internal>.Vec3 }>, "box"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; radius: number; topRight: <internal>.Vec3 }>, "selection-box">>

createParams

createParams(options?: { channelParams?: DefaultChannelParams; data?: <internal>.VolumeServerInfo.Data; defaultView?: ViewTypes }): { entry: <internal>.Mapped<NamedParams<<internal>.Values<{ channels: <internal>.Group<Normalize<{ em: Normalize<ChannelParams> }>> | <internal>.Group<Normalize<{ 2fo-fc: Normalize<ChannelParams>; fo-fc(+ve): Normalize<ChannelParams>; fo-fc(-ve): Normalize<ChannelParams> }>>; detailLevel: <internal>.Select<number>; view: <internal>.Mapped<NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; isSelection: boolean; radius: number; selectionDetailLevel: number; topRight: <internal>.Vec3 }>, "auto"> | NamedParams<Normalize<{}>, "cell"> | NamedParams<Normalize<{}>, "off"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; topRight: <internal>.Vec3 }>, "box"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; radius: number; topRight: <internal>.Vec3 }>, "selection-box">> }>, string>> }

- Defined in node_modules/molstar/lib/mol-plugin/behavior/dynamic/volume-streaming/behavior.d.ts:46
Parameters
- Optional options: { channelParams?: DefaultChannelParams; data?: <internal>.VolumeServerInfo.Data; defaultView?: ViewTypes }
  - Optional channelParams?: DefaultChannelParams
  - Optional data?: <internal>.VolumeServerInfo.Data
  - Optional defaultView?: ViewTypes
Returns { entry: <internal>.Mapped<NamedParams<<internal>.Values<{ channels: <internal>.Group<Normalize<{ em: Normalize<ChannelParams> }>> | <internal>.Group<Normalize<{ 2fo-fc: Normalize<ChannelParams>; fo-fc(+ve): Normalize<ChannelParams>; fo-fc(-ve): Normalize<ChannelParams> }>>; detailLevel: <internal>.Select<number>; view: <internal>.Mapped<NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; isSelection: boolean; radius: number; selectionDetailLevel: number; topRight: <internal>.Vec3 }>, "auto"> | NamedParams<Normalize<{}>, "cell"> | NamedParams<Normalize<{}>, "off"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; topRight: <internal>.Vec3 }>, "box"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; radius: number; topRight: <internal>.Vec3 }>, "selection-box">> }>, string>> }
- entry: <internal>.Mapped<NamedParams<<internal>.Values<{ channels: <internal>.Group<Normalize<{ em: Normalize<ChannelParams> }>> | <internal>.Group<Normalize<{ 2fo-fc: Normalize<ChannelParams>; fo-fc(+ve): Normalize<ChannelParams>; fo-fc(-ve): Normalize<ChannelParams> }>>; detailLevel: <internal>.Select<number>; view: <internal>.Mapped<NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; isSelection: boolean; radius: number; selectionDetailLevel: number; topRight: <internal>.Vec3 }>, "auto"> | NamedParams<Normalize<{}>, "cell"> | NamedParams<Normalize<{}>, "off"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; topRight: <internal>.Vec3 }>, "box"> | NamedParams<Normalize<{ bottomLeft: <internal>.Vec3; radius: number; topRight: <internal>.Vec3 }>, "selection-box">> }>, string>>

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

ChannelType

Channels

DefaultChannelParams

EntryParamDefinition

EntryParams

ParamDefinition

Params

ViewTypes

Variables

Const ChannelTypeOptions

Const RootTag

Const ViewTypeOptions

Functions

createEntryParams

Parameters

options: { channelParams?: DefaultChannelParams; defaultView?: ViewTypes; entryData?: EntryData; structure?: <internal>.Structure }

Optional channelParams?: DefaultChannelParams

Optional defaultView?: ViewTypes

Optional entryData?: EntryData

Optional structure?: <internal>.Structure

channels: <internal>.Group<Normalize<{ em: Normalize<ChannelParams> }>> | <internal>.Group<Normalize<{ 2fo-fc: Normalize<ChannelParams>; fo-fc(+ve): Normalize<ChannelParams>; fo-fc(-ve): Normalize<ChannelParams> }>>

detailLevel: <internal>.Select<number>

createParams

Parameters

Optional options: { channelParams?: DefaultChannelParams; data?: <internal>.VolumeServerInfo.Data; defaultView?: ViewTypes }

Optional channelParams?: DefaultChannelParams

Optional data?: <internal>.VolumeServerInfo.Data

Optional defaultView?: ViewTypes