Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ValueRef<T>

Type parameters

  • T = any

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

constructor

Properties

Optional category

category?: string

defaultValue

defaultValue: { ref: string; getValue: any }

Type declaration

  • ref: string
  • getValue:function
    • getValue(): T

    • Returns 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

Optional shortLabel

shortLabel?: boolean

Optional twoColumns

twoColumns?: boolean

type

type: "value-ref"

Methods

getOptions

  • getOptions(): readonly (readonly [string, string] | readonly [string, string, undefined | string])[]

  • Returns readonly (readonly [string, string] | readonly [string, string, undefined | string])[]

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

resolveRef

  • resolveRef(ref: string): T

  • Parameters

    • ref: string

    Returns T

Generated using TypeDoc