Class Gui

Interface graphique de basthon-console

Hierarchy (View Summary)

GUIBase
- Gui

Constructors

constructor

new Gui(container: HTMLElement, options?: ConsoleOptions): Gui
Parameters
- container: HTMLElement
- Optionaloptions: ConsoleOptions
Returns Gui
Overrides GUIBase.constructor
- Defined in src/lib/outils/basthon/Gui.ts:93

Properties

`Readonly`_withBanner

_withBanner: boolean

divEditor

divEditor: HTMLElement

divGraphics

divGraphics: HTMLElement

divShell

divShell: HTMLElement

`Static`copyToClipboard

copyToClipboard: (text: string) => void

Copy a text to clipboard.

Accessors

editor

get editor(): Editor
Editor getter.

Returns Editor
- Defined in src/lib/outils/basthon/Gui.ts:150

graphics

get graphics(): Graphics
Graphics getter.

Returns Graphics
- Defined in src/lib/outils/basthon/Gui.ts:160

kernel

get kernel(): KernelBase | undefined
Kernel getter.

Returns KernelBase | undefined
Inherited from GUIBase.kernel
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:36

kernelLoader

get kernelLoader(): KernelLoader
KernelLoader getter.

Returns KernelLoader
Inherited from GUIBase.kernelLoader
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:41

kernelSafe

get kernelSafe(): KernelBase | null
Returns KernelBase | null
Inherited from GUIBase.kernelSafe
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:37

language

get language(): string
Language getter.

Returns string
Inherited from GUIBase.language
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:32

shell

get shell(): Shell
Shell getter.

Returns Shell
- Defined in src/lib/outils/basthon/Gui.ts:155

Methods

backup

backup(approved?: boolean): Promise<string | undefined>
Backup to checkpoints.
Parameters
- Optionalapproved: boolean
Returns Promise<string | undefined>
Inherited from GUIBase.backup
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:134

confirm

confirm(
    title: string,
    message: string,
    text: string,
    callback: callbackVoid,
    textCancel: string,
    callbackCancel: callbackVoid,
): void
Ask the user to confirm or cancel.
Parameters
- title: string
- message: string
- text: string
- callback: callbackVoid
- textCancel: string
- callbackCancel: callbackVoid
Returns void
Overrides GUIBase.confirm
- Defined in src/lib/outils/basthon/Gui.ts:193

content

content(): string
Get the content (script or notebook content).

Returns string
Inherited from GUIBase.content
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:85

deflate

deflate(content: string): Promise<string>
Compress a string to another string (URL safe).
Parameters
- content: string
Returns Promise<string>
Inherited from GUIBase.deflate
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:210

download

download(filename?: string): void
Download content to file.
Parameters
- Optionalfilename: string
Returns void
Inherited from GUIBase.download
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:202

error

error(title: string, message: string): void
Notify the user with an error.
Parameters
- title: string
- message: string
Returns void
Overrides GUIBase.error
- Defined in src/lib/outils/basthon/Gui.ts:165

eval

eval(script: string): Promise<EvalResponse>
eval code and return output
Parameters
- script: string
Returns Promise<EvalResponse>
- Defined in src/lib/outils/basthon/Gui.ts:296

getContent

getContent(): string
Get editor’s content.

Returns string
- Defined in src/lib/outils/basthon/Gui.ts:140

hideConsole

hideConsole(): void
Displaying editor alone.

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:373

hideEditor

hideEditor(): void
Displaying console alone.

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:386

inflate

inflate(content: string): Promise<string>
Reverse version of deflate.
Parameters
- content: string
Returns Promise<string>
Inherited from GUIBase.inflate
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:214

info

info(title: string, message: string): void
Notify the user.
Parameters
- title: string
- message: string
Returns void
Overrides GUIBase.info
- Defined in src/lib/outils/basthon/Gui.ts:179

init

init(options?: any): Promise<void>
Initialize the GUI.
Parameters
- Optionaloptions: any
Returns Promise<void>
Inherited from GUIBase.init
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:81

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>
Inherited from GUIBase.initCaller
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:145

kernelRestart

kernelRestart(): void
Restart the kernel.

Returns void
Inherited from GUIBase.kernelRestart
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:153

lastBackupValid

lastBackupValid(): Promise<boolean | null | undefined>
Is last backup tagged as "approved"?

Returns Promise<boolean | null | undefined>
Inherited from GUIBase.lastBackupValid
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:126

loaded

loaded(): Promise<void>
Check if GUI is loaded.

Returns Promise<void>
Inherited from GUIBase.loaded
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:45

loadFromQS

loadFromQS(key: string): Promise<string | null>
Loading the content from query string (ipynb=/script= or from=).
Parameters
- key: string
Returns Promise<string | null>
Inherited from GUIBase.loadFromQS
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:93

loadFromStorage

loadFromStorage(setContent?: boolean): Promise<string | null>
Load content from local forage.
Parameters
- OptionalsetContent: boolean
Returns Promise<string | null>
Inherited from GUIBase.loadFromStorage
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:118

loadURLAux

loadURLAux(): Promise<void>
Load auxiliary files submited via URL (aux= parameter) (async).

Returns Promise<void>
Inherited from GUIBase.loadURLAux
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:165

loadURLModules

loadURLModules(): Promise<void>
Load modules submited via URL (module= parameter) (async).

Returns Promise<void>
Inherited from GUIBase.loadURLModules
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:169

notifyError

notifyError(error: Error | ErrorEvent | PromiseRejectionEvent): void
The error notification system.
Parameters
- error: Error | ErrorEvent | PromiseRejectionEvent
Returns void
Inherited from GUIBase.notifyError
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:77

