Skip to main content

SpreadsheetImportWizard

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​

SpreadsheetImportWizard - Properties​

property: fileType​

// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
fileType: types.optional(types.enumeration(fileTypes), 'VCF')

property: hasColumnNameLine​

// type signature
true
// code
hasColumnNameLine: true

property: columnNameLineNumber​

// type signature
number
// code
columnNameLineNumber: 1

property: selectedAssemblyName​

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

property: cachedFileLocation​

used specifically for UriLocation's

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

SpreadsheetImportWizard - Getters​

getter: isReadyToOpen​

// type
any

getter: fileName​

// type
any

getter: requiresUnzip​

// type
any

SpreadsheetImportWizard - Methods​

method: isValidRefName​

// type signature
isValidRefName: (refName: string, assemblyName?: string) => boolean

method: tracksForAssembly​

// type signature
tracksForAssembly: (selectedAssembly: string) => { track: { [x: string]: any; } & NonEmptyObject & { setSubschema(slotName: string, data: Record<string, unknown>): Record<string, unknown> | ({ ...; } & ... 2 more ... & IStateTreeNode<...>); } & IStateTreeNode<...>; label: string; assemblyNames: any; type: string; loc: FileLocation; }[]

SpreadsheetImportWizard - Actions​

action: setSelectedAssemblyName​

// type signature
setSelectedAssemblyName: (s: string) => void

action: setFileSource​

// type signature
setFileSource: (newSource: unknown) => void

action: setColumnNameLineNumber​

// type signature
setColumnNameLineNumber: (newnumber: number) => void

action: setFileType​

// type signature
setFileType: (typeName: string) => void

action: setError​

// type signature
setError: (error: unknown) => void

action: setLoading​

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

action: cancelButton​

// type signature
cancelButton: () => void

action: setCachedFileHandle​

// type signature
setCachedFileHandle: (arg: FileLocation) => void

action: import​

fetch and parse the file, make a new Spreadsheet model for it, then set the parent to display it

// type signature
import: (assemblyName: string) => Promise<void>