Class ViewportScreenshotHelper

Hierarchy

PluginComponent
- ViewportScreenshotHelper

Index

Constructors

constructor

new ViewportScreenshotHelper(plugin: PluginContext): ViewportScreenshotHelper
Parameters
- plugin: PluginContext
Returns ViewportScreenshotHelper
Overrides PluginComponent.constructor
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:168

Properties

`Private` _imagePass

_imagePass: any

`Private` _params

_params: any

`Private` _previewPass

_previewPass: any

`Readonly` behaviors

behaviors: { cropParams: BehaviorSubject<{ auto: boolean; relativePadding: number }>; relativeCrop: BehaviorSubject<<internal>.Viewport>; values: BehaviorSubject<<internal>.Values<{ axes: <internal>.Mapped<NamedParams<Normalize<unknown>, "off"> | NamedParams<Normalize<{ alpha: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; colorX: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorY: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorZ: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; ignoreLight: boolean; instanceGranularity: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; scale: number; transparentBackfaces: string; xrayShaded: boolean }>, "on">>; resolution: <internal>.Mapped<NamedParams<Normalize<unknown>, "viewport"> | NamedParams<Normalize<unknown>, "hd"> | NamedParams<Normalize<unknown>, "full-hd"> | NamedParams<Normalize<unknown>, "ultra-hd"> | NamedParams<Normalize<{ height: number; width: number }>, "custom">>; transparent: BooleanParam }>> }

Type declaration

cropParams: BehaviorSubject<{ auto: boolean; relativePadding: number }>
relativeCrop: BehaviorSubject<<internal>.Viewport>
values: BehaviorSubject<<internal>.Values<{ axes: <internal>.Mapped<NamedParams<Normalize<unknown>, "off"> | NamedParams<Normalize<{ alpha: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; colorX: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorY: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorZ: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; ignoreLight: boolean; instanceGranularity: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; scale: number; transparentBackfaces: string; xrayShaded: boolean }>, "on">>; resolution: <internal>.Mapped<NamedParams<Normalize<unknown>, "viewport"> | NamedParams<Normalize<unknown>, "hd"> | NamedParams<Normalize<unknown>, "full-hd"> | NamedParams<Normalize<unknown>, "ultra-hd"> | NamedParams<Normalize<{ height: number; width: number }>, "custom">>; transparent: BooleanParam }>>

`Private` canvas

canvas: any

`Private` copyToClipboardTask

copyToClipboardTask: any

`Private` createParams

createParams: any

`Private` createPass

createPass: any

`Private` downloadTask

downloadTask: any

`Private` draw

draw: any

`Readonly` events

events: { previewed: Subject<any> }

Type declaration

previewed: Subject<any>

`Private` getCanvasSize

getCanvasSize: any

`Private` getSize

getSize: any

`Private` plugin

plugin: any

`Private` previewCanvas

previewCanvas: any

`Private` previewData

previewData: any

Accessors

cropParams

get cropParams(): { auto: boolean; relativePadding: number }
Returns { auto: boolean; relativePadding: number }
- auto: boolean
- relativePadding: number
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:132

`Protected` ev

get ev(): RxEventHelper
Returns RxEventHelper
Inherited from PluginComponent.ev
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:14

imagePass

get imagePass(): ImagePass
Returns ImagePass
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:143

isFullFrame

get isFullFrame(): boolean
Returns boolean
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:150

params

