脚本方法使用说明 | Mingcedar Studio

脚本按页面维护，没有可编辑的项目级脚本文档。当前页逻辑放在 Page Script，跨页复用使用宿主 runtime 或模板。

• 页面逻辑放当前页 Page Script
• 跨页复用优先交给宿主 runtime 或模板
• 单页流程不应作为全局公共逻辑维护

function openAlarmPage() {
  hqVisuDesigner.openPage("Alarm");
}

Page Script 处理当前页初始化、局部变量、数据整理、表格和交互逻辑。

• 适合页面打开后的初始化
• 适合当前页数据整理
• 适合当前页表格和局部交互逻辑

window.hqVisuDesignerPageReady = function(ctx) {
  var rows = window.tableRows || [];
  hqVisuDesigner.setComponentText("RowCountText", String(rows.length));
};

Setup Script 读取 Tag、计算中间值，供 Condition、Value 或 Display Text 使用。旧配置名为 Definition；设备写入由点击行为触发。

• 读取 Tag 并计算中间值
• 由 Condition / Value / Display Text 返回结果
• 同页共用的变量和函数放在 Page Script

var running = ReadTagInteger("PLC_LINE01.PUMP01.RUN", 0);
var alarm = ReadTagBoolean("PLC_LINE01.PUMP01.ALARM", false);
var ready = running === 1 && !alarm;

Click Script 处理点击、跳页、写值和弹窗；Hover Script 处理悬停提示、预览和样式变化。页面初始化使用 Page Script。

• 点击动作优先放 Click Script
• 悬停反馈优先放 Hover Script
• 对象脚本不承担页面初始化职责

// Click Script
hqVisuDesigner.openPage("Alarm");

// Hover Script -> Mouse Over
object.style.opacity = "0.75";

表达式字段须同步返回布尔值、文本、颜色或数字。fetch、Promise 和定时器放在 Page Script、对象脚本或 hqVisuDesignerPageReady 中，将结果存入页面变量。设备写入由用户操作触发。

• 布尔字段：返回 true / false
• 数值字段：返回 number
• 文本和颜色字段：返回 string
• 异步逻辑不直接作为表达式返回值

// Page Script
function pressureColor() {
  var pressure = ReadTagDouble("PLC_LINE01.PUMP01.PRESSURE", 0);
  return pressure > 8 ? "#dc2626" : "#16a34a";
}

// Script Color / Fill
pressureColor()

当前页的表格行、筛选条件、显示开关、标题和阈值放在 Page Script。Table 的 Rows 可引用数组变量或函数，无需单独建立 JSON 文档。

• 适合当前页独有配置
• 常用于表格数据和局部规则
• Rows 可填变量名或函数名

var tableRows = [
  ["Pump 1", "Running"],
  ["Pump 2", "Stop"]
];
var panelTitle = "泵站运行概览";

Python 或宿主脚本将报表、分页等结构化结果写入内部 JSON Tag，页面通过 ReadTagJson(...) 读取，沿用 Tag 通道。

• 适合报表行、分页结果和结构化状态
• 由 Python 写内部 Tag
• PPT 页面只负责 ReadTagJson 读取

var rows = ReadTagJson("PLC_LINE01.REPORT01.ROWS", []);
var updatedAt = ReadTagDateTime("PLC_LINE01.REPORT01.UPDATED_AT", null);

每页默认有一个受保护的 alarm.js，用来维护当前页报警窗口开关和范围。编辑核心对象 `HQVISU_PAGE_ALARM` 即可。

• 适合当前页报警窗口开关
• 适合当前页报警范围
• 每页独立，跟随页面导出

HQVISU_PAGE_ALARM = {
  showWindow: true,
  tags: [],
  deviceCodes: [],
  objectIdentifiers: [],
  groupCodes: [],
  areaCodes: []
};

读取当前页的 PPT 报警设置。它不是运行端报警规则本身，而是当前页面随导出包携带的报警窗口开关和报警范围配置。当前页没有 alarm 配置时，会返回传入的回退值或默认结构。

