Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Converted<T, C>

Type parameters

  • T

  • C

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

constructor

Properties

Optional category

category?: string

converted

converted: <internal>.Any

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

Optional shortLabel

shortLabel?: boolean

Optional twoColumns

twoColumns?: boolean

type

type: "converted"

Methods

fromValue

  • fromValue(v: T): C

  • converts from prop value to display value

    Parameters

    • v: T

    Returns C

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

toValue

  • toValue(v: C): T

  • converts from display value to prop value

    Parameters

    • v: C

    Returns T

Generated using TypeDoc