Юниверс DG SDK UI
v2.15.0

Интерфейс IParameterDescriptor

Интерфейс, описывающий дескриптор параметра

interface IParameterDescriptor {
    confidential?: BooleanField<void>;
    defaultValue: AnyField;
    description: StringField;
    dirty: boolean;
    displayName: StringField;
    editable?: BooleanField<void>;
    hidden?: BooleanField<void>;
    kind: EnumField<ParameterKind>;
    modelId: number;
    name: StringField;
    notice?: StringField<null>;
    observabilitySet: Set<ReactiveProp>;
    onChangeDirty: ModelDirtyChangeHandler;
    onValidation: (_validationResult: IValidationResult) => void;
    phantom: boolean;
    readOnly: BooleanField;
    required: BooleanField;
    selector: AnyField<Map<object, string>>;
    selectorGroups?: AnyField<Record<string, string>>;
    showCondition: IParameterShowCondition | null;
    type: EnumField<ParameterDataType>;
    validationResult: IValidationResult;
    viewType: EnumField<ParameterViewType>;
    afterInit(): void;
    beforeInit(): void;
    calculateDeepDirty(): boolean;
    calculateDirty(): boolean;
    calculateFieldsDirty(): boolean;
    calculateModelDirty(): boolean;
    checkFieldDirty(field: AbstractField<any>): boolean;
    clearValidationResult(): void;
    clone<T extends AbstractModel<any>>(includeSystemProps?: boolean): T;
    commit(): void;
    commitFields(): void;
    commitHasMany(): void;
    commitHasOne(): void;
    createFields(data: any): void;
    createHasMany(data: any, initConfig: Partial<ModelOptions>): void;
    createHasOne(data: any, initConfig: Partial<ModelOptions>): void;
    getCollection(name: string): any;
    getDeepDirty(): boolean;
    getDirty(): boolean;
    getErrorMessage(validatorName: string): string;
    getField(name: string): AbstractField<any, BaseOptions> | undefined;
    getFieldJsonDescriptor(
        propertyName: string,
    ):
        | ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>
        | undefined;
    getFieldMainDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>;
    getFieldMainDescriptors(): ClassPropertyDescriptor<
        any,
        AbstractField<any, BaseOptions>,
    >[];
    getFields(): any[];
    getFieldsMap(): { [key: string]: any };
    getHasManyCollection(): any[];
    getHasManyJsonDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, ModelCollection<any>> | undefined;
    getHasManyMainDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, ModelCollection<any>>;
    getHasManyMainDescriptors(): ClassPropertyDescriptor<
        any,
        ModelCollection<any>,
    >[];
    getHasManyMap(): { [key: string]: any };
    getHasOneCollection(): any[];
    getHasOneJsonDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, AbstractModel<any>> | undefined;
    getHasOneMainDescriptor(
        propertyName: string,
    ): ClassPropertyDescriptor<any, AbstractModel<any>>;
    getHasOneMainDescriptors(): ClassPropertyDescriptor<
        any,
        AbstractModel<any>,
    >[];
    getHasOneMap(): { [key: string]: any };
    getHasOneOriginalCollection(): { [key: string]: any };
    getLogicErrors(): string[];
    getModelDirty(): boolean;
    getPhantom(): boolean;
    getPrimaryKeyValue(): string;
    getPropertiesAsMapByDescriptors<
        T extends
            | AbstractModel<any>
            | AbstractField<any, BaseOptions>
            | ModelCollection<any>,
    >(
        descriptors: ClassPropertyDescriptor<any, T>[],
    ): { [key in string]?: ModelProperty<any, T, any> };
    getPropertiesByDescriptors<
        T extends
            | AbstractModel<any>
            | AbstractField<any, BaseOptions>
            | ModelCollection<any>,
    >(
        descriptors: ClassPropertyDescriptor<any, T>[],
    ): ModelProperty<any, T, any>[];
    getPropertyByDescriptor<
        T extends
            | AbstractModel<any>
            | AbstractField<any, BaseOptions>
            | ModelCollection<any>,
    >(
        descriptor: ClassPropertyDescriptor<any, T>,
    ): ModelProperty<any, T, any> | undefined;
    getReferencesChanged(): boolean;
    getValidationResult(level?: number): Map<string, string[]>;
    isEqual(model: AbstractModel<any>, config?: EqualConfig): boolean;
    revert(): void;
    serialize(config?: SerializationConfig): SerializedType<Ch>;
    setDeepDirty(flag: boolean): void;
    setDirty(flag: boolean): void;
    setPhantomCascade(phantom: boolean): void;
    setReactive(props: ReactiveProp[]): void;
    setReactiveCascade(props: ReactiveProp[]): void;
    setReferencesChanged(flag: boolean): void;
    updateDeepDirty(): void;
    updateDirty(): void;
    updateModelDirty(): void;
    validate(disablePropagation?: boolean): IValidationResult;
}

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

