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

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

Links

Source code

GitHub page

Docs

extends

• BaseViewModel

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: interactToggled

// type signature
false
// code
interactToggled: false

property: levels

// type signature
IArrayType<IModelType<{ id: IOptionalIType<ISimpleType<string>, [undefined]>; type: IType<string, string, string>; tracks: IArrayType<IAnyType>; height: IType<...>; level: ISimpleType<...>; }, { ...; } & { ...; }, _NotCustomized, _NotCustomized>>
// code
levels: types.array(LinearSyntenyViewHelper)

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: 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: Region[] & IStateTreeNode<IOptionalIType<IType<Region[], Region[], Region[]>, [...]>>; ... 11 more ...; showTrackOutlines: boolean; } & ... 18 more ... & IStateTreeNode<...>) => void

action: setLevelHeight

// type signature
setLevelHeight: (newHeight: number, level?: number) => number

action: activateTrackSelector

// type signature
activateTrackSelector: (level: number) => Widget

action: toggleTrack

// type signature
toggleTrack: (trackId: string, level?: number) => void

action: showTrack

// type signature
showTrack: (trackId: string, level?: number, initialSnapshot?: {}) => void

action: hideTrack

// type signature
hideTrack: (trackId: string, level?: number) => void

action: squareView

// type signature
squareView: () => void

action: clearView

// type signature
clearView: () => void