Skip to content

@graphty/graphty-element / index / ScreenshotOptions

Interface: ScreenshotOptions ​

Defined in: graphty-element/src/screenshot/types.ts:33

Properties ​

camera? ​

optional camera?: CameraState | { preset: string; }

Defined in: graphty-element/src/screenshot/types.ts:65


destination? ​

optional destination?: object

Defined in: graphty-element/src/screenshot/types.ts:58

blob? ​

optional blob?: boolean

clipboard? ​

optional clipboard?: boolean

download? ​

optional download?: boolean


downloadFilename? ​

optional downloadFilename?: string

Defined in: graphty-element/src/screenshot/types.ts:63


enhanceQuality? ​

optional enhanceQuality?: boolean | QualityEnhancementOptions

Defined in: graphty-element/src/screenshot/types.ts:57

Enable quality enhancement for the screenshot. Can be a boolean (true = default settings) or an object with specific settings.

Quality enhancement uses supersampling (rendering at higher resolution then downscaling) which provides the highest quality anti-aliasing for screenshots.

Examples ​

ts
// Use default settings (2x supersampling)
enhanceQuality: true
ts
// Custom settings
enhanceQuality: {
  supersampleFactor: 4,  // 4x supersampling (very high quality, slower)
  msaaSamples: 4,        // Also add MSAA
}

format? ​

optional format?: "png" | "jpeg" | "webp"

Defined in: graphty-element/src/screenshot/types.ts:34


height? ​

optional height?: number

Defined in: graphty-element/src/screenshot/types.ts:38


multiplier? ​

optional multiplier?: number

Defined in: graphty-element/src/screenshot/types.ts:36


preset? ​

optional preset?: "print" | "web-share" | "thumbnail" | "documentation"

Defined in: graphty-element/src/screenshot/types.ts:64


quality? ​

optional quality?: number

Defined in: graphty-element/src/screenshot/types.ts:35


strictAspectRatio? ​

optional strictAspectRatio?: boolean

Defined in: graphty-element/src/screenshot/types.ts:39


timing? ​

optional timing?: object

Defined in: graphty-element/src/screenshot/types.ts:66

waitForOperations? ​

optional waitForOperations?: boolean

waitForSettle? ​

optional waitForSettle?: boolean


transparentBackground? ​

optional transparentBackground?: boolean

Defined in: graphty-element/src/screenshot/types.ts:40


width? ​

optional width?: number

Defined in: graphty-element/src/screenshot/types.ts:37