Class FieldPanel

Hierarchy (View Summary)

Panel
- FieldPanel

Index

Constructors

Properties

fieldName prefix type widget

Methods

getBoundWidget getErrorMessage getPanelByName setErrorMessage

Constructors

constructor

new FieldPanel(
opts: { fieldName: string; prefix: string; type: string; widget: any },
): FieldPanel
Parameters
- opts: { fieldName: string; prefix: string; type: string; widget: any }
Returns FieldPanel
Overrides Panel.constructor
- Defined in components/Panel/index.ts:51

Properties

fieldName

fieldName: string

Name of the field this panel is associated with

prefix

prefix: string

Prefix for the panel's HTML elements (e.g., field-)

type

type: string

Type of the panel; will generally match the Python-side panel class name (e.g., FieldPanel, PanelGroup)

widget: any

Widget class used for rendering the field

Methods

getBoundWidget

getBoundWidget(): any
Returns any
- Defined in components/Panel/index.ts:62

getErrorMessage

getErrorMessage(): string | undefined
Returns string | undefined
- Defined in components/Panel/index.ts:83

getPanelByName

getPanelByName(name: string): Panel | null
Return any descendant panel (including self) that matches the given field or relation name, or null if there is no match
Parameters
- name: string
Returns Panel | null
Overrides Panel.getPanelByName
- Defined in components/Panel/index.ts:78

setErrorMessage

setErrorMessage(message: string | null): void
Parameters
- message: string | null
Returns void
- Defined in components/Panel/index.ts:88