Skip to main content

SpreadsheetViewSpreadsheet

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​

SpreadsheetViewSpreadsheet - Properties​

property: rowSet​

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

property: columns​

// type signature
IType<{ name: string; }[], { name: string; }[], { name: string; }[]>
// code
columns: types.frozen<{ name: string }[]>()

property: assemblyName​

// type signature
IMaybe<ISimpleType<string>>
// code
assemblyName: types.maybe(types.string)

property: visibleColumns​

// type signature
IType<Record<string, boolean>, Record<string, boolean>, Record<string, boolean>>
// code
visibleColumns: types.frozen<Record<string, boolean>>()

SpreadsheetViewSpreadsheet - Getters​

getter: rows​

// type
{
  id: number
  feature: SimpleFeatureSerialized
}
;[]

getter: initialized​

// type
boolean

getter: dataGridColumns​

// type
({ field: string; width: number; } | { field: string; width: number; renderCell: ({ row }: GridRenderCellParams<{ id: number; feature: SimpleFeatureSerialized; }, any, any, GridTreeNodeWithRender>) => Element | "N/A"; valueGetter?: undefined; valueFormatter?: undefined; } | { ...; })[]

SpreadsheetViewSpreadsheet - Actions​

action: setVisibleRows​

// type signature
setVisibleRows: (arg?: Record<number, boolean>) => void

action: setVisibleColumns​

// type signature
setVisibleColumns: (arg: Record<string, boolean>) => void

action: setLoaded​

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