外观
lib-finNetwork 库参考
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793423215/FIN+5.3.1+lib-finNetwork 中文整理基于 FIN 5.3.1
导读： FIN 网络扩展
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
- lib
- meta
- finSettings
- finDropOverrides
- funcs
- def
- supertypes
- tags
- enum
- deviceOverview()
- src
- finNetworkBasicDragDrop(treeTag, treeRootId, targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
- finNetworkConnectorsDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
- finNetworkDragDrop(srcIds, srcRemotes, srcTree, destId, destRemote, destTree)
- finNetworkEquipDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
- finNetworkSettingsDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
- finNetworkSnapshotsDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
- finNetworkSyncUsers(conns)
- finNetworkTopicDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees, topicOns: [,])
- finNetworkTransferRecords(recs, from, to, makeDiffFn: null, binResolveFn: null)
- finNetworkTree(isNext: null, conn: null, expr: null)
概述（中译）
FIN 网络扩展
API 正文（英文）
finSettings
| alarmSyncEnable | Enables or disables the alarm sync module |
| alarmSyncFilter | Which alarms should be synced to the project |
| snapshotSyncEnable | Enables or disables the snapshot sync module |
| snapshotSyncExclude | Which FIN Network nodes to exclude from the sync |
| snapshotSyncFreq | When the snapshots get synced to the project |
| snapshotSyncNow | Will execute the snapshot sync task immediately |
finDropOverrides
| finNetworkTree___connTuning | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___connectors | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___equipTree | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___finSettingsTree | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___finSnapshotsTree | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___graphics | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___job | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___programs | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___relationship | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___savedQueryFilter | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___schedules | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___tagBundle | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___template | Feature namespace of definitions formatted as feature:name |
| finNetworkTree___topic | Feature namespace of definitions formatted as feature:name |
funcs
| deviceOverview | Axon function |
| finNetworkBasicDragDrop | Exposes the functionality for basic drag and drop, like for programs and schedules and jobs |
| finNetworkConnectorsDragDrop | Exposes the functionality for the connector tree drag and drop system |
| finNetworkDragDrop | |
| finNetworkEquipDragDrop | Exposes the functionality for the equip tree drag and drop system |
| finNetworkSettingsDragDrop | Exposes the functionality for the settings tree drag and drop system |
| finNetworkSnapshotsDragDrop | Exposes the functionality for the snapshots tree drag and drop system |
| finNetworkSyncUsers | Takes a conn or list of conns (in a format used by toRecList) and syncs the users over to the children |
| finNetworkTopicDragDrop | |
| finNetworkTransferRecords | |
| finNetworkTree |
def
finDropOverride:finNetworkTree___connTuning
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___connTuning |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___connectors
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___connectors |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___equipTree
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___equipTree |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___finSettingsTree
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___finSettingsTree |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___finSnapshotsTree
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___finSnapshotsTree |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___graphics
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___graphics |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___job
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___job |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___programs
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___programs |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___relationship
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___relationship |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___savedQueryFilter
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___savedQueryFilter |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___schedules
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___schedules |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___tagBundle
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___tagBundle |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___template
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___template |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finDropOverride:finNetworkTree___topic
Feature namespace of definitions formatted as feature:name
meta
| def | finDropOverride:finNetworkTree___topic |
| finInteraction | {type:js, action:let finNetworkRemotes = {{args.dragSource[finNetworkRemo...} |
| is | finDropOverride |
| lib | lib:finNetwork |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| finDropOverride | Feature namespace of definitions formatted as feature:name |
tags
| finInteraction | Map of name/value tag pairs |
def
finSetting:alarmSyncEnable
Enables or disables the alarm sync module
meta
| def | finSetting:alarmSyncEnable |
| defVal | false |
| dis | Enable Alarm Sync |
| enum | See below |
| is | finSetting |
| kind | Bool |
| lib | lib:finNetwork |
| order | sync:0 |
enum
| Disabled | |
| Enabled |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:alarmSyncFilter
Which alarms should be synced to the project
meta
| def | finSetting:alarmSyncFilter |
| defVal | id |
| dis | Alarm Sync Filter |
| is | finSetting |
| kind | Str |
| lib | lib:finNetwork |
| order | sync:1 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:snapshotSyncEnable
Enables or disables the snapshot sync module
meta
| def | finSetting:snapshotSyncEnable |
| defVal | false |
| dis | Enable Snapshot Sync |
| enum | See below |
| is | finSetting |
| kind | Bool |
| lib | lib:finNetwork |
| order | sync:0 |
enum
| Disabled | |
| Enabled |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:snapshotSyncExclude
Which FIN Network nodes to exclude from the sync
meta
| def | finSetting:snapshotSyncExclude |
| dis | Snapshot Sync Exclusions |
| filter | finNetwork and haystackConn |
| is | finSetting |
| kind | Ref[] |
| lib | lib:finNetwork |
| order | sync:3 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:snapshotSyncFreq
When the snapshots get synced to the project
meta
| def | finSetting:snapshotSyncFreq |
| defVal | |
| dis | Snapshot Sync Frequency |
| is | finSetting |
| kind | Dict |
| lib | lib:finNetwork |
| order | sync:2 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
finSetting:snapshotSyncNow
Will execute the snapshot sync task immediately
meta
| def | finSetting:snapshotSyncNow |
| defVal | ✓ |
| dis | Run Snapshot Sync |
| is | finSetting |
| kind | Marker |
| lib | lib:finNetwork |
| order | sync:1 |
tags
| admin | Requires admin permission |
| defVal | Default value |
| dis | Display name for an entity |
| enum | Defines an eumeration of string key names |
| kind | Kind name used to identity a value data type |
| order | Used to order definitions |
| su | Requires superuser permission |
| unit | Unit identifier from standard unit database |
def
func:deviceOverview
deviceOverview()
Axon function
meta
| def | func:deviceOverview |
| finStackMobileMenu | ✓ |
| is | func |
| lib | lib:finNetwork |
| name | deviceOverview |
| overridable | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
src
() => do
[{
action: "top.app.LoadApplication('/pod/finNetworkExt/index.html');",
appId: "deviceOverview",
displayName: toLocale("finNetworkExt::deviceOverview"),
hasBadge: false,
icon: "icon-device-desktop",
iconType: "class",
level: 0,
link: "#dashboard",
order: 3,
ui: "html"
}].toGrid
enddef
func:finNetworkBasicDragDrop
finNetworkBasicDragDrop(treeTag, treeRootId, targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
Exposes the functionality for basic drag and drop, like for programs and schedules and jobs
meta
| def | func:finNetworkBasicDragDrop |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkBasicDragDrop |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNetworkConnectorsDragDrop
finNetworkConnectorsDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
Exposes the functionality for the connector tree drag and drop system
meta
| def | func:finNetworkConnectorsDragDrop |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkConnectorsDragDrop |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNetworkDragDrop
finNetworkDragDrop(srcIds, srcRemotes, srcTree, destId, destRemote, destTree)
meta
| def | func:finNetworkDragDrop |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkDragDrop |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNetworkEquipDragDrop
finNetworkEquipDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
Exposes the functionality for the equip tree drag and drop system
meta
| def | func:finNetworkEquipDragDrop |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkEquipDragDrop |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNetworkSettingsDragDrop
finNetworkSettingsDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
Exposes the functionality for the settings tree drag and drop system
meta
| def | func:finNetworkSettingsDragDrop |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkSettingsDragDrop |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNetworkSnapshotsDragDrop
finNetworkSnapshotsDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees)
Exposes the functionality for the snapshots tree drag and drop system
meta
| def | func:finNetworkSnapshotsDragDrop |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkSnapshotsDragDrop |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNetworkSyncUsers
finNetworkSyncUsers(conns)
Takes a conn or list of conns (in a format used by toRecList) and syncs the users over to the children
meta
| admin | ✓ |
| def | func:finNetworkSyncUsers |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkSyncUsers |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNetworkTopicDragDrop
finNetworkTopicDragDrop(targetId, targetRemote, targetTree, sourceIds, sourceRemotes, sourceTrees, topicOns: [,])
meta
| def | func:finNetworkTopicDragDrop |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkTopicDragDrop |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNetworkTransferRecords
finNetworkTransferRecords(recs, from, to, makeDiffFn: null, binResolveFn: null)
meta
| def | func:finNetworkTransferRecords |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkTransferRecords |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNetworkTree
finNetworkTree(isNext: null, conn: null, expr: null)
meta
| admin | ✓ |
| def | func:finNetworkTree |
| finNavTree | ✓ |
| is | func |
| lib | lib:finNetwork |
| name | finNetworkTree |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |