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
AnyConfigurationSchemaType
// 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')

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
{ [k: string]: FeatPos; }

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