Class GUIBase

constructor

• new GUIBase(options: GUIOptions): GUIBase

  Parameters

  • options: GUIOptions

  Returns GUIBase

StaticcopyToClipboard

kernel

• get kernel(): KernelBase | undefined

  Kernel getter.

  Returns KernelBase | undefined

kernelLoader

• get kernelLoader(): KernelLoader

  KernelLoader getter.

  Returns KernelLoader

kernelSafe

• get kernelSafe(): KernelBase | null

  Returns KernelBase | null

language

• get language(): string

  Language getter.

  Returns string

backup

• backup(approved?: boolean): Promise<string | undefined>

  Backup to checkpoints.

  Parameters

  • Optionalapproved: boolean

  Returns Promise<string | undefined>

confirm

• confirm(
      title: string,
      message: string,
      text: string,
      callback: () => void,
      textCancel: string,
      callbackCancel: () => void,
  ): void

  Ask the user to confirm or cancel.

  Parameters

  • title: string
  • message: string
  • text: string
  • callback: () => void
  • textCancel: string
  • callbackCancel: () => void

  Returns void

content

• content(): string

  Get the content (script or notebook content).

  Returns string

deflate

• deflate(content: string): Promise<string>

  Compress a string to another string (URL safe).

  Parameters

  • content: string

  Returns Promise<string>

download

• download(filename?: string): void

  Download content to file.

  Parameters

  • Optionalfilename: string

  Returns void

error

• error(title: string, message: string): void

  Notify the user with an error.

  Parameters

  • title: string
  • message: string

  Returns void

inflate

• inflate(content: string): Promise<string>

  Reverse version of deflate.

  Parameters

  • content: string

  Returns Promise<string>

info

• info(title: string, message: string): void

  Notify the user.

  Parameters

  • title: string
  • message: string

  Returns void

init

• init(options?: any): Promise<void>

  Initialize the GUI.

  Parameters

  • Optionaloptions: any

  Returns Promise<void>

initCaller

• initCaller(
      func: () => Promise<any>,
      message: string,
      catchError: boolean,
  ): Promise<any>

  Change loader text and call init function. If catchError is false, in case of error, we continue the init process, trying to do our best...

  Parameters

  • func: () => Promise<any>
  • message: string
  • catchError: boolean

  Returns Promise<any>

kernelRestart

• kernelRestart(): void

  Restart the kernel.

  Returns void

lastBackupValid

• lastBackupValid(): Promise<boolean | null | undefined>

  Is last backup tagged as "approved"?

  Returns Promise<boolean | null | undefined>

loaded

• loaded(): Promise<void>

  Check if GUI is loaded.

  Returns Promise<void>

loadFromQS

• loadFromQS(key: string): Promise<string | null>

  Loading the content from query string (ipynb=/script= or from=).

  Parameters

  • key: string

  Returns Promise<string | null>

loadFromStorage

• loadFromStorage(setContent?: boolean): Promise<string | null>

  Load content from local forage.

  Parameters

  • OptionalsetContent: boolean

  Returns Promise<string | null>

loadURLAux

• loadURLAux(): Promise<void>

  Load auxiliary files submited via URL (aux= parameter) (async).

  Returns Promise<void>

loadURLModules

• loadURLModules(): Promise<void>

  Load modules submited via URL (module= parameter) (async).

  Returns Promise<void>

notifyError

• notifyError(error: Error | ErrorEvent | PromiseRejectionEvent): void

  The error notification system.

  Parameters

  • error: Error | ErrorEvent | PromiseRejectionEvent

  Returns void

open

• open(file: Blob | File): Promise<void>

  Opening file (async) and load its content.

  Parameters

  • file: Blob | File

  Returns Promise<void>

pageLoad

• pageLoad(): Promise<void>

  Wait for par load (document.body available).

  Returns Promise<void>

putFSRessource

• putFSRessource(file: File): Promise<void>

  Loading file in the (emulated) local filesystem (async).

  Parameters

  • file: File

  Returns Promise<void>

registerExtension

• registerExtension(name: string, callback: () => Promise<void>): void

  Register an extension and its callback.

  Parameters

  • name: string
  • callback: () => Promise<void>

  Returns void

select

• select(
      title: string,
      message: string,
      choices: { handler: () => void; text: string }[],
      textCancel: string,
      callbackCancel: () => void,
  ): void

  Ask the user to select a choice.

  Parameters

  • title: string
  • message: string
  • choices: { handler: () => void; text: string }[]
  • textCancel: string
  • callbackCancel: () => void

  Returns void

selectCheckpoint

• selectCheckpoint(): Promise<string | null>

  Select a checkpoint to load in the script.

  Returns Promise<string | null>

setCheckpointsManager

• setCheckpointsManager(checkpoints: CheckpointsManager<string>): void

  Set the checkpoints manager (typically use with GUIOptions.noCheckpointsInit set to true).

  Parameters

  • checkpoints: CheckpointsManager<string>

  Returns void

setContent

• setContent(content: string): void

  Set the content (script or notebook content).

  Parameters

  • content: string

  Returns void

sharingURL

• sharingURL(key: string): Promise<string>

  Returning the sharing link for the content.

  Parameters

  • key: string

  Returns Promise<string>

theme

• theme(): Promise<"light" | "dark" | undefined>

  Get mode as a string (dark/light).

  Returns Promise<"light" | "dark" | undefined>

validateBackup

• validateBackup(): Promise<void>

  Tag last backup as "approved".

  Returns Promise<void>

StaticopenURL

• openURL(url: string, download?: string): void

  Open an URL in a new tab or download a file.

  Parameters

  • url: string
  • Optionaldownload: string

  Returns void