Preparing search index...

    Interface IRecordValuedAttribute

    Интерфейс атрибута записи со значением

    interface IRecordValuedAttribute {
        dirty: boolean;
        hidden: BooleanField;
        modelId: number;
        name: StringField;
        observabilitySet: Set<ReactiveProp>;
        onChangeDirty: ModelDirtyChangeHandler;
        onValidation: (_validationResult: IValidationResult) => void;
        phantom: boolean;
        setHidden: (isHidden: boolean) => void;
        type: EnumField<SIMPLE_DATA_TYPE>;
        validationResult: IValidationResult;
        value: ModelCollection<any> | AnyField<any>;
        get isHidden(): boolean;
        get isValueEmpty(): boolean;
        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): undefined | AbstractField<any, BaseOptions>;
        getFieldJsonDescriptor(
            propertyName: string,
        ):
            | undefined
            | ClassPropertyDescriptor<any, AbstractField<any, BaseOptions>>;
        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,
        ): undefined | ClassPropertyDescriptor<any, ModelCollection<any>>;
        getHasManyMainDescriptor(
            propertyName: string,
        ): ClassPropertyDescriptor<any, ModelCollection<any>>;
        getHasManyMainDescriptors(): ClassPropertyDescriptor<
            any,
            ModelCollection<any>,
        >[];
        getHasManyMap(): { [key: string]: any };
        getHasOneCollection(): any[];
        getHasOneJsonDescriptor(
            propertyName: string,
        ): undefined | ClassPropertyDescriptor<any, AbstractModel<any>>;
        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>,
        ): undefined | ModelProperty<any, T, any>;
        getReferencesChanged(): boolean;
        getValidationResult(level?: number): Map<string, string[]>;
        isEqual(model: AbstractModel<any>, config?: EqualConfig): boolean;
        revert(): void;
        serialize(
            config?: SerializationConfig,
        ): Partial<Pick<GetTypes<any>, string>>;
        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;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    dirty hidden modelId name observabilitySet onChangeDirty onValidation phantom setHidden type validationResult value

    Accessors

    isHidden isValueEmpty

    Methods

    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

    Properties

    dirty: boolean
    hidden: BooleanField

    Флаг является ли атрибут скрытым

    Следует использовать setHidden и isHidden

    @universe-platform/record 2.0.0

    modelId: number
    name: StringField

    Имя атрибута

    observabilitySet: Set<ReactiveProp>
    onChangeDirty: ModelDirtyChangeHandler
    onValidation: (_validationResult: IValidationResult) => void
    phantom: boolean
    setHidden: (isHidden: boolean) => void

    Метод, устанавливающий флаг скрытности атрибута

    Type declaration

      • (isHidden: boolean): void

      • Parameters

        • isHidden: boolean

          Флаг является ли атрибут скрытым

        Returns void

    type: EnumField<SIMPLE_DATA_TYPE>

    Тип атрибута

    validationResult: IValidationResult
    value: ModelCollection<any> | AnyField<any>

    Значение атрибута

    Accessors

    • get isHidden(): boolean

      Геттер, определяющий является ли атрибут скрытым

      Returns boolean

    • get isValueEmpty(): boolean

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

      Returns boolean

    Methods

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

      Returns void

    • The method calls before the model initialization begins

      Returns void

    • Cloning model data

      Type Parameters

      Parameters

      • OptionalincludeSystemProps: boolean

        phantom, dirty, original values

      Returns T

      T

    • Creates model fields

      Parameters

      • data: any

      Returns void

    • Parameters

      • name: string

      Returns any

    • Parameters

      • validatorName: string

      Returns string

    • Returns an array of model fields

      Returns any[]

    • Returns { [key: string]: any }

    • Returns { [key: string]: any }

    • Returns { [key: string]: any }

    • Returns an array of original hasOne

      Returns { [key: string]: any }

    • This method is called at the validation. If there is logical errors in model, here will be list of them

      Returns string[]

    • Returns whether a new record is selected

      Returns boolean

    • Parameters

      • Optionallevel: number

      Returns Map<string, string[]>

    • Parameters

      • flag: boolean

      Returns void

    • Parameters

      • flag: boolean

      Returns void

    • Sets the phantom attribute cascadingly for the model

      Parameters

      • phantom: boolean

      Returns void

    • Make some of the system properties reactive in the current model

      Parameters

      Returns void

    On This Page

    Properties
    Accessors
    Methods
    afterInitbeforeInitcalculateDeepDirtycalculateDirtycalculateFieldsDirtycalculateModelDirtycheckFieldDirtyclearValidationResultclonecommitcommitFieldscommitHasManycommitHasOnecreateFieldscreateHasManycreateHasOnegetCollectiongetDeepDirtygetDirtygetErrorMessagegetFieldgetFieldJsonDescriptorgetFieldMainDescriptorgetFieldMainDescriptorsgetFieldsgetFieldsMapgetHasManyCollectiongetHasManyJsonDescriptorgetHasManyMainDescriptorgetHasManyMainDescriptorsgetHasManyMapgetHasOneCollectiongetHasOneJsonDescriptorgetHasOneMainDescriptorgetHasOneMainDescriptorsgetHasOneMapgetHasOneOriginalCollectiongetLogicErrorsgetModelDirtygetPhantomgetPrimaryKeyValuegetPropertiesAsMapByDescriptorsgetPropertiesByDescriptorsgetPropertyByDescriptorgetReferencesChangedgetValidationResultisEqualrevertserializesetDeepDirtysetDirtysetPhantomCascadesetReactivesetReactiveCascadesetReferencesChangedupdateDeepDirtyupdateDirtyupdateModelDirtyvalidate