Skip to main content

SpreadsheetView

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​

SpreadsheetView - Properties​

property: type​

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

property: offsetPx​

// type signature
number
// code
offsetPx: 0

property: height​

// type signature
IOptionalIType<ISimpleType<number>, [undefined]>
// code
height: types.optional(types.number, defaultHeight)

property: hideVerticalResizeHandle​

// type signature
false
// code
hideVerticalResizeHandle: false

property: hideFilterControls​

// type signature
false
// code
hideFilterControls: false

property: importWizard​

// type signature
IOptionalIType<IModelType<{ fileType: IOptionalIType<ISimpleType<string>, [undefined]>; hasColumnNameLine: IType<boolean, boolean, boolean>; columnNameLineNumber: IType<...>; selectedAssemblyName: IMaybe<...>; cachedFileLocation: IType<...>; }, { ...; } & ... 3 more ... & { ...; }, _NotCustomized, _NotCustomized>, [...
// code
importWizard: types.optional(ImportWizardModel, () =>
            ImportWizardModel.create(),
          )

property: spreadsheet​

// type signature
IMaybe<IModelType<{ rowSet: IType<RowSet, RowSet, RowSet>; columns: IType<{ name: string; }[], { name: string; }[], { name: string; }[]>; assemblyName: IMaybe<ISimpleType<string>>; visibleColumns: IType<...>; }, { ...; } & ... 3 more ... & { ...; }, ModelCreationType<...>, _NotCustomized>>
// code
spreadsheet: types.maybe(Spreadsheet())

SpreadsheetView - Getters​

getter: assembly​

// type
any

SpreadsheetView - Methods​

method: menuItems​

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

SpreadsheetView - Actions​

action: setRowMenuItems​

// type signature
setRowMenuItems: (newItems: MenuItem[]) => void

action: setWidth​

// type signature
setWidth: (newWidth: number) => number

action: setHeight​

// type signature
setHeight: (newHeight: number) => number

action: resizeHeight​

// type signature
resizeHeight: (distance: number) => number

action: resizeWidth​

// type signature
resizeWidth: (distance: number) => number

action: displaySpreadsheet​

load a new spreadsheet and set our mode to display it

// type signature
displaySpreadsheet: (spreadsheet?: { rowSet: RowSet & IStateTreeNode<IType<RowSet, RowSet, RowSet>>; columns: { name: string; }[] & IStateTreeNode<IType<{ name: string; }[], { ...; }[], { ...; }[]>>; assemblyName: string; visibleColumns: Record<...> & IStateTreeNode<...>; } & ... 6 more ... & IStateTreeNode<...>) => void