Skip to main content

ScreenSectionBase

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

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

Fields​

ScreenSectionBase.id ● String! non-null scalar​

Unique identifier for the section (required for tables)

ScreenSectionBase.type ● ScreenSectionType! non-null enum​

The type of section

ScreenSectionBase.title ● String! non-null scalar​

The title of the section

ScreenSectionBase.description ● String scalar​

Optional description of the section

ScreenSectionBase.optional ● Boolean! non-null scalar​

Whether this section is optional for the user

ScreenSectionBase.available ● Boolean! non-null scalar​

Whether the section is visible and enabled

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

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

Member Of​

ScreenDefinition object

Implemented By​

ScreenSection object ● ScreenTable object