GenomeSpy Core API / ScaleResolutionApi

Interface: ScaleResolutionApi¶

A public API for ScaleResolution

Methods¶

addEventListener()¶

addEventListener(type, listener): void

Parameters¶

Returns¶

void

removeEventListener()¶

removeEventListener(type, listener): void

Parameters¶

Returns¶

void

getDomain()¶

getDomain(): any[]

Returns the current, possible zoomed domain.

Returns¶

any[]

isDomainDefinedExplicitly()¶

isDomainDefinedExplicitly(): boolean

Returns true if the domain has been provided explicitly in the spec.

Returns¶

boolean

isDomainInitialized()¶

isDomainInitialized(): boolean

Returns true when the scale domain has moved beyond the placeholder startup state.

Returns¶

boolean

Deprecated¶

This legacy heuristic does not indicate data readiness. Inspect getDomain() for the usability conditions required by your consumer.

getComplexDomain()¶

getComplexDomain(): NumericDomain | ComplexDomain

Returns the current, possible zoomed domain converted into complex objects such as genomic coordinates.

Returns¶

NumericDomain | ComplexDomain

getLinkedSelectionDomainInfo()¶

getLinkedSelectionDomainInfo(): object

Returns¶

object

param¶

param: string

encoding¶

encoding: "x" | "y"

persist¶

persist: boolean

isZoomed()¶

isZoomed(): boolean

Returns¶

boolean

isZoomable()¶

isZoomable(): boolean

Returns¶

boolean

zoomTo()¶

Call Signature¶

zoomTo(domain, options?): Promise<void>

Parameters¶

Returns¶

Promise<void>

Call Signature¶

zoomTo(domain, duration): Promise<void>

Parameters¶

Returns¶

Promise<void>

Deprecated¶

Use the options object form: zoomTo(domain, { duration }).