XNAT Documentation

panel

Description

Creates a generic panel container element. This element is a container that other Spawner elements are spawned into.

Spawner Widget Name

kind: panel

JavaScript Method

XNAT.ui.panel.init()

Configuration Options

customPanel:
    kind: panel
    [name]: customPanel
    label: Admin Information
    [id]: custom-panel
    [header]: false
    [footer]: false
    contents:
        ${infoElement}

Properties

Name

Value

Description

kind

panel

Spawner widget type - creates a panel element with necessary child elements for proper style and layout.

name

(string)

Arbitrary, but meaningful, name for this form panel. Will use the element config's own property name if omitted.

label

(string)

Form header text.

id

(string)

Value for spawned element's id attribute.

header

(boolean)

Set to false to suppress rendering of the panel header

footer

(boolean)

Set to false to suppress rendering of the panel footer (including submit and reset buttons on form panels).

contents

Spawner object(s)

One or more Spawner element config objects that will be inside this parent element.