@itwin/ecschema-metadata/lib/cjs/Metadata/PropertyCategory.d.ts

ECObjects core concepts in typescript

/** @packageDocumentation
 * @module Metadata
 */
import { PropertyCategoryProps } from "../Deserialization/JsonProps";
import { SchemaItemType } from "../ECObjects";
import { Schema } from "./Schema";
import { SchemaItem } from "./SchemaItem";
/**
 * @public @preview
 */
export declare class PropertyCategory extends SchemaItem {
    readonly schemaItemType: SchemaItemType;
    /** @internal */
    static get schemaItemType(): SchemaItemType;
    private _priority;
    get priority(): number;
    /** @internal */
    constructor(schema: Schema, name: string);
    /**
     * Save this PropertyCategory's properties to an object for serializing to JSON.
     * @param standalone Serialization includes only this object (as opposed to the full schema).
     * @param includeSchemaVersion Include the Schema's version information in the serialized object.
     */
    toJSON(standalone?: boolean, includeSchemaVersion?: boolean): PropertyCategoryProps;
    /** @internal */
    toXml(schemaXml: Document): Promise<Element>;
    fromJSONSync(propertyCategoryProps: PropertyCategoryProps): void;
    fromJSON(propertyCategoryProps: PropertyCategoryProps): Promise<void>;
    /**
     * Used for schema editing.
     * @internal
     */
    protected setPriority(priority: number): void;
    /**
     * Type guard to check if the SchemaItem is of type PropertyCategory.
     * @param item The SchemaItem to check.
     * @returns True if the item is a PropertyCategory, false otherwise.
     */
    static isPropertyCategory(item?: SchemaItem): item is PropertyCategory;
    /**
     * Type assertion to check if the SchemaItem is of type PropertyCategory.
     * @param item The SchemaItem to check.
     * @returns The item cast to PropertyCategory if it is a PropertyCategory, undefined otherwise.
     * @internal
     */
    static assertIsPropertyCategory(item?: SchemaItem): asserts item is PropertyCategory;
}
/**
 * @internal
 * An abstract class used for schema editing.
 */
export declare abstract class MutablePropertyCategory extends PropertyCategory {
    abstract setPriority(priority: number): void;
    abstract setDisplayLabel(displayLabel: string): void;
}
//# sourceMappingURL=PropertyCategory.d.ts.map