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

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
Возвращает true, если поле является первичным ключом.

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

options

get options(): { title: string; value: OptionValueType<M> }[]
Возвращает массив опций.

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

Methods

addValidator

addValidator(validator: IFieldValidator): void
Добавляет валидатор поля.
Parameters
- validator: IFieldValidator
  Экземпляр валидатора.
Returns void
Inherited from AbstractField.addValidator
- Defined in app-sdk/index.d.ts:670

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

`Protected`castValue

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

clearValidationResult

clearValidationResult(): void
Очищает текущее состояние валидации поля.

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

commit

commit(): void
Записывает значение

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

compare

compare(
a: N extends void ? OptionValueType<M>[] : null | OptionValueType<M>[],
b: N extends void ? OptionValueType<M>[] : null | OptionValueType<M>[],
): number
Сравнивает элементы типа 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:680

getDirty

getDirty(): boolean
Возвращает флаг изменено ли значение

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

getErrorMessage

getErrorMessage(): string
Возвращает сообщение об ошибке.

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

getLabel

getLabel(): string
Возвращает метку поля.

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

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

getValidationResult

getValidationResult(): string[]
Возвращает копию результата валидации.

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

getValidators

getValidators(): IFieldValidator<AbstractModel<any>>[]
Возвращает список валидаторов поля.

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

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

hasIntersection

hasIntersection(arr: null | OptionValueType<M>[]): boolean
Проверяет наличие пересечения с переданным массивом.
Parameters
- arr: null | OptionValueType<M>[]
  Массив для проверки.
Returns boolean
- Defined in app-sdk/index.d.ts:3433

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

isEqual

isEqual(b: null | OptionValueType<M>[]): boolean
Проверяет равенство текущего значения и переданного.
Parameters
- b: null | OptionValueType<M>[]
  Значение для сравнения.
Returns boolean
Overrides AbstractField.isEqual
- Defined in app-sdk/index.d.ts:3428

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

revert

revert(): void
Восстанавливает исходное значение поля.

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

serialize

serialize(): N extends void ? OptionValueType<M>[] : null | OptionValueType<M>[]
Сериализует значение поля в JavaScript-объект.

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

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

setReactive

setReactive(props: ReactiveProp[]): void
Делает некоторые системные свойства реактивными в текущей модели.
Parameters
- props: ReactiveProp[]
  Список системных свойств.
Returns void
Inherited from AbstractField.setReactive
- Defined in app-sdk/index.d.ts:4910

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

splice

splice(
    start: number,
    deleteCount?: number,
    ...items: OptionValueType<M>[],
): void
Изменяет содержимое массива путём удаления и/или добавления элементов. Параметры соответствуют Array.splice().
Parameters
- start: number
  Индекс начала изменений.
- OptionaldeleteCount: number
  Количество удаляемых элементов.
- ...items: OptionValueType<M>[]
  Добавляемые элементы.
Returns void
- Defined in app-sdk/index.d.ts:3422

updateDirty

updateDirty(): void
Обновляет флаг изменилось ли поле.

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

validate

validate(disablePropagation?: boolean): string[]
Валидирует поле.
Parameters
- OptionaldisablePropagation: boolean
  Флаг отключения передачи результата родителю
Returns string[]
Inherited from AbstractField.validate
- Defined in app-sdk/index.d.ts:661

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