Skip to main content

ScreenSection

A section in a screen form. Can be a regular section or a table section.

type ScreenSection implements ScreenSectionBase {
  id: String!
  type: ScreenSectionType!
  title: String!
  description: String
  optional: Boolean!
  available: Boolean!
  fields: [ScreenField!]!
}

Fields​

ScreenSection.id ● String! non-null scalar​

Unique identifier for the section (required for tables)

ScreenSection.type ● ScreenSectionType! non-null enum​

The type of section

ScreenSection.title ● String! non-null scalar​

The title of the section

ScreenSection.description ● String scalar​

Optional description of the section

ScreenSection.optional ● Boolean! non-null scalar​

Whether this section is optional for the user

ScreenSection.available ● Boolean! non-null scalar​

Whether the section is visible and enabled

ScreenSection.fields ● [ScreenField!]! non-null interface​

The fields contained in the section (or fields of a table row if type is table)

Interfaces​

ScreenSectionBase interface​

A section in a screen form. Can be a regular section or a table section.

Member Of​

InternalTypeRegistry object