Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Group<T>

Type parameters

  • T

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

constructor

Properties

Optional category

category?: string

defaultValue

defaultValue: T

Optional description

description?: string

Optional fieldLabels

fieldLabels?: {}

Type declaration

  • [name: string]: string

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"

Methods

Optional help

  • help(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

  • Parameters

    • currentGroup: any

    Returns boolean

Generated using TypeDoc