GenomeSpy Core API / EmbedResult

Interface: EmbedResult¶

An API for controlling the embedded GenomeSpy instance.

Properties¶

views¶

views: ViewApi

Inspects and controls the live view hierarchy.

datasets¶

readonly datasets: DatasetApi

Updates datasets declared by the top-level input specification.

The dataset must be declared in that specification's datasets property.

This namespace is unaffected by implicit layout wrappers and does not search nested views.

events¶

readonly events: EmbedEventApi

Synchronous native input subscriptions for the embedded canvas.

params¶

readonly params: ParamNamespace

Parameters and selections resolved from the authored top-level scope.

imageExport¶

readonly imageExport: ImageExportApi

Exports the current visualization as raster or vector images.

debug¶

debug: EmbedDebugApi

Developer-only hooks for optional runtime inspection tools.

finalize¶

finalize: () => void

Releases all resources and unregisters event listeners, etc.

Returns¶

void

addEventListener¶

addEventListener: (type, listener) => void

Parameters¶

Returns¶

void

Deprecated¶

Use EmbedResult.events.subscribe() and its returned cleanup function.

Adds an event listener, which is called when the user interacts with a mark instance. Currently, only "click" events are supported. The callback receives an event object as its first (and only) parameter. Its datum property contains the datum that the user interacted with.

removeEventListener¶

removeEventListener: (type, listener) => void

Parameters¶

Returns¶

void

Deprecated¶

Use the cleanup function returned by EmbedResult.events.subscribe().

Removes a registered event listener.

getScaleResolutionByName¶

getScaleResolutionByName: (name) => ScaleResolutionApi

Returns a named ScaleResolution object that allows for attaching event listeners and controlling the scale domain. Returns undefined when the name is not registered.

Parameters¶

Returns¶

ScaleResolutionApi

getParam¶

getParam: <T>(name) => ParamApi<T>

Returns a handle for reading, writing, and subscribing to a named parameter.

Parameters are addressed by name only. If the name resolves to multiple independent parameters, this method throws an ambiguity error. Parameters declared with push: "outer" are treated as aliases of the outer parameter they write to.

Type Parameters¶

Parameters¶

Returns¶

ParamApi<T>

awaitVisibleLazyData¶

awaitVisibleLazyData: (signal?) => Promise<void>

Waits until lazy data sources have loaded data for the current visible positional domain.

Parameters¶

Returns¶

Promise<void>

updateNamedData¶

updateNamedData: (name, data?) => void

Updates a named dataset

Parameters¶

Returns¶

void

Deprecated¶

Use EmbedResult.datasets for a top-level declaration or ViewHandle.datasets for a nested declaration.

getRenderedBounds¶

getRenderedBounds: () => object

Returns the bounds reached by the last rendered layout in CSS pixels.

Returns¶

object

width¶

width: number

height¶

height: number

getLogicalCanvasSize¶

getLogicalCanvasSize: () => object

Returns the current logical canvas size in CSS pixels.

Returns¶

object

width¶

width: number

height¶

height: number

exportCanvas¶

exportCanvas: (logicalWidth?, logicalHeight?, devicePixelRatio?, clearColor?) => string

Returns a PNG data URL of the current canvas.

Parameters¶

Returns¶

string

A PNG data URL

Deprecated¶

Use imageExport.raster() instead.