Skip to main content

LinearSyntenyDisplay

Note: this document is automatically generated from @jbrowse/mobx-state-tree objects in our source code. See Core concepts and intro to pluggable elements for more info

Also note: this document represents the state model API for the current released version of jbrowse. If you are not using the current version, please cross reference the markdown files in our repo of the checked out git tag

Source code

GitHub page

Docs

extends

LinearSyntenyDisplay - Properties

property: type

// type signature
ISimpleType<"LinearSyntenyDisplay">
// code
type: types.literal('LinearSyntenyDisplay')

property: configuration

// type signature
any
// code
configuration: ConfigurationReference(configSchema)

property: colorBy

color scheme to use for rendering synteny features

// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
colorBy: types.optional(types.string, 'default')

property: alpha

alpha transparency value for synteny drawing (0-1)

// type signature
IOptionalIType<ISimpleType<number>, [undefined]>
// code
alpha: types.optional(types.number, 0.2)

property: minAlignmentLength

minimum alignment length to display (in bp)

// type signature
IOptionalIType<ISimpleType<number>, [undefined]>
// code
minAlignmentLength: types.optional(types.number, 0)

LinearSyntenyDisplay - Getters

getter: adapterConfig

// type
any

getter: trackIds

// type
string[]

getter: numFeats

// type
number

getter: ready

used for synteny svg rendering

// type
boolean

getter: featMap

// type
any

getter: colorSchemeConfig

cached color scheme config based on colorBy

// type
{ cigarColors: { I: string; N: string; D: string; X: string; M: string; '=': string; }; }

getter: colorMapWithAlpha

cached CIGAR colors with alpha applied

// type
{ I: any; N: any; D: any; X: any; M: any; '=': any; }

getter: posColorWithAlpha

cached positive strand color with alpha

// type
any

getter: negColorWithAlpha

cached negative strand color with alpha

// type
any

getter: queryColorWithAlphaMap

cached query colors with alpha - returns a function that caches results

// type
(queryName: string) => string

getter: queryTotalLengths

cached query total lengths for minAlignmentLength filtering

// type
Map<string, number>

LinearSyntenyDisplay - Actions

action: setFeatPositions

// type signature
setFeatPositions: (arg: FeatPos[]) => void

action: setMainCanvasRef

// type signature
setMainCanvasRef: (ref: HTMLCanvasElement) => void

action: setClickMapCanvasRef

// type signature
setClickMapCanvasRef: (ref: HTMLCanvasElement) => void

action: setCigarClickMapCanvasRef

// type signature
setCigarClickMapCanvasRef: (ref: HTMLCanvasElement) => void

action: setMouseoverCanvasRef

// type signature
setMouseoverCanvasRef: (ref: HTMLCanvasElement) => void

action: setMouseoverId

// type signature
setMouseoverId: (arg?: string) => void

action: setCigarMouseoverId

// type signature
setCigarMouseoverId: (arg: number) => void

action: setClickId

// type signature
setClickId: (arg?: string) => void

action: setAlpha

// type signature
setAlpha: (value: number) => void

action: setMinAlignmentLength

// type signature
setMinAlignmentLength: (value: number) => void

action: setColorBy

// type signature
setColorBy: (value: string) => void