Skip to main content

Class: ShellHelpPanel

dg.ShellHelpPanel

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

Constructors

constructor

new ShellHelpPanel()

Accessors

syncCurrentObject

get syncCurrentObject(): boolean

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

Returns

boolean

Defined in

src/shell.ts:303

set syncCurrentObject(x): void

Parameters

NameType
xboolean

Returns

void

Defined in

src/shell.ts:304


visible

get visible(): boolean

Controls help panel visibility

Returns

boolean

Defined in

src/shell.ts:307

set visible(x): void

Parameters

NameType
xboolean

Returns

void

Defined in

src/shell.ts:308

Methods

showHelp

showHelp(x): void

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

Parameters

NameType
xany

Returns

void

Defined in

src/shell.ts:311