get params(): { axes: <internal>.Mapped<NamedParams<Normalize<unknown>, "off"> | NamedParams<Normalize<{ alpha: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; colorX: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorY: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorZ: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; ignoreLight: boolean; instanceGranularity: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; scale: number; transparentBackfaces: string; xrayShaded: boolean }>, "on">>; resolution: <internal>.Mapped<NamedParams<Normalize<{ height: number; width: number }>, "custom"> | NamedParams<Normalize<unknown>, "viewport"> | NamedParams<Normalize<unknown>, "hd"> | NamedParams<Normalize<unknown>, "full-hd"> | NamedParams<Normalize<unknown>, "ultra-hd">>; transparent: BooleanParam }
Returns { axes: <internal>.Mapped<NamedParams<Normalize<unknown>, "off"> | NamedParams<Normalize<{ alpha: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; colorX: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorY: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorZ: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; ignoreLight: boolean; instanceGranularity: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; scale: number; transparentBackfaces: string; xrayShaded: boolean }>, "on">>; resolution: <internal>.Mapped<NamedParams<Normalize<{ height: number; width: number }>, "custom"> | NamedParams<Normalize<unknown>, "viewport"> | NamedParams<Normalize<unknown>, "hd"> | NamedParams<Normalize<unknown>, "full-hd"> | NamedParams<Normalize<unknown>, "ultra-hd">>; transparent: BooleanParam }
- axes: <internal>.Mapped<NamedParams<Normalize<unknown>, "off"> | NamedParams<Normalize<{ alpha: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; colorX: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorY: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorZ: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; ignoreLight: boolean; instanceGranularity: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; scale: number; transparentBackfaces: string; xrayShaded: boolean }>, "on">>
- resolution: <internal>.Mapped<NamedParams<Normalize<{ height: number; width: number }>, "custom"> | NamedParams<Normalize<unknown>, "viewport"> | NamedParams<Normalize<unknown>, "hd"> | NamedParams<Normalize<unknown>, "full-hd"> | NamedParams<Normalize<unknown>, "ultra-hd">>
- transparent: BooleanParam
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:23

`Private` previewPass

get previewPass(): any
Returns any
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:141

relativeCrop

get relativeCrop(): <internal>.Viewport
Returns <internal>.Viewport
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:136

values

get values(): <internal>.Values<{ axes: <internal>.Mapped<NamedParams<Normalize<unknown>, "off"> | NamedParams<Normalize<{ alpha: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; colorX: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorY: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorZ: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; ignoreLight: boolean; instanceGranularity: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; scale: number; transparentBackfaces: string; xrayShaded: boolean }>, "on">>; resolution: <internal>.Mapped<NamedParams<Normalize<unknown>, "viewport"> | NamedParams<Normalize<unknown>, "hd"> | NamedParams<Normalize<unknown>, "full-hd"> | NamedParams<Normalize<unknown>, "ultra-hd"> | NamedParams<Normalize<{ height: number; width: number }>, "custom">>; transparent: BooleanParam }>
Returns <internal>.Values<{ axes: <internal>.Mapped<NamedParams<Normalize<unknown>, "off"> | NamedParams<Normalize<{ alpha: number; bumpAmplitude: number; bumpFrequency: number; clip: Normalize<{ objects: any; variant: any }>; colorX: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorY: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; colorZ: <internal>."/Users/joan/devel/rcsb-saguaro-3d/node_modules/molstar/lib/mol-util/color/index".Color; doubleSided: boolean; flatShaded: boolean; flipSided: boolean; ignoreLight: boolean; instanceGranularity: boolean; material: Normalize<{ bumpiness: number; metalness: number; roughness: number }>; quality: "auto" | "high" | "low" | "medium" | "custom" | "lower" | "highest" | "higher" | "lowest"; scale: number; transparentBackfaces: string; xrayShaded: boolean }>, "on">>; resolution: <internal>.Mapped<NamedParams<Normalize<unknown>, "viewport"> | NamedParams<Normalize<unknown>, "hd"> | NamedParams<Normalize<unknown>, "full-hd"> | NamedParams<Normalize<unknown>, "ultra-hd"> | NamedParams<Normalize<{ height: number; width: number }>, "custom">>; transparent: BooleanParam }>
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:99

Methods

autocrop

autocrop(relativePadding?: number): void
Parameters
- Optional relativePadding: number
Returns void
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:151

copyToClipboard

copyToClipboard(): undefined | Promise<void>
Returns undefined | Promise<void>
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:165

dispose

dispose(): void
Returns void
Inherited from PluginComponent.dispose
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:15

download

