• 文档
  • URL 参数说明

URL 参数说明


在配置统一监测的菜单时，应用构建者可以在 URL 中填写参数来实现特定效果。本文介绍统一监测各个功能支持的　URL 参数。

URL 参数格式


在 URL 中添加参数时需要遵循特定格式，其中：

  • 资产概览、资产列表、曲线工具以及通用指标查询的 URL 参数格式为 ?参数名1=参数值1&参数名2=参数值2。
  • 可配置页面的 URL 参数格式分为以下组成部分：
    • DTV 页面 URL 参数格式：?dt=DTV页面发布时生成的URL。此参数为可配置页面菜单的必填参数。
    • 其他参数格式："参数名1":"参数值1","参数名2":[{"子参数名1":"子参数值1","子参数名2":"子参数值2"}, {"子参数名3":"子参数值3","子参数名4":"子参数值4"}]。

资产概览参数


资产概览的默认 URL 为：/encompass-monitor-hmi/#/portfolio/runtime。你可以在 # 前添加 URL 参数。例如： 添加 solarSiteEnlightIframe 参数并输入 true 作为其参数值后资产概览的 URL 地址变为 /encompass-monitor-hmi/?solarSiteEnlightIframe=true#/portfolio/runtime。资产概览菜单 URL 支持的参数如下所示。


参数名 必填/可选 描述
disablePageJump 可选
  • 选择资产地图中的图标跳转到指定 URL 地址。
  • 输入 true 启用此功能，或 false 禁用此功能。
defaultNodeId 可选
  • 资产概览页面默认展示的资产信息。
  • 输入资产 ID 指定默认展示的资产。如需获取资产 ID，联系系统管理员。
assetSticky 可选
  • 打开资产概览页面时显示上一次访问的资产信息。
  • 输入 solar 启用此功能，或不输入参数值禁用此功能。

资产列表参数


资产列表的默认 URL 为：/encompass-monitor-hmi/#/asset-list。你可以在 # 前添加 URL 参数。例如： 添加 timeTypes 与 siteTypes 参数并分别输入 realtime 与 EnOS_Solar_Site 作为其参数值后资产列表的 URL 地址变为 /encompass-monitor-hmi/?timeTypes=realtime&siteTypes=EnOS_Wind_Farm,EnOS_Solar_Site#/asset-list。资产列表菜单 URL 支持的参数如下所示。


参数名 必填/可选 描述
assetScope 可选
  • 资产列表的类型。
  • 输入 device 代表设备列表、site 代表场站列表或 region 代表区域列表。
timeTypes 可选
  • 当前资产列表页面支持的数据类型。
  • 输入 history 代表支持历史数据、realtime 代表支持实时数据或 realtime_history 代表支持通过切换按钮切换历史数据和实时数据。
layoutTypes 可选
  • 当前资产列表页面支持的视图。
  • 输入 table、 block 或 table,block，分别代表仅支持列表视图、仅卡片视图以及支持列表和卡片视图。
siteTypes 可选
  • 当前资产列表页面支持的资产类型及资产类型的展示顺序
  • 输入资产类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
enableBlockChart 可选
  • 是否在卡片视图下展示数据曲线。
  • 输入 true 展示数据曲线，输入 false 禁用数据曲线。
siteTypes 可选
  • 当前资产列表页面支持的场站类型，默认支持本 OU 所有场站类型。
  • 输入场站类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
deviceTypes 可选
  • 当前资产列表页面支持的设备类型，默认支持本 OU 所有设备类型。
  • 输入设备类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
filterByDomain 可选
  • 是否在场站类型筛选器展示领域名或类型名。
  • 输入 true 展示领域名或类型名，输入 false 不展示领域名或类型名。
srTypes 可选
  • 支持在当前资产列表页面发送服务请求（SR）的设备类型，默认所有设备均不可发送服务请求。
  • 输入设备类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
controlTypes 可选
  • 支持在当前资产列表页面进行批量控制的设备类型，默认所有设备均不支持批量控制。
  • 输入设备类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
controlMaxNum 可选
  • 批量控制单次最多可控制的设备数量。
  • 输入正整数作为参数值。
showDeviceHierarchy 可选
  • 是否在设备列表中展示用于筛选设备的拓扑结构筛选器。
  • 输入 true 展示拓扑结构筛选器，输入 false 不展示拓扑结构筛选器。
showTime 可选
  • 是否在页面底部显示当前时间和数据刷新时间。
  • 输入 true 展示时间，输入 false 不展示时间。
assetSticky 可选
  • 打开资产概览页面时显示上一次访问的资产信息。
  • 输入 solar 启用此功能，或不输入参数值禁用此功能。
filterByDomain 可选
  • 是否在场站类型筛选器中通过领域或通过资产树节点筛选场站。
  • 输入 true 可以通过领域或资产树节点筛选场站，输入 false 不可通过领域或资产树节点筛选场站。
summaryPosition 可选
  • 选择汇总行在列表中的位置。
  • 输入 bottom 在表格最后一行展示汇总行，top 在表格第一行展示汇总行，或 false，不展示汇总行。