• 适合读取当前页是否允许显示报警窗口
• 适合读取页面携带的报警范围
• 导出后来自 HQVISU_PAGE_ALARM
• 没有配置时要给回退值，避免空对象报错

var alarmConfig = getPageAlarm({
  showWindow: true,
  tags: [],
  deviceCodes: [],
  objectIdentifiers: [],
  groupCodes: [],
  areaCodes: []
});

if (alarmConfig.showWindow) {
  hqVisuDesigner.setComponentVisible("PageAlarmPanel", true);
}

showWindow 控制报警窗口；tags 为完整点名，deviceCodes 为设备或 PLC 编码，objectIdentifiers 为对象标识，groupCodes 为信号组，areaCodes 为区域范围。空数组表示该维度不附加条件，不表示自动选择全部点位。

• 只指定几个点位时，优先填 tags
• 按设备限定范围时，填 deviceCodes
• 按对象或设备单元限定范围时，填 objectIdentifiers
• 按信号类别限定范围时，填 groupCodes
• 按区域或产线限定范围时，填 areaCodes

{
  "showWindow": true,
  "tags": [],
  "deviceCodes": [],
  "objectIdentifiers": [],
  "groupCodes": [],
  "areaCodes": []
}

读取当前宿主用户。它适合做轻量级个性化显示，例如页面欢迎语、当前操作人展示和当前用户标记。它不是权限系统本身，权限判断应以宿主机规则为准。

• 适合欢迎语和当前用户显示
• 适合轻量日志标记
• 权限校验仍然应以宿主机规则为准

var username = GetCurrentUsername();
hqVisuDesigner.setComponentText("CurrentUser", username || "Guest");

ReadTagBoolean(name, fallback) 读取开关量、反馈、允许状态或状态位。数据缺失或不可用时返回 fallback，通常设为 false。

• 适合开关量、启停反馈和允许状态
• 位读取也使用该方法
• 回退值只用于页面默认显示，不代表真实采集值

var running = ReadTagBoolean("PLC_LINE01.PUMP01.RUN", false);
var ready = ReadTagBoolean("PLC_LINE01.PUMP01.STATUS[0]", false);

ReadTagInteger(name, fallback) 读取状态码、模式、步骤、计数或整型设定值，可用于状态文本和颜色映射。fallback 通常设为 0。

• 适合模式号、状态码、步骤号和计数
• 适合 Discrete Color 和 Multi-State Color 的输入
• 不要把状态码先读成字符串再自行转换

var mode = ReadTagInteger("PLC_LINE01.PUMP01.MODE", 0);
var count = ReadTagInteger("PLC_LINE01.PUMP01.COUNT", 0);

ReadTagDouble(name, fallback) 读取温度、压力、液位等连续数值，适用于 Move、Rotate、Scale 和 Range Color。fallback 通常设为 0.0。

• 适合连续数值和工程量
• 适合几何动画和区间颜色输入
• 显示单位和格式化建议在文本表达中处理

var pressure = ReadTagDouble("PLC_LINE01.PUMP01.PRESSURE", 0.0);
var level = ReadTagDouble("PLC_LINE01.PUMP01.LEVEL", 0);

ReadTagString(name, fallback) 读取配方名、批次号等文本，可直接显示或用于 Script Text 拼接。fallback 通常为空字符串。

• 适合名称、模式文案、批次号和备注
• 文本为空时应准备清晰回退显示
• 不建议用字符串读取替代布尔、整数或浮点读取

var recipe = ReadTagString("PLC_LINE01.PUMP01.RECIPE", "");
var batchNo = ReadTagString("PLC_LINE01.PUMP01.BATCH_NO", "");

ReadTagJson(name, fallback) 读取对象或数组。fallback 须符合页面所需结构，如空数组或空对象。

• JSON 数组：表格行、趋势摘要、分页结果
• JSON 对象：页面配置、设备摘要、统计结果
• 默认值应与页面使用方式一致

var rows = ReadTagJson("PLC_LINE01.REPORT01.ROWS", []);
var config = ReadTagJson("PLC_LINE01.REPORT01.PAGE_CONFIG", {});

