LinearComparativeView
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/linear-comparative-view/src/LinearComparativeView/model.ts
extends
LinearComparativeView - Properties
property: id
// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
id: ElementId
property: type
// type signature
ISimpleType<"LinearComparativeView">
// code
type: types.literal('LinearComparativeView')
property: trackSelectorType
// type signature
string
// code
trackSelectorType: 'hierarchical'
property: showIntraviewLinks
// type signature
true
// code
showIntraviewLinks: true
property: linkViews
// type signature
false
// code
linkViews: false
property: interactToggled
// type signature
false
// code
interactToggled: false
property: middleComparativeHeight
// type signature
number
// code
middleComparativeHeight: 100
property: tracks
// type signature
IArrayType<IAnyType>
// code
tracks: types.array(
pluginManager.pluggableMstType('track', 'stateModel'),
)
property: views
currently this is limited to an array of two
// type signature
IArrayType<IModelType<{ id: IOptionalIType<ISimpleType<string>, [undefined]>; displayName: IMaybe<ISimpleType<string>>; minimized: IType<boolean, boolean, boolean>; } & { ...; }, { ...; } & ... 15 more ... & { ...; }, ModelCreationType<...>, _NotCustomized>>
// code
views: types.array(
pluginManager.getViewType('LinearGenomeView')
.stateModel as LinearGenomeViewStateModel,
)
property: viewTrackConfigs
this represents tracks specific to this view specifically used for read vs ref dotplots where this track would not really apply elsewhere
// type signature
IArrayType<IAnyModelType>
// code
viewTrackConfigs: types.array(
pluginManager.pluggableConfigSchemaType('track'),
)
LinearComparativeView - Getters
getter: highResolutionScaling
// type
number
getter: initialized
// type
boolean
getter: refNames
// type
any[][]
getter: assemblyNames
// type
any[]
LinearComparativeView - Methods
method: headerMenuItems
includes a subset of view menu options because the full list is a little overwhelming. overridden by subclasses
// type signature
headerMenuItems: () => MenuItem[]
method: menuItems
// type signature
menuItems: () => MenuItem[]
method: rubberBandMenuItems
// type signature
rubberBandMenuItems: () => { label: string; onClick: () => void; }[]
LinearComparativeView - Actions
action: setWidth
// type signature
setWidth: (newWidth: number) => void
action: setViews
// type signature
setViews: (views: ModelCreationType<ExtractCFromProps<{ id: IOptionalIType<ISimpleType<string>, [undefined]>; displayName: IMaybe<ISimpleType<string>>; minimized: IType<boolean, boolean, boolean>; } & { ...; }>>[]) => void
action: removeView
// type signature
removeView: (view: { id: string; displayName: string; minimized: boolean; type: string; offsetPx: number; bpPerPx: number; displayedRegions: IMSTArray<IModelType<{ refName: ISimpleType<string>; start: ISimpleType<number>; end: ISimpleType<...>; reversed: IOptionalIType<...>; } & { ...; }, { ...; }, _NotCustomized, _NotCustomize...
action: closeView
removes the view itself from the state tree entirely by calling the parent removeView
// type signature
closeView: () => void
action: setMiddleComparativeHeight
// type signature
setMiddleComparativeHeight: (n: number) => number
action: toggleLinkViews
// type signature
toggleLinkViews: () => void
action: activateTrackSelector
// type signature
activateTrackSelector: () => Widget
action: toggleTrack
// type signature
toggleTrack: (trackId: string) => boolean
action: showTrack
// type signature
showTrack: (trackId: string, initialSnapshot?: {}) => void
action: hideTrack
// type signature
hideTrack: (trackId: string) => number
action: squareView
// type signature
squareView: () => void
action: clearView
// type signature
clearView: () => void