Класс ArrayField<M, N>

Поле для работы с массив значениями

Параметры типа

M
N extends void | null = void

Иерархия (Просмотр сводки)

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

Индекс

Конструкторы

constructor

new ArrayField<M, N extends void | null = void>(
    value: N extends void
        ? OptionValueType<M>[]
        : OptionValueType<M>[] | null,
    onChangeDirty?: ModelDirtyChangeHandler,
    descriptorConfig?: IArrayFieldMainDescriptorConfig<M, void>,
    onValidation?: (validationResult: string[]) => void,
): ArrayField<M, N>
Параметры типа
- M
- N extends void | null = void
Параметры
- value: N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null
- OptionalonChangeDirty: ModelDirtyChangeHandler
- OptionaldescriptorConfig: IArrayFieldMainDescriptorConfig<M, void>
- OptionalonValidation: (validationResult: string[]) => void
Возвращает ArrayField<M, N>
Наследуется от AbstractField.constructor

Свойства

`Protected`allowNull

allowNull: boolean

`Protected`descriptorConfig

descriptorConfig: IArrayFieldMainDescriptorConfig<M, void> | undefined

`Protected`dirty

dirty: boolean

`Protected`observabilitySet

observabilitySet: Set<ReactiveProp>

`Protected`originalValue

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

persist

persist: boolean

Флаг, указывающий на сохранение поля при сериализации.

validationResult

validationResult: string[]

Список сообщений валидации поля.

`Protected`value

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

Акцессоры

isPrimaryKey

get isPrimaryKey(): boolean
Возвращает true, если поле является первичным ключом.

Возвращает boolean
Наследуется от AbstractField.isPrimaryKey

options

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

Возвращает { title: string; value: OptionValueType<M> }[]

Методы

addValidator

addValidator(validator: IFieldValidator): void
Добавляет валидатор поля.
Параметры
- validator: IFieldValidator
  Экземпляр валидатора.
Возвращает void
Наследуется от AbstractField.addValidator

bind

bind(
    field: AbstractField<
        N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null,
    >,
): void
Привязывает другое поле к текущему для синхронизации значений.
Параметры
- field: AbstractField<
  N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null,
  >
  Поле для привязки.
Возвращает void
Наследуется от AbstractField.bind

`Protected`castValue

castValue(value: any): any
Параметры
- value: any
Возвращает any
Переопределяет AbstractField.castValue

clearValidationResult

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

Возвращает void
Наследуется от AbstractField.clearValidationResult

commit

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

Возвращает void
Переопределяет AbstractField.commit

compare

compare(
a: N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null,
b: N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null,
): number
Сравнивает элементы типа T.
Параметры
- a: N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null
  Первый элемент.
- b: N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null
  Второй элемент.
Возвращает number
Наследуется от AbstractField.compare

getDirty

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

Возвращает boolean
Наследуется от AbstractField.getDirty

getErrorMessage

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

Возвращает string
Наследуется от AbstractField.getErrorMessage

getLabel

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

Возвращает string
Наследуется от AbstractField.getLabel

getOriginalValue

getOriginalValue(): N extends void
? OptionValueType<M>[]
: OptionValueType<M>[] | null
Возвращает исходное значение поля.

Возвращает N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null
Наследуется от AbstractField.getOriginalValue

getValidationResult

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

Возвращает string[]
Наследуется от AbstractField.getValidationResult

getValidators

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

Возвращает IFieldValidator<AbstractModel<any>>[]
Наследуется от AbstractField.getValidators

getValue

getValue(): N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null
Возвращает текущее значение поля.

Возвращает N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null
Наследуется от AbstractField.getValue

hasIntersection

hasIntersection(arr: OptionValueType<M>[] | null): boolean
Проверяет наличие пересечения с переданным массивом.
Параметры
- arr: OptionValueType<M>[] | null
  Массив для проверки.
Возвращает boolean

