# 公共模块

# 模块名称： Common

# 设置实体颜色

接口名称： setEntityColor
输入参数：

参数名称	参数含义	类型	必须	参数值说明
entityId	实体Id	整型	是	修改颜色的实体
colorVal	颜色值	字符串	是	十六进制数值表示
opacity	透明度	字符串	否	区间[0-1]内的值默认 1 需要以字符串的形式传入

返回值： NULL

//示例程序
Common.setEntityColor(entityId, {
    colorVal: '#C8C8C8', 
    opacity: '0.5' 
});

1
2
3
4
5

# 设置实体显隐性

接口名称： setEntityVisible
输入参数：

参数名称	参数含义	类型	必须	参数值说明
entityId	实体Id	整型	是	修改显隐性的实体
visibleType	是否显示	整型	否	0 隐藏默认 1 显示

返回值： NULL

//示例程序
Common.setEntityVisible(entityId, isVisible);

1
2

# 批量设置实体显隐性

接口名称： setEntitiesVisible
输入参数：

参数名称	参数含义	类型	必须	参数值说明
entityIds	实体Id数组	整型 list	是	修改显隐性的实体
visibleType	是否显示	整型	否	0 隐藏默认 1 显示

返回值： NULL

//示例程序
Common.setEntitiesVisible(entityIds, isVisible);

1
2

# 设置实体的名字

接口名称： setEntityName
输入参数：

参数名称	参数含义	类型	必须	参数值说明
entityId	实体Id	整型	是	实体对应的Id
entityName	实体的名字	字符串	是	实体的名字可以重复

返回值： NULL

//示例程序
Common.setEntityName(entityIds, isVisible);

1
2

# 创建变量

接口名称： createVariable
输入参数：

参数名称	参数含义	类型	必须	参数值说明
variableName	变量的名称	字符串	是	变量的名称（不可以重复）
variableValue	变量的值	浮点数	是
variableType	变量的类型	内置enum类型	是	类型有:VariableType.(Length/Number/Angle)
variableUnit	变量的单位	内置enum类型	是	类型有:VariableUnit.(mm/cm/m/degree/radian/number)
description	描述信息	字符串	否

返回值： NULL

//示例程序
Common.createVariable('variable',{
  variableValue: 11.0,
  variableType: VariableType.Length,
  variableUnit: VariableUnit.mm,
  variableValue: '描述信息'
});

1
2
3
4
5
6
7

# 修改变量信息

接口名称： assignVariable
输入参数：

参数名称	参数含义	类型	必须	参数值说明
variableName	变量的名称	字符串	是	需要修改变量的名称
variableValue	变量的值	浮点数	否
variableType	变量的类型	内置enum类型	否	类型有:VariableType.(Length/Number/Angle)
variableUnit	变量的单位	内置enum类型	否	类型有:VariableType.(mm/cm/m/degree/radian/number)
description	描述信息	字符串	否

返回值： NULL

//示例程序
Common.assignVariable('variable',{
	description: '修改变量信息'
});

1
2
3
4

# 删除变量

接口名称： deleteVariable
输入参数：

参数名称	参数含义	类型	必须	参数值说明
variableName	变量的名称	字符串	是	需要删除变量的名称

返回值： NULL

//示例程序
Common.deleteVariable('variable');

1
2