showSummaryTitle 可选
  • 是否显示汇总行标题，如“求和”、“公式”等。
  • 输入 true 展示汇总行标题，输入 false 不展示汇总行标题。
state 可选
  • 配置从其他页面跳转到资产列表页面时的默认展示状态。
  • 包含以下子参数：defaultSiteTypes, defaultDeviceType, nodeIds, deviceNodeIds, cardFilter, showFilter。子参数以键值对形式出现且用 & 分隔，例如：state=defaultSiteTypes%3D{mdmType}%26nodeIds%3D{nodeId}%26cardFilter%3DGenSiteState*2。
defaultSiteTypes 可选
  • state 参数的子参数，默认选中的场站类型。
  • 输入场站类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
defaultDeviceType 可选
  • state 参数的子参数。默认选中的设备类型。
  • 输入设备类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
nodeIds 可选
  • state 参数的子参数。默认选中的节点 ID。
  • 输入资产节点标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
deviceNodeIds 可选
  • state 参数的子参数。默认选中的设备 ID。
  • 输入设备标识符，多个标识符之间用英文逗号（,）隔开。仅在 showDeviceHierarchy 参数为 true 的情况下有效。
cardFilter 可选
  • state 参数的子参数。默认选中的筛选器。
  • 该参数形式为用“*”隔开的键值对。其中，键代表指标、测点或属性的标识符，值代表指标、测点或属性的数据。例如：GenActivePower*<2 表示选中功率小于 2000 的场站。
showFilter 可选
  • state 参数的子参数。当前资产列表页面启用的筛选器类型。
  • 可输入 siteType`（启用场站类型筛选器），`site`（启用场站筛选器），`deviceType`（启用设备类型筛选器），`deviceTopology`（启用设备拓扑结构筛选器），`timeRange`（启用时间范围筛选器），`none （禁用全部筛选器）或者留空（启用全部筛选器）。

曲线工具参数


曲线工具的默认 URL 为：/encompass-monitor-hmi/#/charting-tool。你可以在 # 前添加 URL 参数。例如： 添加 openRaw 参数并输入 true 作为其参数值后曲线工具的 URL 地址变为 /encompass-monitor-hmi/?openRaw=true#/charting-tool。曲线工具菜单 URL 支持的参数如下所示。


参数名 必填/可选 描述
openRaw 可选
  • 是否可选择 原始值 作为曲线工具页面的时间间隔。原始值为在通用数据服务注册数据项时设定的查询间隔。
  • 输入 true 可选择 原始值，输入 false 不可选择 原始值。
devciceTreeTypes 可选
  • 曲线工具页面中的设备树类型。
  • 可输入 flat 或 hierarchy，分别代表列表式设备树和层级式设备树。输入多个参数值时用半角逗号（,）隔开，曲线工具页面显示类型切换图标且默认展示第一个值对应的类型。
siteTypes 可选
  • 当前资产列表页面支持的资产类型及资产类型的展示顺序
  • 输入资产类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。

通用指标查询参数


通用指标查询的默认 URL 为：/encompass-monitor-hmi/#/metric-tool。你可以在 # 前添加 URL 参数。例如： 添加 subjects 参数并输入 site 作为其参数值后通用指标查询的 URL 地址变为 /encompass-monitor-hmi/?subjects=site#/metric-tool。通用指标查询菜单 URL 支持的参数如下所示。


参数名 必填/可选 描述
subjects 可选
  • 通用指标查询支持的资产类型，将影响配置资产列表时资产颗粒度下拉列表中的选项。
  • 可输入 device、 site 或 `deviceGroup `，分别代表设备、场站以及设备组。输入多个参数值时用半角逗号（,）隔开，通用指标查询页面将显示类型切换图标并默认展示第一个值对应的类型。
checkableSiteTypes 可选
  • 指定支持跨场站对比设备的领域。
  • 输入设备类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
siteTypes 可选
  • 当前资产列表页面支持的资产类型及资产类型的展示顺序
  • 输入资产类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
orderType 可选
  • 指定表格数据的排列顺序。
  • 输入 default 代表默认按资产树节点顺序显示场站或按字母表顺序显示设备组和设备，或 input 按自定义顺序显示。如需配置自定义显示顺序，联系系统管理员。
devciceTreeTypes 可选
  • 通用指标查询支持的设备树类型。
  • 输入 flat 代表列表式设备树，或 hierarchy 代表层级式设备树。输入多个参数值时用半角逗号（,）隔开，通用指标查询页面将显示类型切换图标且默认展示第一个值对应的类型。
bigDataMdmTypes 可选
  • 指定查询特定领域的设备时是否可全选所有设备（适用于设备数量较大的场景）。
  • 输入设备类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
groupKey 可选
  • 是否在通用指标查询中启用已配置的业务对象分组。
  • 输入 Metric_Tool 启用已配置的业务对象分组，或不指定参数值禁用此功能。

可配置页面参数


可配置页面的默认 URL 为：/encom-landing-page/?url=&landingpage={}。一个典型的可配置页面 URL 示例如下。


