Skip to main content

BreakpointSplitView

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

Source code

GitHub page

Docs​

extends

BreakpointSplitView - Properties​

property: type​

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

property: height​

// type signature
IOptionalIType<ISimpleType<number>, [undefined]>
// code
height: types.optional(
          types.refinement(
            'viewHeight',
            types.number,
            (n: number) => n >= minHeight,
          ),
          defaultHeight,
        )

property: trackSelectorType​

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

property: linkViews​

// type signature
false
// code
linkViews: false

property: interactToggled​

// type signature
false
// code
interactToggled: false

property: views​

// 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,
        )

BreakpointSplitView - Getters​

getter: matchedTracks​

Find all track ids that match across multiple views, or return just the single view's track if only a single row is used

// type
(IMSTArray<IAnyType> & IStateTreeNode<IArrayType<IAnyType>>) | { configuration: { trackId: string; }; }[]

BreakpointSplitView - Methods​

method: exportSvg​

creates an svg export and save using FileSaver

// type signature
exportSvg: (opts?: ExportSvgOptions) => Promise<void>

method: getMatchedTracks​

Get tracks with a given trackId across multiple views

// type signature
getMatchedTracks: (trackConfigId: string) => any[]

method: hasTranslocations​

Translocation features are handled differently since they do not have a mate e.g. they are one sided

// type signature
hasTranslocations: (trackConfigId: string) => any

method: hasPairedFeatures​

Paired features similar to breakends, but simpler, like BEDPE

// type signature
hasPairedFeatures: (trackConfigId: string) => any

method: getTrackFeatures​

Get a composite map of featureId->feature map for a track across multiple views

// type signature
getTrackFeatures: (trackConfigId: string) => Map<string, Feature>

method: getMatchedFeaturesInLayout​

// type signature
getMatchedFeaturesInLayout: (trackConfigId: string, features: Feature[][]) => { feature: Feature; layout: LayoutRecord; level: any; clipPos: number; }[][]

method: menuItems​

// type signature
menuItems: () => ({ label: string; subMenu: MenuItem[]; } | { label: string; onClick: () => void; type?: undefined; checked?: undefined; icon?: undefined; } | { label: string; type: string; checked: boolean; onClick: () => void; icon?: undefined; } | { ...; } | { ...; })[]

BreakpointSplitView - Actions​

action: setWidth​

// type signature
setWidth: (newWidth: number) => 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: toggleInteract​

// type signature
toggleInteract: () => void
// type signature
toggleIntraviewLinks: () => void

action: toggleLinkViews​

// type signature
toggleLinkViews: () => void

action: setMatchedTrackFeatures​

// type signature
setMatchedTrackFeatures: (obj: Record<string, Feature[][]>) => void

action: reverseViewOrder​

// type signature
reverseViewOrder: () => void