open

open(file: Blob | File): Promise<void>
Opening file (async) and load its content.
Parameters
- file: Blob | File
Returns Promise<void>
Inherited from GUIBase.open
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:198

openFile

openFile(): Promise<void>
Opening file: If it has kernel extension, loading it in the editor or put on (emulated) local filesystem (user is asked to), otherwise, loading it in the local filesystem.

Returns Promise<void>
- Defined in src/lib/outils/basthon/Gui.ts:360

openModuleFile

openModuleFile(file: File): Promise<void>
Open *.py file by asking user what to do: load in editor or put on (emulated) local filesystem.
Parameters
- file: File
Returns Promise<void>
- Defined in src/lib/outils/basthon/Gui.ts:332

pageLoad

pageLoad(): Promise<void>
Wait for par load (document.body available).

Returns Promise<void>
Inherited from GUIBase.pageLoad
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:49

putFSRessource

putFSRessource(file: File): Promise<void>
Loading file in the (emulated) local filesystem (async).
Parameters
- file: File
Returns Promise<void>
Inherited from GUIBase.putFSRessource
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:161

registerExtension

registerExtension(name: string, callback: () => Promise<void>): void
Register an extension and its callback.
Parameters
- name: string
- callback: () => Promise<void>
Returns void
Inherited from GUIBase.registerExtension
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:173

restart

restart(): void
RAZ function.

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:322

runScript

runScript(): void
Run the editor script in the shell.

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:283

select

select(
    title: string,
    message: string,
    choices: { handler: callbackVoid; text: string }[],
    textCancel: string,
    callbackCancel: callbackVoid,
): void
Ask the user to select a choice.
Parameters
- title: string
- message: string
- choices: { handler: callbackVoid; text: string }[]
- textCancel: string
- callbackCancel: callbackVoid
Returns void
Overrides GUIBase.select
- Defined in src/lib/outils/basthon/Gui.ts:215

selectCheckpoint

selectCheckpoint(): Promise<string | null>
Select a checkpoint to load in the script.

Returns Promise<string | null>
Inherited from GUIBase.selectCheckpoint
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:130

setCheckpointsManager

setCheckpointsManager(checkpoints: CheckpointsManager<string>): void
Set the checkpoints manager (typically use with GUIOptions.noCheckpointsInit set to true).
Parameters
- checkpoints: CheckpointsManager<string>
Returns void
Inherited from GUIBase.setCheckpointsManager
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:54

setContent

setContent(content: string): void
Set editor’s content.
Parameters
- content: string
Returns void
Overrides GUIBase.setContent
- Defined in src/lib/outils/basthon/Gui.ts:145

setDarkMode

setDarkMode(): void
Set dark mode (pour toutes les consoles basthon du dom)

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:417

setHeight

setHeight(height: number): void
Modifie la hauteur éditeur/console
Parameters
- height: number
  Hauteur voulue (en % du viewport)
Returns void
- Defined in src/lib/outils/basthon/Gui.ts:466

setLigthMode

setLigthMode(): void
Set light mode (pour toutes les consoles basthon du dom)

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:429

sharingURL

sharingURL(key: string): Promise<string>
Returning the sharing link for the content.
Parameters
- key: string
Returns Promise<string>
Inherited from GUIBase.sharingURL
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:190

showEditorConsole

showEditorConsole(): void
Editor and console side by side.

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:398

showGraph

showGraph(): void
Toggle hide/show shell/graph.

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:457

showShell

showShell(): void
Toggle hide/show shell/graph.

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:449

theme

theme(): Promise<"light" | "dark" | undefined>
Get mode as a string (dark/light).

Returns Promise<"light" | "dark" | undefined>
Inherited from GUIBase.theme
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:149

toggleMode

toggleMode(): void
Toggle light / dark mode

Returns void
- Defined in src/lib/outils/basthon/Gui.ts:440

validateBackup

validateBackup(): Promise<void>
Tag last backup as "approved".

Returns Promise<void>
Inherited from GUIBase.validateBackup
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:122

`Static`openURL

openURL(url: string, download?: string): void
Open an URL in a new tab or download a file.
Parameters
- url: string
- Optionaldownload: string
Returns void
Inherited from GUIBase.openURL
- Defined in node_modules/.pnpm/@basthon+gui-base@0.50.16/node_modules/@basthon/gui-base/lib/main.d.ts:186

Class Gui

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Gui

Properties

Readonly_withBanner

divEditor

divGraphics

divShell

StaticcopyToClipboard

Accessors

editor

Returns Editor

graphics

Returns Graphics

kernel

Returns KernelBase | undefined

kernelLoader

Returns KernelLoader

kernelSafe

Returns KernelBase | null

language

Returns string

shell

Returns Shell

Methods

backup

Parameters

Returns Promise<string | undefined>

confirm

Parameters

Returns void

content

Returns string

deflate

Parameters

Returns Promise<string>

download

Parameters

Returns void

error

Parameters

Returns void

eval

Parameters

Returns Promise<EvalResponse>

getContent

Returns string

hideConsole

Returns void

hideEditor

Returns void

inflate

Parameters

Returns Promise<string>

info

Parameters

Returns void

init

Parameters

Returns Promise<void>

initCaller

Parameters

Returns Promise<any>

kernelRestart

Returns void

lastBackupValid

Returns Promise<boolean | null | undefined>

loaded

Returns Promise<void>

loadFromQS

Parameters

Returns Promise<string | null>

`Readonly`_withBanner

`Static`copyToClipboard

`Static`openURL