Class ArrayField<M, N>

Public

Type Parameters

M
N extends void | null = void

Hierarchy (view full)

AbstractField<N extends void
? OptionValueType<M>[]
: OptionValueType<M>[] | null, IArrayFieldMainDescriptorConfig<M>>
- ArrayField

Constructors

constructor

new ArrayField<M, N>(value, onChangeDirty?, descriptorConfig?, onValidation?): ArrayField<M, N>
Type Parameters
- M
- N extends null | void = void
Parameters
- value: N extends void
  ? OptionValueType<M>[]
  : null | OptionValueType<M>[]
- OptionalonChangeDirty: (() => void)
  - - (): void
    - Returns void
- OptionaldescriptorConfig: IArrayFieldMainDescriptorConfig<M, void>
- OptionalonValidation: ((validationResult: string[]) => void)
  - - (validationResult): void
    - Parameters
      validationResult: string[]
      Returns void
Returns ArrayField<M, N>
Inherited from AbstractField.constructor
- Defined in app-sdk/index.d.ts:230

Properties

`Protected`allowNull

allowNull: boolean

`Protected`descriptorConfig

descriptorConfig: undefined | IArrayFieldMainDescriptorConfig<M, void>

`Protected`dirty

dirty: boolean

`Protected`observabilitySet

observabilitySet: Set<ReactiveProp>

`Protected`originalValue

originalValue: N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]

persist

persist: boolean

validationResult

validationResult: string[]

`Protected`value

value: IObservableValue<N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]>

Accessors

isPrimaryKey

get isPrimaryKey(): boolean
Returns boolean
Inherited from AbstractField.isPrimaryKey
- Defined in app-sdk/index.d.ts:264

options

get options(): {
title: string;
value: OptionValueType<M>;
}[]
Returns {
title: string;
value: OptionValueType<M>;
}[]
- Defined in app-sdk/index.d.ts:1313

Methods

addValidator

addValidator(validator): void
Parameters
- validator: IFieldValidator<AbstractModel<any>>
Returns void
Inherited from AbstractField.addValidator
- Defined in app-sdk/index.d.ts:249

bind

bind(field): void
Parameters
- field: AbstractField<N extends void
  ? OptionValueType<M>[]
  : null | OptionValueType<M>[], BaseOptions>
Returns void
Inherited from AbstractField.bind
- Defined in app-sdk/index.d.ts:261

`Protected`castValue

castValue(value): any
Parameters
- value: any
Returns any
Overrides AbstractField.castValue
- Defined in app-sdk/index.d.ts:1322

clearValidationResult

clearValidationResult(): void
Returns void
Inherited from AbstractField.clearValidationResult
- Defined in app-sdk/index.d.ts:248

commit

commit(): void
Returns void
Overrides AbstractField.commit
- Defined in app-sdk/index.d.ts:1328

compare

compare(a, b): number
Function for comparing elements of type T
Parameters
- a: N extends void
  ? OptionValueType<M>[]
  : null | OptionValueType<M>[]
- b: N extends void
  ? OptionValueType<M>[]
  : null | OptionValueType<M>[]
Returns number
Inherited from AbstractField.compare
- Defined in app-sdk/index.d.ts:254

getDirty

getDirty(): boolean
Returns boolean
Inherited from AbstractField.getDirty
- Defined in app-sdk/index.d.ts:258

getErrorMessage

getErrorMessage(): string
Returns string
Inherited from AbstractField.getErrorMessage
- Defined in app-sdk/index.d.ts:262

getLabel

getLabel(): string
Returns string
Inherited from AbstractField.getLabel
- Defined in app-sdk/index.d.ts:263

getOriginalValue

getOriginalValue(): N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]
Returns N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]
Inherited from AbstractField.getOriginalValue
- Defined in app-sdk/index.d.ts:238

getValidationResult

getValidationResult(): string[]
Returns string[]
Inherited from AbstractField.getValidationResult
- Defined in app-sdk/index.d.ts:260

getValidators

getValidators(): IFieldValidator<AbstractModel<any>>[]
Returns IFieldValidator<AbstractModel<any>>[]
Inherited from AbstractField.getValidators
- Defined in app-sdk/index.d.ts:250

getValue

getValue(): N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]
Returns N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]
Inherited from AbstractField.getValue
- Defined in app-sdk/index.d.ts:237

hasIntersection

hasIntersection(arr): boolean
Check, that there is intersection of this value and incoming array
Parameters
- arr: null | OptionValueType<M>[]
Returns boolean
- Defined in app-sdk/index.d.ts:1327

hasValidator

hasValidator(validator): boolean
Parameters
- validator: ClassCtor<IFieldValidator<AbstractModel<any>>, any[]>
Returns boolean
Inherited from AbstractField.hasValidator
- Defined in app-sdk/index.d.ts:259

isEqual

isEqual(b): boolean
Parameters
- b: null | OptionValueType<M>[]
Returns boolean
Overrides AbstractField.isEqual
- Defined in app-sdk/index.d.ts:1323

`Protected`isModified

isModified(): boolean
Returns true if the current value is different from the original value

Returns boolean
Inherited from AbstractField.isModified
- Defined in app-sdk/index.d.ts:242

revert

revert(): void
Returns void
Inherited from AbstractField.revert
- Defined in app-sdk/index.d.ts:256

serialize

serialize(): N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]
Returns N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]
Inherited from AbstractField.serialize
- Defined in app-sdk/index.d.ts:233

setOriginalValue

setOriginalValue(value): void
Parameters
- value: N extends void
  ? OptionValueType<M>[]
  : null | OptionValueType<M>[]
Returns void
Inherited from AbstractField.setOriginalValue
- Defined in app-sdk/index.d.ts:236

setReactive

setReactive(props): void
Make some of the system properties reactive in the current model
Parameters
- props: ReactiveProp[]
  list of system properties
Returns void
Inherited from AbstractField.setReactive
- Defined in app-sdk/index.d.ts:1744

setValue

setValue(value, silent?): void
Parameters
- value: N extends void
  ? OptionValueType<M>[]
  : null | OptionValueType<M>[]
- Optionalsilent: boolean
Returns void
Inherited from AbstractField.setValue
- Defined in app-sdk/index.d.ts:235

splice

splice(start, deleteCount?, ...items): void
Method changes the contents of an ArrayField by removing or replacing existing elements and/or adding new elements in place Params are the same as Array.splice()
Parameters
- start: number
- OptionaldeleteCount: number
- Rest...items: OptionValueType<M>[]
Returns void
- Defined in app-sdk/index.d.ts:1321

updateDirty

updateDirty(): void
Returns void
Inherited from AbstractField.updateDirty
- Defined in app-sdk/index.d.ts:257

validate

validate(disablePropagation?): string[]
Parameters
- OptionaldisablePropagation: boolean
  Parent cmp notification flag about validation
Returns string[]
Inherited from AbstractField.validate
- Defined in app-sdk/index.d.ts:247

Class ArrayField<M, N>

Public

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns void

Parameters

Returns void

Returns ArrayField<M, N>

Properties

ProtectedallowNull

ProtecteddescriptorConfig

Protecteddirty

ProtectedobservabilitySet

ProtectedoriginalValue

persist

validationResult

Protectedvalue

Accessors

isPrimaryKey

Returns boolean

options

Returns { title: string; value: OptionValueType<M>; }[]

Methods

addValidator

Parameters

Returns void

bind

Parameters

Returns void

ProtectedcastValue

Parameters

Returns any

clearValidationResult

Returns void

commit

Returns void

compare

Parameters

Returns number

getDirty

Returns boolean

getErrorMessage

Returns string

getLabel

Returns string

getOriginalValue

Returns N extends void ? OptionValueType<M>[] : null | OptionValueType<M>[]

getValidationResult

Returns string[]

getValidators

Returns IFieldValidator<AbstractModel<any>>[]

getValue

Returns N extends void ? OptionValueType<M>[] : null | OptionValueType<M>[]

hasIntersection

Parameters

Returns boolean

hasValidator

Parameters

Returns boolean

isEqual

Parameters

Returns boolean

ProtectedisModified

Returns boolean

revert

Returns void

serialize

Returns N extends void ? OptionValueType<M>[] : null | OptionValueType<M>[]

setOriginalValue

Parameters

Returns void

`Protected`allowNull

`Protected`descriptorConfig

`Protected`dirty

`Protected`observabilitySet

`Protected`originalValue

`Protected`value

Returns {
title: string;
value: OptionValueType<M>;
}[]

`Protected`castValue

Returns N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]

Returns N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]

`Protected`isModified

Returns N extends void
? OptionValueType<M>[]
: null | OptionValueType<M>[]