buildFigureExportPresetList

function

Back to Helios Web API

Kind

function

Source

src/export/figureExport.js:335

Description

Build export preset metadata for a viewport and renderer capability.

Signature

export function buildFigureExportPresetList(windowSize = {}, capability = { maxBitmapDimension: Infinity }, supersampling = 1) {

Parameters

Name	Type	Attributes	Default	Description
windowSize	Object	optional		Current logical viewport size.
capability	Object	optional		Result of getFigureExportCapability.
supersampling	number|string	optional	1	Requested supersampling factor.

Returns

Preset records with dimensions and availability.

Type Array.<Object>