download(filename?: string): void
Parameters
- Optional filename: string
Returns void
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:167

getFilename

getFilename(extension?: string): string
Parameters
- Optional extension: string
Returns string
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:144

getImageDataUri

getImageDataUri(): Promise<string>
Returns Promise<string>
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:164

getPreview

getPreview(maxDim?: number): undefined | { canvas: HTMLCanvasElement; height: number; width: number }
Parameters
- Optional maxDim: number
Returns undefined | { canvas: HTMLCanvasElement; height: number; width: number }
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:152

getSizeAndViewport

getSizeAndViewport(): { height: number; viewport: <internal>.Viewport; width: number }
Returns { height: number; viewport: <internal>.Viewport; width: number }
- height: number
- viewport: <internal>.Viewport
- width: number
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:157

resetCrop

resetCrop(): void
Returns void
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:148

`Protected` subscribe

subscribe<T>(obs: Observable<T>, action: ((v: T) => void)): { unsubscribe: (() => void) }
Type Parameters
- T
Parameters
- obs: Observable<T>
- action: ((v: T) => void)
  - - (v: T): void
    - Parameters
      
      v: T
      
      Returns void
Returns { unsubscribe: (() => void) }
- unsubscribe: (() => void)
  - - (): void
    - Returns void
Inherited from PluginComponent.subscribe
- Defined in node_modules/molstar/lib/mol-plugin-state/component.d.ts:11

toggleAutocrop

toggleAutocrop(): void
Returns void
- Defined in node_modules/molstar/lib/mol-plugin/util/viewport-screenshot.d.ts:149

Class ViewportScreenshotHelper

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

plugin: PluginContext

Returns ViewportScreenshotHelper

Properties

Private _imagePass

Private _params

Private _previewPass

Readonly behaviors

Type declaration

cropParams: BehaviorSubject<{ auto: boolean; relativePadding: number }>

relativeCrop: BehaviorSubject<<internal>.Viewport>

Private canvas

Private copyToClipboardTask

Private createParams

Private createPass

Private downloadTask

Private draw

Readonly events

Type declaration

previewed: Subject<any>

Private getCanvasSize

Private getSize

Private plugin

Private previewCanvas

Private previewData

Accessors

cropParams

Returns { auto: boolean; relativePadding: number }

auto: boolean

relativePadding: number

Protected ev

Returns RxEventHelper

imagePass

Returns ImagePass

isFullFrame

Returns boolean

params

resolution: <internal>.Mapped<NamedParams<Normalize<{ height: number; width: number }>, "custom"> | NamedParams<Normalize<unknown>, "viewport"> | NamedParams<Normalize<unknown>, "hd"> | NamedParams<Normalize<unknown>, "full-hd"> | NamedParams<Normalize<unknown>, "ultra-hd">>

transparent: BooleanParam

Private previewPass

Returns any

relativeCrop

Returns <internal>.Viewport

values

Methods

autocrop

Parameters

Optional relativePadding: number

Returns void

copyToClipboard

Returns undefined | Promise<void>

dispose

Returns void

download

Parameters

Optional filename: string

Returns void

getFilename

Parameters

Optional extension: string

Returns string

getImageDataUri

Returns Promise<string>

getPreview

Parameters

Optional maxDim: number

Returns undefined | { canvas: HTMLCanvasElement; height: number; width: number }

getSizeAndViewport

Returns { height: number; viewport: <internal>.Viewport; width: number }

height: number

viewport: <internal>.Viewport

`Private` _imagePass

`Private` _params

`Private` _previewPass

`Readonly` behaviors

`Private` canvas

`Private` copyToClipboardTask

`Private` createParams

`Private` createPass

`Private` downloadTask

`Private` draw

`Readonly` events

`Private` getCanvasSize

`Private` getSize

`Private` plugin

`Private` previewCanvas

`Private` previewData

`Protected` ev

`Private` previewPass

`Optional` relativePadding: number

`Optional` filename: string

`Optional` extension: string

`Optional` maxDim: number

`Protected` subscribe