Namespace: sections

qui.sections

Source:

Classes

HideCancelled
Section

Members

(static, constant) BUTTON_TYPE_MENU_BAR

Source:

(static, constant) BUTTON_TYPE_NONE

Source:

(static, constant) BUTTON_TYPE_TOP_BAR

Source:

Methods

(static) all() → {Array.<qui.sections.Section>}

Return all registered sections, in order.

Source:
Returns:
Type
Array.<qui.sections.Section>

(static) get(id) → (nullable) {qui.sections.Section}

Lookup a section by its identifier.

Parameters:
Name Type Description
id String

the section identifier
Source:
Returns:

the section if found, otherwise null

Type
qui.sections.Section

(static) getCurrent() → (nullable) {qui.sections.Section}

Return the current section.

Source:
Returns:
Type
qui.sections.Section

(static) getHome() → (nullable) {qui.sections.Section}

Return the home section.

Source:
Returns:
Type
qui.sections.Section

(static) register(sectionClass)

Register a section class.

Parameters:
Name Type Description
sectionClass Class.<qui.sections.Section>

the section class (see qui.sections.Section)
Source:

(static) setHome(section)

Set the home section.

Parameters:
Name Type Description
section qui.sections.Section

the new home section
Source:

(static) showHome(resetopt, nullable) → {Promise}

Switch to the home section.

Parameters:
Name Type Attributes Description
reset Boolean <optional>
<nullable>

if true will reset the home section to its initial state, recreating its main page
Source:
Returns:

a promise that resolves as soon as the home section is loaded.

Type
Promise

(static) switchTo(section, sourceopt, historyEntryopt) → {Promise}

Switch to the given section, making it current.

Parameters:
Name Type Attributes Description
section qui.sections.Section

the section
source String <optional>

optional source to pass to qui.sections.Section#onShow (defaults to program)
historyEntry Boolean <optional>

whether to create a new history entry for current context before switching to the new section, or not (defaults to false)
Source:
Returns:

a promise that resolves as soon as the section is loaded.

Type
Promise

(static) unregister(sectionClass)

Unregister a section class.

Parameters:
Name Type Description
sectionClass Class.<qui.sections.Section>

the section class (see qui.sections.Section)
Source: