Class ArrayField<M, N>

Public

Type Parameters

M
N extends void | null = void

Hierarchy (View Summary)

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

Constructors

constructor

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

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:569

options

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

Methods

addValidator

addValidator(validator: IFieldValidator): void
Parameters
- validator: IFieldValidator
Returns void
Inherited from AbstractField.addValidator
- Defined in app-sdk/index.d.ts:554

bind

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

`Protected`castValue

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

clearValidationResult

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

commit

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

compare

compare(
a: N extends void ? OptionValueType<M>[] : null | OptionValueType<M>[],
b: N extends void ? OptionValueType<M>[] : null | OptionValueType<M>[],
): 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:559

getDirty

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

getErrorMessage

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

getLabel

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

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:543

getValidationResult

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

getValidators

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

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:542

hasIntersection

hasIntersection(arr: null | OptionValueType<M>[]): 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:2735

hasValidator

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

isEqual

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

`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:547

revert

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

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:538

setOriginalValue

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

setReactive

setReactive(props: ReactiveProp[]): 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:3585

setValue

setValue(
    value: N extends void
        ? OptionValueType<M>[]
        : null | OptionValueType<M>[],
    silent?: boolean,
): 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:540

splice

splice(
    start: number,
    deleteCount?: number,
    ...items: OptionValueType<M>[],
): 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
- ...items: OptionValueType<M>[]
Returns void
- Defined in app-sdk/index.d.ts:2729

updateDirty

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

validate

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

Class ArrayField<M, N>

Public

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

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

setReactive

Parameters

Returns void

`Protected`allowNull

`Protected`descriptorConfig

`Protected`dirty

`Protected`observabilitySet

`Protected`originalValue

`Protected`value

`Protected`castValue

`Protected`isModified