ReadTagDateTime(name, fallback) 读取更新、确认、批次等时间。fallback 可为 null 或默认时间；按页面语言和项目要求格式化。

• 适合更新时间、确认时间和事件时间
• 无时间值时可以返回 null
• 格式化应放在文本表达或页面函数中

var updatedAt = ReadTagDateTime("PLC_LINE01.PUMP01.UpdatedAt", null);
var confirmedAt = ReadTagDateTime("PLC_LINE01.PUMP01.CONFIRMED_AT", null);

完整点名为 device.tag，不含空格。整数位读取使用 TAG[bit]，如 PLC_LINE01.PUMP01.STATUS[0]。bit 为 0–31，且须小于父 Tag 位宽；16 位数据仅支持 0–15，[0] 为最低位。可用于 ReadTagBoolean、State Color 或布尔表达式。

• 完整点名：`PLC_LINE01.PUMP01.STATUS`
• 语法模板：`TAG[bit]` / `PLC_LINE01.PUMP01.TAG[0]`
• 读取最低位：`PLC_LINE01.PUMP01.STATUS[0]`
• 读取第 31 位：`PLC_LINE01.PUMP01.STATUS[31]`
• 模板写法：`'<PLC>.<STATUS_TAG>[3]'`
• 位索引范围为 0 到 31

var ready = ReadTagBoolean("PLC_LINE01.PUMP01.STATUS[0]", false);
var fault = ReadTagBoolean("PLC_LINE01.PUMP01.STATUS[3]", false);

ReadTagQuality(name, fallback) 返回数据质量，不代表业务或报警状态。可据此显示灰态、边框、提示或隐藏对象。

• 质量状态不是工艺值
• 质量异常不等同于业务报警
• 只返回 good 或 bad；建议 fallback 使用 bad
• 质量文本适合用于提示和诊断显示

var quality = ReadTagQuality("PLC_LINE01.PUMP01.PRESSURE", "bad");
var text = quality === "good" ? "数据可用" : "数据待确认";

ReadTagQualityGood(name) 返回质量是否为 good，可用于 Condition、Visibility 或显示表达式。质量异常时显示回退提示，不将回退值当作实时值。

• 返回 true / false
• 适合控制显隐、禁用、颜色和边框
• 质量不是 good 时，应按数据不可确认处理

var qualityGood = ReadTagQualityGood("PLC_LINE01.PUMP01.PRESSURE");
var displayText = qualityGood ? ReadTagDouble("PLC_LINE01.PUMP01.PRESSURE", 0).toFixed(1) : "--";

WriteTagBoolean(name, value, options) 写入布尔命令；options 可携带权限、确认和审计上下文。也可使用 Write Tag 行为或 hqVisuDesigner.WriteTag(payload)。关键写入由用户操作触发，并核对宿主结果。

• 适合启停、允许、复位和确认
• value 应为 true / false
• 最终写入结果由运行端和宿主机确认

WriteTagBoolean("PLC_LINE01.PUMP01.START", true);
WriteTagBoolean("PLC_LINE01.PUMP01.RESET", true);

WriteTagInteger(name, value, options) 写入模式、步骤、枚举或整型设定值；options 提供权限和确认上下文。值须符合目标类型与现场约定，状态码使用整数。

• 适合模式号、步骤号和枚举值
• value 应为整数
• 写入前应确认目标 Tag 支持该取值范围

WriteTagInteger("PLC_LINE01.PUMP01.MODE", 2);
WriteTagInteger("PLC_LINE01.PUMP01.STEP", 10);

`WriteTagDouble(name, value)` 用于写入设定值、比例、速度、温度、压力等连续数值。页面输入值应先完成范围、单位和格式处理，再提交写入。

• 适合设定值和连续工程量
• value 应为数字
• 输入框写值前应处理单位、上下限和空值

WriteTagDouble("PLC_LINE01.PUMP01.SETPOINT", 12.5);
WriteTagDouble("PLC_LINE01.PUMP01.SPEED_SET", 80);

`WriteTagString(name, value)` 用于写入配方名、批次号、备注和文本参数。写入前应确认文本长度、允许字符和目标系统处理方式，避免把显示文案误写为设备控制值。

