Skip to main content

SharedLinearPileupDisplayMixin

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

SharedLinearPileupDisplayMixin - Properties​

property: configuration​

// type signature
any
// code
configuration: ConfigurationReference(configSchema)

property: featureHeight​

// type signature
IMaybe<ISimpleType<number>>
// code
featureHeight: types.maybe(types.number)

property: noSpacing​

// type signature
IMaybe<ISimpleType<boolean>>
// code
noSpacing: types.maybe(types.boolean)

property: fadeLikelihood​

// type signature
IMaybe<ISimpleType<boolean>>
// code
fadeLikelihood: types.maybe(types.boolean)

property: trackMaxHeight​

// type signature
IMaybe<ISimpleType<number>>
// code
trackMaxHeight: types.maybe(types.number)

property: colorBySetting​

// type signature
IType<ColorBy, ColorBy, ColorBy>
// code
colorBySetting: types.frozen<ColorBy | undefined>()

property: filterBySetting​

// type signature
IType<FilterBy, FilterBy, FilterBy>
// code
filterBySetting: types.frozen<FilterBy | undefined>()

property: jexlFilters​

// type signature
IOptionalIType<IArrayType<ISimpleType<string>>, [undefined]>
// code
jexlFilters: types.optional(types.array(types.string), [])

property: hideSmallIndelsSetting​

// type signature
IMaybe<ISimpleType<boolean>>
// code
hideSmallIndelsSetting: types.maybe(types.boolean)

property: hideMismatchesSetting​

// type signature
IMaybe<ISimpleType<boolean>>
// code
hideMismatchesSetting: types.maybe(types.boolean)

property: hideLargeIndelsSetting​

// type signature
IMaybe<ISimpleType<boolean>>
// code
hideLargeIndelsSetting: types.maybe(types.boolean)

SharedLinearPileupDisplayMixin - Getters​

getter: colorBy​

// type
any

getter: filterBy​

// type
any

getter: autorunReady​

// type
boolean

getter: hideSmallIndels​

// type
boolean

getter: hideMismatches​

// type
boolean

getter: hideLargeIndels​

// type
boolean

getter: rendererConfig​

// type
any

getter: maxHeight​

// type
any

getter: featureHeightSetting​

// type
any

getter: featureUnderMouse​

// type
any

getter: renderReady​

// type
;() => boolean

getter: filters​

// type
any

getter: rendererTypeName​

// type
string

getter: DisplayBlurb​

// type
({ model, }: { model: { sortedBy?: SortedBy; }; }) => Element

SharedLinearPileupDisplayMixin - Methods​

method: copyFeatureToClipboard​

uses copy-to-clipboard and generates notification

// type signature
copyFeatureToClipboard: (feature: Feature) => Promise<void>

method: legendItems​

Returns legend items based on current colorBy setting

// type signature
legendItems: (theme: Theme) => LegendItem[]

method: showSubMenuItems​

// type signature
showSubMenuItems: () => ({ label: string; type: "subMenu"; subMenu: { label: string; type: "radio"; checked: boolean; onClick: () => void; }[]; } | { label: string; type: string; checked: boolean; onClick: () => void; })[]

method: contextMenuItems​

// type signature
contextMenuItems: () => { label: string; icon: OverridableComponent<SvgIconTypeMap<{}, "svg">> & { muiName: string; }; onClick: () => void; }[]

method: adapterRenderProps​

// type signature
adapterRenderProps: () => any

method: renderingProps​

// type signature
renderingProps: () => { onFeatureClick(_: unknown, featureId?: string): Promise<void>; onClick(): void; onFeatureContextMenu(_: unknown, featureId?: string): Promise<void>; displayModel: { ...; } & ... 17 more ... & IStateTreeNode<...>; onMouseMove(_: unknown, featureId?: string): void; onMouseLeave(_: unknown): void; onContextMenu...

method: colorSchemeSubMenuItems​

// type signature
colorSchemeSubMenuItems: () => { label: string; onClick: () => void; }[]

method: trackMenuItems​

// type signature
trackMenuItems: () => any[]

SharedLinearPileupDisplayMixin - Actions​

action: setTagsReady​

// type signature
setTagsReady: (flag: boolean) => void

action: setMaxHeight​

// type signature
setMaxHeight: (n?: number) => void

action: setFeatureHeight​

// type signature
setFeatureHeight: (n?: number) => void

action: setNoSpacing​

// type signature
setNoSpacing: (flag?: boolean) => void

action: setColorScheme​

// type signature
setColorScheme: (colorScheme: ColorBy) => void

action: updateColorTagMap​

// type signature
updateColorTagMap: (uniqueTag: string[]) => void

action: setFeatureUnderMouse​

// type signature
setFeatureUnderMouse: (feat?: Feature) => void

action: selectFeature​

// type signature
selectFeature: (feature: Feature) => void

action: setConfig​

// type signature
setConfig: (conf: AnyConfigurationModel) => void

action: setFilterBy​

// type signature
setFilterBy: (filter: FilterBy) => void

action: setJexlFilters​

// type signature
setJexlFilters: (filters: string[]) => void

action: setHideSmallIndels​

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

action: setHideMismatches​

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

action: setHideLargeIndels​

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