跳到主要内容

IParamModelLiteParam 接口

interface IParamModelLiteParam<T = any>

模型的参数信息 @vm-type IParamType

方法​

cancelOverride​

cancelOverride(): any;

取消当前字段被覆盖

返回值： any

getDescription​

getDescription(): string | undefined;

当前参数描述信息

返回值： string | undefined

getDisplayName​

getDisplayName(): string;

获取参数的显示名称

返回值： string

getEditable​

getEditable(): boolean;

当前参数是否可以被编辑 如果为不可编辑的话，强制更改参数也不会生效

返回值： boolean

getMax​

getMax(): number | undefined;

获取当前参数输入值的最大值（参数化编辑器中设置的）

返回值： number | undefined

getMin​

getMin(): number | undefined;

获取当前参数输入值的最小值（参数化编辑器中设置的）

返回值： number | undefined

getName​

getName(): string;

获取参数名称

返回值： string

getOptionValues​

getOptionValues(): NamedValue[];

获取可选值

返回值： NamedValue[]

getPackageId​

getPackageId(): string | undefined;

获取约束的产品包id

返回值： string | undefined

getParamForm​

getParamForm(): EParamForm | undefined;

获取当前参数类型

返回值： EParamForm | undefined

getParsedValue​

getParsedValue(): T;

警告：此 API 现已过时。

请直接使用'getValue'方法

返回值： T

getPrimitiveOverride​

getPrimitiveOverride(): boolean;

警告：此 API 现已过时。

直接调用isOverridden()方法即可

是否需要将设置的参数覆盖原始参数信息 仅对部分参数设计有效，具体细节，见对应场景

返回值： boolean

getRecommendValues​

getRecommendValues(): NamedValue[];

获取当前模型在参数化编辑器中设置的推荐值

返回值： NamedValue[]

getSimpleName​

getSimpleName(): string | undefined;

获取参数简写名称

返回值： string | undefined

getStep​

getStep(): number | undefined;

获取当前参数的步长信息

返回值： number | undefined

getType​

getType(): EParamType;

获取当前参数值类型

返回值： EParamType

getUnitType​

getUnitType(): EParamUnitType | undefined;

获取当前字段的单位类型

返回值： EParamUnitType | undefined

getValue​

getValue(): T;

获取当前参数解析后的值内容

返回值： T

getValueDisplayNames​

getValueDisplayNames(): string[];

当为多布尔值时，展示的内容

返回值： string[]

getVisible​

getVisible(): boolean | undefined;

当前参数在工具中是否可见

返回值： boolean | undefined

isOverridden​

isOverridden(): boolean | undefined;

当前字段是否被覆盖

返回值： boolean | undefined

isUsingMixFormula​

isUsingMixFormula(): boolean;

判断当前值是否使用复合公式

返回值： boolean

setParsedValue​

setParsedValue(value: T): any;

警告：此 API 现已过时。

请直接使用'setValue'方法

参数：

  • value: T

返回值： any

setPrimitiveOverride​

setPrimitiveOverride(value: boolean): void;

警告：此 API 现已过时。

此逻辑，将在调用setValue时，自动完成此步骤，此方法可以忽略

是否需要将设置的参数覆盖原始参数信息

参数：

  • value: boolean

返回值： void

setValue​

setValue(value: T): any;

设置当前参数的值 当前函数并未对输入的参数进行校验

参数：

  • value: T

返回值： any

useMixFormula​

useMixFormula(): void;

重置当前参数使用复合公式

返回值： void