/encom-landing-page/?url=/dt/encompass/page/2c3e40eb-821d-4224-bae2&landingpage={"theme": "dark","welcome":true, "dtvOptions":{},"filters":[{"type":"asset","siteTypes":"EnOS_Wind_Farm,EnOS_Solar_Site","checkable":true,"aggTypes": "region","show":false}, {"type":"time","format": "YYYY-MM-DD HH:mm:ss","range":true,"showRange":true,"showInterval":true,"showShortcut":true}]}


其中，url 参数为必填项，且此处其参数值为 /dt/encompass/page/2c3e40eb-821d-4224-bae2。可配置页面菜单 URL 支持的参数如下所示。


参数名 必填/可选 描述
url 必填 发布数字孪生可视化页面时生成的 URL。
welcome 可选
  • 是否显示问候语。
  • 输入 true 显示问候语，输入 false 禁用问候语。
theme 可选
  • 选择页面主题。
  • 输入 dark 为神色主题，或 `workbench`跟随当前应用门户主题。
title 可选
  • 可配置页面的标题。
  • 支持填写文字或代表当前场站或区域名称的 ${nodeName} 参数。
dtvOptions 可选
  • 数字孪生可视化组件模板的标签。可配置页面可从数字孪生可视化中同步带有特定标签的组件模板。
  • 输入数字孪生可视化组件模板的标签。若无需从数字孪生可视化中同步组件模板，可将函数值留空。
controlOptions 可选
  • 是否在可配置页面中展示用于控制设备资产的控制按钮。
  • 输入 “show”: false 禁用控制按钮，输入 {} 展示控制按钮。
filters 必填 设置可配置页面筛选器的参数。其形式为包含多个子参数的数组。
type 必填
  • filters 参数的子参数，指定筛选器类型。
  • 输入 asset 代表资产筛选器，或 time 代表时间筛选器。
navModel 可选
  • filters 参数的子参数，指定筛选器位置。
  • 输入 unifiedAssetTree 将筛选器展示在页面左侧，或不指定参数值将筛选器展示在页面顶部。
assetTypes 可选
  • filters 参数的子参数，指定设备类型。默认支持当前 OU 中的全部设备类型。
  • 输入设备类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
checkable 可选
  • filters 参数的子参数，是否支持选择多个场站。
  • 输入 true 可选择多个场站，输入 false 不可选择多个场站。
aggTypes 可选
  • filters 参数的子参数，指定当前资产树的资产层级。
  • 输入 site 代表场站维度，或 region 代表区域维度。
deviceTypes 可选
  • filters 参数的子参数，指定当前页面设备筛选器支持的设备类型。
  • 输入设备类型标识符，多个标识符之间用英文逗号（,）隔开。如需获取此标识符，联系系统管理员。
deviceCheckable 可选
  • filters 参数的子参数，是否支持选择多个设备。
  • 输入 true 可选择多个设备，输入 false 不可选择多个设备。
deviceTreeType 可选
  • filters 参数的子参数，资产树的显示方式。
  • 输入 flat 以列表形式展示资产树，或 hierarchy 以拓扑形式展示资产树。
assetSticky 可选
  • 打开可配置页面时显示上一次访问的资产信息。
  • 输入 solar 启用此功能，或不指定参数值禁用此功能。
show 可选
  • filters 参数的子参数，是否显示筛选器。
  • 输入 true 显示筛选器，输入 false 禁用筛选器。
defaultNodeIds 可选
  • filters 参数的子参数，场站或区域中默认选中的节点。
  • 若为空，则默认选中全部节点；若为 _first_，则默认选中第一个节点；或输入目标场站或区域节点的标识符。如需获取此标识符，联系系统管理员。
format 可选
  • filters 参数的子参数，指定时间筛选器的时间格式。
  • 输入 YYYY-MM-DD HH:mm:ss 或 YYYY-MM-DD。
showRange 可选
  • filters 参数的子参数，设置时间的选择方式为选择时间范围或选择起止时间点。
  • 输入 true 代表起止时间点，或 false 代表选择时间范围。
showShortcut 可选
  • filters 参数的子参数，是否显示快捷时间按钮。
  • 输入 true 显示快捷时间按钮，或 false 禁用快捷时间按钮。
showInterval 可选
  • filters 参数的子参数，是否显示时间间隔选择器。
  • 输入 true 显示时间间隔筛选器，或 false 禁用时间间隔筛选器。
defaultShortcut 可选
  • filters 参数的子参数，默认选中的时间快捷方式。
  • 可输入 YDA（昨日）、TD（今日）、WTD（当周）、7d（最近 7 天）、MTD（当月）、30d（最近 30 天）、QTD（当季）、6m（最近 6 月）、12m （最近 1 年）、YTD（当年） 或 3y（最近 3 年）。
minStartTime 可选
  • filters 参数的子参数，时间选择器的最早时间，以天为单位。
  • 例如：最早支持 90 天前即为“-90d”。
maxEndTime 可选
  • filters 参数的子参数，时间选择器的最晚时间，以天为单位。
  • 例如：最晚支持当日即为“+0d”。