Реализован в

Индекс

Свойства

confidential? defaultValue description dirty displayName editable? hidden? kind modelId name notice? observabilitySet onChangeDirty onValidation phantom readOnly required selector selectorGroups? showCondition type validationResult viewType

Методы

afterInit beforeInit calculateDeepDirty calculateDirty calculateFieldsDirty calculateModelDirty checkFieldDirty clearValidationResult clone commit commitFields commitHasMany commitHasOne createFields createHasMany createHasOne getCollection getDeepDirty getDirty getErrorMessage getField getFieldJsonDescriptor getFieldMainDescriptor getFieldMainDescriptors getFields getFieldsMap getHasManyCollection getHasManyJsonDescriptor getHasManyMainDescriptor getHasManyMainDescriptors getHasManyMap getHasOneCollection getHasOneJsonDescriptor getHasOneMainDescriptor getHasOneMainDescriptors getHasOneMap getHasOneOriginalCollection getLogicErrors getModelDirty getPhantom getPrimaryKeyValue getPropertiesAsMapByDescriptors getPropertiesByDescriptors getPropertyByDescriptor getReferencesChanged getValidationResult isEqual revert serialize setDeepDirty setDirty setPhantomCascade setReactive setReactiveCascade setReferencesChanged updateDeepDirty updateDirty updateModelDirty validate

Свойства

confidential?: BooleanField<void>

Флаг, показывающий возможность использования секретных пользовательских параметров.

defaultValue: AnyField

Значение по умолчанию.

description: StringField

Описание параметра.

dirty: boolean

Является ли модель измененной

displayName: StringField

Отображаемое имя.

editable?: BooleanField<void>

Флаг, разрешающий редактирование

hidden?: BooleanField<void>

Флаг, показывающий скрыть ли параметр.

kind: EnumField<ParameterKind>

Тип параметра.

modelId: number

Идентификатор модели

name: StringField

Имя параметра.

notice?: StringField<null>

Примечание.

observabilitySet: Set<ReactiveProp>
onChangeDirty: ModelDirtyChangeHandler

Хендлер изменения параметра dirty

onValidation: (_validationResult: IValidationResult) => void

Хендлер в момент валидации модели

phantom: boolean

Является ли модель еще не опубликованной

readOnly: BooleanField

Флаг, показывающий является ли параметр только для чтения.

required: BooleanField

Флаг, показывающий обязателен ли параметр.

selector: AnyField<Map<object, string>>

Настройка селектора.

selectorGroups?: AnyField<Record<string, string>>

Группы селектора.

showCondition: IParameterShowCondition | null

Условие для показа.

type: EnumField<ParameterDataType>

Тип данных параметра.

validationResult: IValidationResult
viewType: EnumField<ParameterViewType>

Тип отображения.

