Skip to main content

LinearComparativeView

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

LinearComparativeView - Properties​

property: id​

// type signature
any
// code
id: ElementId

property: type​

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

property: trackSelectorType​

// type signature
string
// code
trackSelectorType: 'hierarchical'
// type signature
true
// code
showIntraviewLinks: true

property: linkViews​

// type signature
false
// code
linkViews: false

property: interactiveOverlay​

// type signature
false
// code
interactiveOverlay: false

property: showDynamicControls​

// type signature
true
// code
showDynamicControls: true

property: levels​

// type signature
IArrayType<any>
// code
levels: types.array(LinearSyntenyViewHelper!)

property: views​

currently this is limited to an array of two

// type signature
IArrayType<IModelType<ModelProperties & { id: any; type: IType<string, string, string>; offsetPx: IType<number, number, number>; bpPerPx: IType<number, number, number>; ... 13 more ...; init: IType<...>; }, { ...; } & ... 13 more ... & { ...; }, ModelCreationType<...>, ModelSnapshotType<...>>>
// 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<any>
// code
viewTrackConfigs: types.array(
          pluginManager.pluggableConfigSchemaType('track'),
        )

LinearComparativeView - Getters​

getter: initialized​

// type
boolean

getter: refNames​

// type
any[][]

getter: assemblyNames​

// type
any[]

getter: loadingMessage​

// type
string

getter: showLoading​

Whether to show a loading indicator instead of the import form or view

// type
boolean

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: setIsLoading​

// type signature
setIsLoading: (arg: boolean) => void

action: setViews​

// type signature
setViews: (views: ModelCreationType<ExtractCFromProps<ModelProperties & { id: any; type: IType<string, string, string>; offsetPx: IType<number, number, number>; bpPerPx: IType<number, number, number>; ... 13 more ...; init: IType<...>; }>>[]) => void

action: removeView​

// type signature
removeView: (view: { [x: string]: any; id: any; type: string; offsetPx: number; bpPerPx: number; displayedRegions: Region[] & IStateTreeNode<IOptionalIType<IType<Region[], Region[], Region[]>, [undefined]>>; ... 12 more ...; init: InitState & IStateTreeNode<...>; } & ... 16 more ... & IStateTreeNode<...>) => void

action: setLevelHeight​

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

action: setLinkViews​

// type signature
setLinkViews: (arg: boolean) => void

action: setShowDynamicControls​

// type signature
setShowDynamicControls: (arg: boolean) => void

action: activateTrackSelector​

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

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