LinearReadArcsDisplay
Note: this document is automatically generated from mobx-state-tree objects in our source code. See Core concepts and intro to pluggable elements for more info
Source file
plugins/alignments/src/LinearReadArcsDisplay/model.ts
the arc display is a non-block-based track, so draws to a single canvas and can connect multiple regions extends
LinearReadArcsDisplay - Properties
property: type
// type signature
ISimpleType<"LinearReadArcsDisplay">
// code
type: types.literal('LinearReadArcsDisplay')
property: configuration
// type signature
AnyConfigurationSchemaType
// code
configuration: ConfigurationReference(configSchema)
property: filterBy
// type signature
IOptionalIType<IModelType<{ flagInclude: IOptionalIType<ISimpleType<number>, [undefined]>; flagExclude: IOptionalIType<ISimpleType<number>, [undefined]>; readName: IMaybe<...>; tagFilter: IMaybe<...>; }, {}, _NotCustomized, _NotCustomized>, [...]>
// code
filterBy: types.optional(FilterModel, {})
property: lineWidth
// type signature
IMaybe<ISimpleType<number>>
// code
lineWidth: types.maybe(types.number)
property: jitter
// type signature
IMaybe<ISimpleType<number>>
// code
jitter: types.maybe(types.number)
property: colorBy
// type signature
IMaybe<IModelType<{ type: ISimpleType<string>; tag: IMaybe<ISimpleType<string>>; extra: IType<any, any, any>; }, {}, _NotCustomized, _NotCustomized>>
// code
colorBy: types.maybe(
types.model({
type: types.string,
tag: types.maybe(types.string),
extra: types.frozen(),
}),
)
property: drawInter
// type signature
true
// code
drawInter: true
property: drawLongRange
// type signature
true
// code
drawLongRange: true
LinearReadArcsDisplay - Getters
getter: drawn
// type
boolean
getter: lineWidthSetting
// type
any
getter: jitterVal
// type
number
LinearReadArcsDisplay - Methods
method: renderProps
only used to tell system it's ready for export
// type signature
renderProps: () => any
method: trackMenuItems
// type signature
trackMenuItems: () => (MenuDivider | MenuSubHeader | NormalMenuItem | CheckboxMenuItem | RadioMenuItem | SubMenuItem | { ...; } | { ...; })[]
method: renderSvg
// type signature
renderSvg: (opts: { rasterizeLayers?: boolean; }) => Promise<React.ReactNode>
LinearReadArcsDisplay - Actions
action: setLastDrawnOffsetPx
// type signature
setLastDrawnOffsetPx: (n: number) => void
action: setLastDrawnBpPerPx
// type signature
setLastDrawnBpPerPx: (n: number) => void
action: setLoading
// type signature
setLoading: (f: boolean) => void
action: reload
// type signature
reload: () => void
action: setRef
internal, a reference to a HTMLCanvas because we use a autorun to draw the canvas
// type signature
setRef: (ref: HTMLCanvasElement) => void
action: setColorScheme
// type signature
setColorScheme: (s: { type: string; }) => void
action: setChainData
// type signature
setChainData: (args: ChainData) => void
action: setDrawInter
// type signature
setDrawInter: (f: boolean) => void
action: setDrawLongRange
// type signature
setDrawLongRange: (f: boolean) => void
action: setFilterBy
// type signature
setFilterBy: (filter: IFilter) => void
action: setLineWidth
thin, bold, extrabold, etc
// type signature
setLineWidth: (n: number) => void
action: setJitter
jitter val, helpful to jitter the x direction so you see better evidence when e.g. 100 long reads map to same x position
// type signature
setJitter: (n: number) => void