Class TabInputModel<T>

Model to be used in collaboration with tabInputComponent.

Type Parameters

T

Hierarchy

TabInputModel

Index

Constructors

Properties

entity selectedType value

Methods

getTabInputValue isTabInputModel isValid setTabInputValue

Constructors

constructor

new TabInputModel<T>(entity: T, selectedType: "VALUE" | "VARIABLE" | "EXPRESSION", value: ValueType): TabInputModel<T>
Initialize the object.
Type Parameters
- T
Parameters
- entity: T
- selectedType: "VALUE" | "VARIABLE" | "EXPRESSION"
- value: ValueType
Returns TabInputModel<T>
- Defined in lib/tab-input.d.ts:21

Properties

entity

entity: T

Entity is the possibly complex object that TabInput is representing

selectedType

selectedType: "VALUE" | "VARIABLE" | "EXPRESSION"

SelectedType is the type of value that the user has selected: 'Value' | 'Variable' | 'Expression'

value

value: ValueType

Value is either the "value" of the "variable" or the "expression" entered by the user

Methods

`Static` getTabInputValue

getTabInputValue<T>(model: TabInputModel<T>): TabInputValue
Returns TabInputValue from TabInputModel which is the input for the TabInput component
Type Parameters
- T
Parameters
- model: TabInputModel<T>
Returns TabInputValue
- Defined in lib/tab-input.d.ts:35

`Static` isTabInputModel

isTabInputModel<T>(value: any): value is TabInputModel<T>
Checks if tabInputModel has an entity and a selectedType
Type Parameters
- T
Parameters
- value: any
  
  to be interrogated
Returns value is TabInputModel<T>
- Defined in lib/tab-input.d.ts:31

`Static` isValid

isValid<T>(model: TabInputModel<T>): Promise<boolean>
Validates the model
Type Parameters
- T
Parameters
- model: TabInputModel<T>
  
  to validate
Returns Promise<boolean>
- Defined in lib/tab-input.d.ts:26

`Static` setTabInputValue

setTabInputValue<T>(model: TabInputModel<T>, value: TabInputValue): void
Sets TabInputValue on TabInputModel which is the input for the TabInput component
Type Parameters
- T
Parameters
- model: TabInputModel<T>
  
  to update the TabInputValue
- value: TabInputValue
  
  the inserted value for the model.
Returns void
- Defined in lib/tab-input.d.ts:41

Generated using TypeDoc