Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Conditioned<T, P, C>

Type parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

constructor

Properties

Optional category

category?: string

conditionParams

conditionParams: C

defaultValue

defaultValue: T

Optional description

description?: string

Optional fieldLabels

fieldLabels?: {}

Type declaration

  • [name: string]: string

Optional isEssential

isEssential?: boolean

Optional isHidden

isHidden?: boolean

Optional isOptional

isOptional?: boolean

Optional label

label?: string

Optional legend

legend?: Legend

select

select: <internal>.Select<string>

Optional shortLabel

shortLabel?: boolean

Optional twoColumns

twoColumns?: boolean

type

type: "conditioned"

Methods

conditionForValue

  • conditionForValue(v: T): keyof C

  • Parameters

    • v: T

    Returns keyof C

conditionedValue

  • conditionedValue(v: T, condition: keyof C): T

  • Parameters

    • v: T
    • condition: keyof C

    Returns T

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