• 适合配方名、批次号和备注
• value 应为字符串
• 文本输入应先处理空值和长度

WriteTagString("PLC_LINE01.PUMP01.RECIPE", "RCP-001");
WriteTagString("PLC_LINE01.PUMP01.REMARK", "READY");

`WriteTagJson(name, value)` 用于写入结构化参数、组合输入结果、页面配置或报表条件。结构应保持稳定，字段名应与运行端或脚本约定一致。

• 适合结构化参数和组合输入
• value 可以是对象或数组
• 字段结构应稳定，便于运行端处理

WriteTagJson("PLC_LINE01.PUMP01.PARAMS", {
  speed: 80,
  enabled: true
});

WriteTagDateTime(name, value) 写入操作、批次等时间。value 可为 new Date() 或运行端认可的时间值；须符合项目时区和记录规则。

• 适合确认时间、操作时间和批次时间
• value 可使用 Date 对象
• 关键记录仍应由运行端审计链路确认

WriteTagDateTime("PLC_LINE01.PUMP01.CONFIRMED_AT", new Date());
WriteTagDateTime("PLC_LINE01.PUMP01.BATCH_START", new Date());

hqVisuDesigner.WriteTag(payload) 或全局 WriteTag(payload) 接收目标、值、权限、确认和审计信息。类型化写入方法也支持 options，均由宿主处理。

• 适合权限、确认、审计类写入
• 适合正式项目关键操作
• 字段越明确，宿主机越容易按规则接管

hqVisuDesigner.WriteTag({
  TagName: "PLC_LINE01.PUMP01.CMD",
  Value: 1,
  PermissionCode: "io:write",
  RequireConfirm: true,
  ConfirmText: "确认发送启动命令？"
});

页面提供 TagName、Value、PermissionCode、RequireConfirm、ConfirmText、RequireReason、AuditAction 等字段；运行端执行权限校验、确认、原因输入、审计并返回异步结果。关键写入须由用户操作触发，不能随页面加载下发。

• TagName：目标完整 Tag 点名
• Value：要写入的值
• PermissionCode：运行端权限码
• RequireConfirm / ConfirmText：确认提示
• RequireReason：要求填写原因
• AuditAction：审计动作名称

hqVisuDesigner.WriteTag({
  TagName: "PLC_LINE01.PUMP01.CMD_START",
  Value: true,
  PermissionCode: "io:write",
  RequireConfirm: true,
  ConfirmText: "确认启动设备？",
  RequireReason: true,
  AuditAction: "device-start"
});

ReadCalculatedTag(name, fallbackValue?) 及其 hqVisuDesigner 同名方法读取已发布计算 Tag，保留 0 和 false。不可用时返回 fallbackValue，省略则返回 null。

var totalFlow = ReadCalculatedTag("Line01TotalFlow", null);
var ready = ReadCalculatedTag("Line01Ready", false);

CALCULATED_TAG 填 Line01TotalFlow；Setup Script 保存名称并读取，Display Text 引用结果。计算 Tag 不可写入。

// Setup Script
var calculatedTagName = "<CALCULATED_TAG>";
var totalFlow = ReadCalculatedTag(calculatedTagName, null);

// Display Text
totalFlow === null ? "--" : totalFlow.toFixed(1) + " m³/h"

计算 Tag 不支持写入或位后缀，仅读取来源正确且质量为 good 的结果，不回退到同名普通 Tag。不可用时显示提示，并检查名称、发布、权限和订阅。

findComponent(nameOrId) 返回真实 DOM，用于改样式；getComponentData(nameOrId) 返回导出数据，用于读取原始位置、尺寸、角度和元信息。

• 想直接改样式时先用 findComponent
• 想读导出数据时再用 getComponentData
• 对象名建议尽量稳定，方便脚本查找

var titleEl = hqVisuDesigner.findComponent("Title 1");
var titleData = hqVisuDesigner.getComponentData("Title 1");