Методы

  • This method is called at the final stage of model initialization

    Возвращает void

  • The method calls before the model initialization begins

    Возвращает void

  • Метод, который вычисляет и возвращает флаг deepDirty

    Возвращает boolean

  • Метод получение любого активного флага dirty

    Возвращает boolean

  • Проверяет на наличие измененных полей

    Возвращает boolean

  • Метод, который вычисляет и возвращает флаг изменения модели

    Возвращает boolean

  • Очищает результаты валидации

    Возвращает void

  • Клонирование модели

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

    Параметры

    • OptionalincludeSystemProps: boolean

      параметр, отвечающий за сохранение системных параметров модели

    Возвращает T

  • Запись изменений в модель

    Возвращает void

  • Creates model fields

    Параметры

    • data: any

    Возвращает void

  • Метод получения коллекции ключей

    Параметры

    • name: string

      Имя коллекции, которое нужно получить

    Возвращает any

  • Получение флага deepDirty

    Возвращает boolean

  • Получение значения dirty

    Возвращает boolean

  • Получить сообщение об ошибки, после валидации

    Параметры

    • validatorName: string

      имя валидатора, у которого нужно получить сообщение об ошибке

    Возвращает string

  • Возвращает массив полей модели

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

  • Возвращает коллекцию типа ключ/значение полей модели

    Возвращает { [key: string]: any }

  • Возвращает массив моделей hasMany

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

  • Возвращает hasMany коллекцию типа ключ/значение полей модели

    Возвращает { [key: string]: any }

  • Возвращает массив моделей hasOne

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

  • Возвращает hasOne коллекцию типа ключ/значение полей модели

    Возвращает { [key: string]: any }

  • Возвращает массив оригинальной hasOne

    Возвращает { [key: string]: any }

  • Этот метод вызывается при валидации. Если в модели есть логические ошибки, то здесь будет приведен их список

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

  • Получение флага modelDirty

    Возвращает boolean

  • Получение параметра phantom

    Возвращает boolean

  • Возвращает значение первичного ключа

    Возвращает string

  • Получение флага, отвечающего за referencesChanged

    Возвращает boolean

  • Получение результата валидации

    Параметры

    • Optionallevel: number

      уровень ошибок, который должен вернуться

    Возвращает Map<string, string[]>

  • Отмена изменений в моделе

    Возвращает void

  • Изменение флага deepDirty

    Параметры

    • flag: boolean

      значение, которое нужно установить

    Возвращает void

  • Изменение фала dirty

    Параметры

    • flag: boolean

      значение, которое нужно установить

    Возвращает void

  • Устанавливает атрибут phantom каскадно для модели

    Параметры

    • phantom: boolean

    Возвращает void

  • Делает некоторые системные свойства реактивными в текущей модели.

    Параметры

    • props: ReactiveProp[]

      Список системных свойств.

    Возвращает void

  • Делает некоторые свойства системы реактивными, создавай каскад по всей модели

    Параметры

    • props: ReactiveProp[]

      список системных свойств

    Возвращает void

  • Изменение флага referencesChanged

    Параметры

    • flag: boolean

      значение, которое нужно установить

    Возвращает void

  • Обновление параметра dirty в модели

    Возвращает void

  • Изменение параметра dirty

    Возвращает void

  • Обновление параметра dirty в модели

    Возвращает void

  • Метод проверки модели

    Параметры

    • OptionaldisablePropagation: boolean

      Флаг уведомления родительского компонента о проверке

    Возвращает IValidationResult

© Авторские права 2025, Юниверс Дата.

Настройки

Видимость элементов?

На этой странице

Свойства
Методы
afterInitbeforeInitcalculateDeepDirtycalculateDirtycalculateFieldsDirtycalculateModelDirtycheckFieldDirtyclearValidationResultclonecommitcommitFieldscommitHasManycommitHasOnecreateFieldscreateHasManycreateHasOnegetCollectiongetDeepDirtygetDirtygetErrorMessagegetFieldgetFieldJsonDescriptorgetFieldMainDescriptorgetFieldMainDescriptorsgetFieldsgetFieldsMapgetHasManyCollectiongetHasManyJsonDescriptorgetHasManyMainDescriptorgetHasManyMainDescriptorsgetHasManyMapgetHasOneCollectiongetHasOneJsonDescriptorgetHasOneMainDescriptorgetHasOneMainDescriptorsgetHasOneMapgetHasOneOriginalCollectiongetLogicErrorsgetModelDirtygetPhantomgetPrimaryKeyValuegetPropertiesAsMapByDescriptorsgetPropertiesByDescriptorsgetPropertyByDescriptorgetReferencesChangedgetValidationResultisEqualrevertserializesetDeepDirtysetDirtysetPhantomCascadesetReactivesetReactiveCascadesetReferencesChangedupdateDeepDirtyupdateDirtyupdateModelDirtyvalidate