wallee/dist/models/LabelDescriptor.d.ts

TypeScript/JavaScript client for wallee

import type { Feature } from './Feature';
import type { LabelDescriptorCategory } from './LabelDescriptorCategory';
import type { LabelDescriptorGroup } from './LabelDescriptorGroup';
/**
 *
 * @export
 * @interface LabelDescriptor
 */
export interface LabelDescriptor {
    /**
     * The features that this label belongs to.
     * @type {Set<Feature>}
     * @memberof LabelDescriptor
     */
    readonly features?: Set<Feature>;
    /**
     * The localized name of the object.
     * @type {{ [key: string]: string; }}
     * @memberof LabelDescriptor
     */
    readonly name?: {
        [key: string]: string;
    };
    /**
     * The localized description of the object.
     * @type {{ [key: string]: string; }}
     * @memberof LabelDescriptor
     */
    readonly description?: {
        [key: string]: string;
    };
    /**
     * When listing labels, they can be sorted by this number.
     * @type {number}
     * @memberof LabelDescriptor
     */
    readonly weight?: number;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof LabelDescriptor
     */
    readonly id?: number;
    /**
     *
     * @type {LabelDescriptorCategory}
     * @memberof LabelDescriptor
     */
    category?: LabelDescriptorCategory;
    /**
     * The type of the label's value.
     * @type {number}
     * @memberof LabelDescriptor
     */
    readonly type?: number;
    /**
     *
     * @type {LabelDescriptorGroup}
     * @memberof LabelDescriptor
     */
    group?: LabelDescriptorGroup;
}
/**
 * Check if a given object implements the LabelDescriptor interface.
 */
export declare function instanceOfLabelDescriptor(value: object): value is LabelDescriptor;
export declare function LabelDescriptorFromJSON(json: any): LabelDescriptor;
export declare function LabelDescriptorFromJSONTyped(json: any, ignoreDiscriminator: boolean): LabelDescriptor;
export declare function LabelDescriptorToJSON(json: any): LabelDescriptor;
export declare function LabelDescriptorToJSONTyped(value?: Omit<LabelDescriptor, 'features' | 'name' | 'description' | 'weight' | 'id' | 'type'> | null, ignoreDiscriminator?: boolean): any;