Interface Group<T>

Type Parameters

  • T

Hierarchy

Constructors

constructor

Properties

category? defaultValue description? fieldLabels? help? hideIf? isEssential? isExpanded? isFlat? isHidden? isOptional? label? legend? params pivot? presets? shortLabel? twoColumns? type

Constructors

constructor

constructor

Properties

Optional category

category?: string

defaultValue

defaultValue: T

Optional description

description?: string

Optional fieldLabels

fieldLabels?: { [name: string]: string }

Type declaration

  • [name: string]: string

Optional help

help?: ((value: any) => { description?: string; legend?: Legend })

Type declaration

    • (value: any): { description?: string; legend?: Legend }

    • Parameters

      • value: any

      Returns { description?: string; legend?: Legend }

      • Optional description?: string
      • Optional legend?: Legend

Optional hideIf

hideIf?: ((currentGroup: any) => boolean)

Type declaration

    • (currentGroup: any): boolean

    • Parameters

      • currentGroup: any

      Returns boolean

Optional isEssential

isEssential?: boolean

Optional isExpanded

isExpanded?: boolean

Optional isFlat

isFlat?: boolean

Optional isHidden

isHidden?: boolean

Optional isOptional

isOptional?: boolean

Optional label

label?: string

Optional legend

legend?: Legend

params

params: <internal>.Params

Optional pivot

pivot?: keyof T

Optional presets

presets?: readonly (readonly [T, string] | readonly [T, string, undefined | string])[]

Optional shortLabel

shortLabel?: boolean

Optional twoColumns

twoColumns?: boolean

type

type: "group"

Settings

Member Visibility

Theme

Generated using TypeDoc