@alilc/lowcode-shell/lib/model/props.d.ts

Shell Layer for AliLowCodeEngine

import { IProps as InnerProps } from '@alilc/lowcode-designer';
import { IPublicTypeCompositeValue, IPublicModelProps, IPublicModelNode, IPublicModelProp } from '@alilc/lowcode-types';
import { propsSymbol } from '../symbols';
export declare class Props implements IPublicModelProps {
    private readonly [propsSymbol];
    constructor(props: InnerProps);
    static create(props: InnerProps | undefined | null): IPublicModelProps | null;
    /**
     * id
     */
    get id(): string;
    /**
     * 返回当前 props 的路径
     */
    get path(): string[];
    /**
     * 返回所属的 node 实例
     */
    get node(): IPublicModelNode | null;
    /**
     * 获取指定 path 的属性模型实例
     * @param path 属性路径，支持 a / a.b / a.0 等格式
     * @returns
     */
    getProp(path: string): IPublicModelProp | null;
    /**
     * 获取指定 path 的属性模型实例值
     * @param path 属性路径，支持 a / a.b / a.0 等格式
     * @returns
     */
    getPropValue(path: string): any;
    /**
     * 获取指定 path 的属性模型实例，
     *  注：导出时，不同于普通属性，该属性并不挂载在 props 之下，而是与 props 同级
     * @param path 属性路径，支持 a / a.b / a.0 等格式
     * @returns
     */
    getExtraProp(path: string): IPublicModelProp | null;
    /**
     * 获取指定 path 的属性模型实例值
     *  注：导出时，不同于普通属性，该属性并不挂载在 props 之下，而是与 props 同级
     * @param path 属性路径，支持 a / a.b / a.0 等格式
     * @returns
     */
    getExtraPropValue(path: string): any;
    /**
     * 设置指定 path 的属性模型实例值
     * @param path 属性路径，支持 a / a.b / a.0 等格式
     * @param value 值
     * @returns
     */
    setPropValue(path: string, value: IPublicTypeCompositeValue): void;
    /**
     * 设置指定 path 的属性模型实例值
     * @param path 属性路径，支持 a / a.b / a.0 等格式
     * @param value 值
     * @returns
     */
    setExtraPropValue(path: string, value: IPublicTypeCompositeValue): void;
    /**
     * test if the specified key is existing or not.
     * @param key
     * @returns
     */
    has(key: string): boolean;
    /**
     * add a key with given value
     * @param value
     * @param key
     * @returns
     */
    add(value: IPublicTypeCompositeValue, key?: string | number | undefined): any;
}