hasValidator

hasValidator(validator: ClassCtor<IFieldValidator<AbstractModel<any>>>): boolean
Проверяет наличие валидатора указанного типа.
Параметры
- validator: ClassCtor<IFieldValidator<AbstractModel<any>>>
  Класс валидатора.
Возвращает boolean
Наследуется от AbstractField.hasValidator

isEqual

isEqual(b: OptionValueType<M>[] | null): boolean
Проверяет равенство текущего значения и переданного.
Параметры
- b: OptionValueType<M>[] | null
  Значение для сравнения.
Возвращает boolean
Переопределяет AbstractField.isEqual

`Protected`isModified

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

Возвращает boolean
Наследуется от AbstractField.isModified

revert

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

Возвращает void
Наследуется от AbstractField.revert

serialize

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

Возвращает N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null
Наследуется от AbstractField.serialize

setOriginalValue

setOriginalValue(
    value: N extends void
        ? OptionValueType<M>[]
        : OptionValueType<M>[] | null,
): void
Устанавливает исходное значение поля.
Параметры
- value: N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null
  Исходное значение.
Возвращает void
Наследуется от AbstractField.setOriginalValue

setReactive

setReactive(props: ReactiveProp[]): void
Делает некоторые системные свойства реактивными в текущей модели.
Параметры
- props: ReactiveProp[]
  Список системных свойств.
Возвращает void
Наследуется от AbstractField.setReactive

setValue

setValue(
    value: N extends void
        ? OptionValueType<M>[]
        : OptionValueType<M>[] | null,
    silent?: boolean,
): void
Устанавливает новое значение поля.
Параметры
- value: N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null
  Новое значение.
- Optionalsilent: boolean
  Флаг тихой установки
Возвращает void
Наследуется от AbstractField.setValue

splice

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

updateDirty

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

Возвращает void
Наследуется от AbstractField.updateDirty

validate

validate(disablePropagation?: boolean): string[]
Валидирует поле.
Параметры
- OptionaldisablePropagation: boolean
  Флаг отключения передачи результата родителю
Возвращает string[]
Наследуется от AbstractField.validate

Класс ArrayField<M, N>

Параметры типа

Иерархия (Просмотр сводки)

Индекс

Конструкторы

Свойства

Акцессоры

Методы

Конструкторы

constructor

Параметры типа

Параметры

Возвращает ArrayField<M, N>

Свойства

ProtectedallowNull

ProtecteddescriptorConfig

Protecteddirty

ProtectedobservabilitySet

ProtectedoriginalValue

persist

validationResult

Protectedvalue

Акцессоры

isPrimaryKey

Возвращает boolean

options

Возвращает { title: string; value: OptionValueType<M> }[]

Методы

addValidator

Параметры

Возвращает void

bind

Параметры

Возвращает void

ProtectedcastValue

Параметры

Возвращает any

clearValidationResult

Возвращает void

commit

Возвращает void

compare

Параметры

Возвращает number

getDirty

Возвращает boolean

getErrorMessage

Возвращает string

getLabel

Возвращает string

getOriginalValue

Возвращает N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null

getValidationResult

Возвращает string[]

getValidators

Возвращает IFieldValidator<AbstractModel<any>>[]

getValue

Возвращает N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null

hasIntersection

Параметры

Возвращает boolean

hasValidator

Параметры

Возвращает boolean

isEqual

Параметры

Возвращает boolean

ProtectedisModified

Возвращает boolean

revert

Возвращает void

serialize

Возвращает N extends void ? OptionValueType<M>[] : OptionValueType<M>[] | null

setOriginalValue

Параметры

Возвращает void

setReactive

Параметры

Возвращает void

setValue

`Protected`allowNull

`Protected`descriptorConfig

`Protected`dirty

`Protected`observabilitySet

`Protected`originalValue

`Protected`value

`Protected`castValue

`Protected`isModified