Skip to content

GenomeSpy Core API / ImageExportApi

Interface: ImageExportApi

Exports the current visualization as raster or vector images.

Properties

raster

raster: (options?) => Promise<RasterExportResult>

Exports a raster image through an available rendering backend. PNG is currently the only supported format. Rejects if rasterization is unavailable.

Parameters

Parameter Type
options? RasterExportOptions

Returns

Promise<RasterExportResult>


svg

svg: (options?) => Promise<SvgExportResult>

Exports editable SVG arranged according to the view hierarchy.

Parameters

Parameter Type
options? SvgExportOptions

Returns

Promise<SvgExportResult>


analyzeSvg

analyzeSvg: (options?) => Promise<SvgExportAnalysis>

Counts visible SVG mark instances without creating an image.

Parameters

Parameter Type
options? SvgExportAnalysisOptions

Returns

Promise<SvgExportAnalysis>