@lcap/asl/out/types/page/ViewVariable.d.ts

NetEase Application Specific Language

import { Logic, Variable, View, Schema, ActionOptions } from '..';
/**
 * 页面局部变量
 */
export declare class ViewVariable extends Variable {
    /**
     * 视图
     */
    readonly view: View;
    readonly viewId: string;
    /**
     * 默认值
     * 按 JSON string 处理
     * - string: 666 -> '666'
     * - string: true -> 'true'
     * - number: 666 -> 666
     * - boolean: true -> true
     */
    defaultValue: string;
    /**
     * @param source 需要合并的部分参数
     */
    constructor(source?: Partial<ViewVariable>);
    /**
     * 添加页面局部变量
     */
    create(none?: void, actionOptions?: ActionOptions): Promise<this>;
    /**
     * 删除页面局部变量
     */
    delete(none?: void, actionOptions?: ActionOptions): Promise<void>;
    /**
     * 修改页面局部变量
     */
    update(none?: void, actionOptions?: ActionOptions, then?: () => Promise<any>): Promise<this>;
    /**
     * 设置页面局部变量名称
     * @param name 名称
     */
    setName(name: string): Promise<void>;
    /**
     * 设置页面局部变量描述
     * @param description 描述
     */
    setDescription(description: string): Promise<void>;
    /**
     * 查找schema 顶点被引用的逻辑顶点列表
     */
    getSchemaUsage(): Promise<any>;
    /**
     * 设置页面局部变量的数据类型
     */
    setDataType(schema: Schema): Promise<void>;
    /**
     * 设置页面局部变量是否为列表
     * @param isArray
     */
    setAsList(isArray: boolean): Promise<void>;
    /**
     * 设置页面局部变量的默认值
     */
    setDefaultValue(defaultValue: string): Promise<void>;
    /**
     * 设置页面局部变量是否必须
     * @param required 必须
     */
    setRequired(required: boolean): Promise<void>;
    /**
     * 从后端 JSON 生成规范的 ViewVariable 对象
     */
    static from(source: any, view: View | Logic): ViewVariable;
}
export default ViewVariable;