resolveFigureExportOptions

function

Back to Helios Web API

Kind

function

Source

src/export/figureExport.js:213

Description

Normalize figure export options into concrete dimensions and capture flags.

Signature

export function resolveFigureExportOptions(options = {}, context = {}) {

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional		Requested filename, format, preset, width, height, supersampling, overlay inclusion, transparency, and legend scale.
context	Object	optional		Renderer, viewport, device pixel ratio, and capability context.

Returns

Resolved export options including logical dimensions, bitmap dimensions, crop rectangle, filename, and capability fit status.

Type Object

Notes

Callers should check fitsCapability before allocating render targets for the result.