Skip to main content

JobsListModel

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​

JobsListModel - Properties​

property: id​

// type signature
IOptionalIType<ISimpleType<string>, [undefined]>
// code
id: ElementId

property: type​

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

property: jobs​

// type signature
IArrayType<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { cancelCallback(): void; } & { ...; }, _NotCustomized, _NotCustomized>>
// code
jobs: types.array(Job)

property: finished​

// type signature
IArrayType<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { cancelCallback(): void; } & { ...; }, _NotCustomized, _NotCustomized>>
// code
finished: types.array(Job)

property: queued​

// type signature
IArrayType<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { cancelCallback(): void; } & { ...; }, _NotCustomized, _NotCustomized>>
// code
queued: types.array(Job)

property: aborted​

// type signature
IArrayType<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { cancelCallback(): void; } & { ...; }, _NotCustomized, _NotCustomized>>
// code
aborted: types.array(Job)

JobsListModel - Actions​

action: addJob​

// type signature
addJob: (job: NewJob) => { name: string; statusMessage: string; progressPct: number; } & NonEmptyObject & { cancelCallback(): void; } & { setCancelCallback(cancelCallback: () => void): void; setStatusMessage(message?: string): void; setProgressPct(pct: number): void; } & IStateTreeNode<...>

action: removeJob​

// type signature
removeJob: (jobName: string) => { name: string; statusMessage: string; progressPct: number; } & NonEmptyObject & { cancelCallback(): void; } & { setCancelCallback(cancelCallback: () => void): void; setStatusMessage(message?: string): void; setProgressPct(pct: number): void; } & IStateTreeNode<...>

action: addFinishedJob​

// type signature
addFinishedJob: (job: NewJob) => IMSTArray<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { ...; } & { ...; }, _NotCustomized, _NotCustomized>> & IStateTreeNode<...>

action: addQueuedJob​

// type signature
addQueuedJob: (job: NewJob) => IMSTArray<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { ...; } & { ...; }, _NotCustomized, _NotCustomized>> & IStateTreeNode<...>

action: addAbortedJob​

// type signature
addAbortedJob: (job: NewJob) => IMSTArray<IModelType<{ name: ISimpleType<string>; statusMessage: IMaybe<ISimpleType<string>>; progressPct: ISimpleType<number>; }, { ...; } & { ...; }, _NotCustomized, _NotCustomized>> & IStateTreeNode<...>

action: removeQueuedJob​

// type signature
removeQueuedJob: (jobName: string) => { name: string; statusMessage: string; progressPct: number; } & NonEmptyObject & { cancelCallback(): void; } & { setCancelCallback(cancelCallback: () => void): void; setStatusMessage(message?: string): void; setProgressPct(pct: number): void; } & IStateTreeNode<...>

action: updateJobStatusMessage​

// type signature
updateJobStatusMessage: (jobName: string, message?: string) => void

action: updateJobProgressPct​

// type signature
updateJobProgressPct: (jobName: string, pct: number) => void