if (titleEl && titleData) {
  titleEl.style.color = "#e11d48";
  hqVisuDesigner.setComponentLayout("Title 1", { width: titleData.width });
}

这是最常用的一组页面修改方法。它们适合在页面脚本、点击脚本和质量判断中快速改变对象显示效果，而不需要自行处理 DOM 细节。

• 改字用 setComponentText
• 改填充用 setComponentFill
• 改边框用 setComponentBorder
• 显隐控制用 setComponentVisible

hqVisuDesigner.setComponentText("Title 1", "READY");
hqVisuDesigner.setComponentFill("PumpBody", "#16a34a");
hqVisuDesigner.setComponentBorder("PumpBody", "#166534");
hqVisuDesigner.setComponentVisible("AlarmIcon", false);

当目标组件的位置、尺寸或角度需要根据运行状态计算时，可使用 setComponentLayout 调整布局。适用于拖动结果回写、特殊定位和多个条件共同决定布局的场景。

• x / y 控位置
• width / height 控尺寸
• angle 控角度
• 只改局部字段时也可以只传需要修改的字段

hqVisuDesigner.setComponentLayout("Rectangle 1", {
  x: 120,
  y: 80,
  width: 260,
  height: 100,
  angle: 0
});

同包跳转用 openPage，跨包用 openScreen，外部站点用 openWebsite。useLanguage 切换语言，refreshView 重新应用页面状态。

• 同包跳转用 openPage
• 跨包跳转用 openScreen
• 外部网址用 openWebsite
• 语言切换用 useLanguage
• 重新应用页面状态用 refreshView

hqVisuDesigner.openPage("Alarm");
hqVisuDesigner.openScreen("PUMP_OVERVIEW");
hqVisuDesigner.useLanguage("zh-CN");
hqVisuDesigner.refreshView();

页面需要记录当前 tab、当前选中设备或最近一次交互动作时，可以写入页面变量。该方法只适合页面联动，不等同于写 PLC，也不应代替正式 Tag 写值。

• 适合切换 tab、筛选状态和当前选择
• 不适合设备控制
• 正式设备写入仍应使用 Write Tag 或写值动作

hqVisuDesigner.writeVariable("currentTab", "alarm");
hqVisuDesigner.writeVariable("selectedDevice", "Pump01");

ReadBrowserStorage、WriteBrowserStorage 和 RemoveBrowserStorage 保存区域选择、折叠状态等页面偏好。不要用浏览器存储保存设备控制状态、关键业务数据或长期审计记录。

• 适合界面偏好和当前选择
• 不适合作为设备控制链路
• 不适合保存关键业务记录

var area = ReadBrowserStorage("selectedArea", "A01", "local");
WriteBrowserStorage("selectedArea", area, "local");
RemoveBrowserStorage("selectedArea", "local");

这是典型页面脚本组合：先从当前页 Page Script 准备好的变量取值，再直接更新页面标题对象。相比将标题固定在 PPT 对象中，该方式更便于按页面上下文维护。

window.hqVisuDesignerPageReady = function() {
  var title = window.panelTitle || "未命名页面";
  hqVisuDesigner.setComponentText("PageTitle", title);
};

这个组合适合设备状态提示。先用 ReadTagQualityGood 判断质量，再同时修改边框和提示图标显隐。

var qualityGood = ReadTagQualityGood("PLC_LINE01.PUMP01.RUN");
hqVisuDesigner.setComponentBorder("PumpBody", qualityGood ? "#0f172a" : "#f97316");
hqVisuDesigner.setComponentVisible("QualityBadge", !qualityGood);

部分动作除了写 Tag，还需要页面同步记录本次操作已经触发。此时可以先写页面变量，再调用写值方法。

hqVisuDesigner.writeVariable("lastAction", "start");
WriteTagBoolean("PLC_LINE01.PUMP01.START", true);

template.getValue(...) 读取输入模板当前值，供脚本校验、写入或跳转。参数是带引号的实例名，如 template.getValue("Input Template")。

var inputValue = template.getValue("Input Template");
if (inputValue !== "") {
  WriteTagString("PLC_LINE01.PUMP01.RECIPE", inputValue);
}