ShellHelpPanel

Represents help panel that shows help for the current object and is toggleable by pressing F1

Constructors

new ShellHelpPanel()

new ShellHelpPanel(): ShellHelpPanel

Returns

ShellHelpPanel

Accessors

syncCurrentObject

get syncCurrentObject(): boolean

Controls whether the help panel shows help for the current object as it changes

set syncCurrentObject(x): void

Parameters

Parameter	Type
x	boolean

Returns

boolean

Source

src/shell.ts:332

---

visible

get visible(): boolean

Controls help panel visibility

set visible(x): void

Parameters

Parameter	Type
x	boolean

Returns

boolean

Source

src/shell.ts:336

Methods

showHelp()

showHelp(x): void

Shows the content in the help window for the [x] URL or object.

Parameters

Parameter	Type
x	any

Returns

void

Source

src/shell.ts:340