外观
lib-finStackCore 库参考
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793455784/FIN+5.3.1+lib-finStackCore 中文整理基于 FIN 5.3.1
导读： 本页为
lib-finStackCore的 API / 标签 / 函数参考文档。
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
- lib
- meta
- funcs
- def
- addNavURI(list)
- finActionsOn(target)
- finAddShadowPoints(source, options: null)
- finBackupRecord(recs, ops: ..., primaryTag: "equip")
- finCheckForUpdate()
- finContentOn(target)
- finContext()
- finFileToSnapshot(fileRef)
- finFindDuplicateIdsInBackup(backup, ops: Etc.makeDict(["relTo":"/"]))
- finGenScram()
- finGetAllPodDocs()
- finGetAllPodNames()
- finGetFinDocsForPodWithName(podName)
- finGraphicOn(target, queryRelated: false)
- finGridFilter(target, filterExpr)
- finHisRead(hisRefs, dates, opts: null)
- finImportGrid(grid, newIds: true, oldNewIDMap: [:], parent: null, includeOptionalNavMeta: false)
- finMigrateFilterIds(filter: "id")
- finNavChildren(treeName, baseRef: null, opts: null, filterSubEquipment: false, checkTaskAndVars: false)
- finParseModBus32(value)
- finPointConn(grid)
- finProgramOn(target)
- finReadBinTag(recId, tagName)
- finReadById(recId)
- finReadByIds(ids)
- finReadGraphicPoints(pointFilters, queries, filterIsNavName: false, targetRef: null, resolveRequestBinding: false, treeName: "equip")
- finReadPoints(filters, filterIsNavName: false, targetId: null, resolveRequestBinding: false, resolveShadowPoints: true, treeName: "equip")
- finRestoreFile(file, ops: ..., keepIds: false, parent: null)
- finRestoreRecord(rec, ops: ..., keepIds: false, parent: null)
- finSetSuperUserPassword(oldPassword, newPassword)
- finShadowPointToPoint(shadowRef, refOnly: false)
- finSkySparkApps()
- finSkySparkViewsForApp(appName)
- finSummaryOn(target)
- finTasks(programRef: null, targetRef: null)
- finTuningPolicies(targets)
- finUpdate(fileId: null)
- finUpdateLicense(fileRef)
- finWriteBinTag(recId, tagName, handle, mimeType: "text/plain")
- firstRun()
- firstRunComplete()
- fromJSON(value)
- getNavURI(recId, treeName: "equip")
- gridToZinc(grid)
- migrateGetFileUrl(original, projectName)
- migrateRef(original, projectName)
- toJSON(item, complexNumbers: false)
概述（中译）
FIN 主机服务
API 正文（英文）
funcs
| addNavURI | |
| finActionsOn | Get all Actions which are registered on the given target |
| finAddShadowPoints | |
| finBackupRecord | Export all the related records referencing the recs parameter The recs can be a single id or a list of ids By default this will be an equip, but users can pass any record and specify the primaryTag that defines the entity for this record |
| finCheckForUpdate | |
| finContentOn | Get all O&M Manuals which are registered on the given target |
| finContext | |
| finFileToSnapshot | |
| finFindDuplicateIdsInBackup | Looks inside a file for clashing IDs and returns a list duplicates |
| finGenScram | |
| finGetAllPodDocs | |
| finGetAllPodNames | |
| finGetFinDocsForPodWithName | |
| finGraphicOn | Get all Fin graphics which are registered on the given target |
| finGridFilter | Filters a grid using a filter expression |
| finHisRead | |
| finImportGrid | Imports the grid in the local server |
| finMigrateFilterIds | |
| finNavChildren | |
| finParseModBus32 | |
| finPointConn | |
| finProgramOn | Get all Programs which are registered on the given target |
| finReadBinTag | FIN Read Binary Tag This function will read the data in the given tag on the given record this function will return a Str if the tag has text data and will return a handle for all other types |
| finReadById | |
| finReadByIds | |
| finReadGraphicPoints | |
| finReadPoints | |
| finRestoreFile | Restores a FinStack template file |
| finRestoreRecord | Import equip from a zip backup stored on the record Params |
| finSetSuperUserPassword | |
| finShadowPointToPoint | |
| finSkySparkApps | Returns all SkySpark Apps |
| finSkySparkViewsForApp | Returns all Views for a SkySpark app name |
| finSummaryOn | Get all Summaries which are registered on the given target |
| finTasks | |
| finTuningPolicies | Get all tuning policies which are registered on the given target |
| finUpdate | |
| finUpdateLicense | |
| finWriteBinTag | FIN Write Binary Tag This function writes the data described by the handle to the given bin tag on the requested record |
| firstRun | |
| firstRunComplete | |
| fromJSON | |
| getNavURI | |
| gridToZinc | |
| migrateGetFileUrl | Allows you to change the project name on a getFinFile url /getFinFile/projectA -> /getfinFile/projectB @param original Original getFinFile URL @param projectName New project name to point the url to @return getFinFile URL that queries the project specified by the projectName |
| migrateRef | Allows you to change the project name on an absolute or relative reference @p:projectA:r:1234-5678 -> @p:projectB:r:1234-5678 or @1234-5678 -> @p:projectB:r:1234-5678 @param original Original Reference @param projectName New project name to point the reference to @return reference that points to the project specified by the projectName |
| toJSON |
def
func:addNavURI
addNavURI(list)
meta
| def | func:addNavURI |
| is | func |
| lib | lib:finStackCore |
| name | addNavURI |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finActionsOn
finActionsOn(target)
Get all Actions which are registered on the given target. The target may be any value accepted by toRec().
meta
| def | func:finActionsOn |
| is | func |
| lib | lib:finStackCore |
| name | finActionsOn |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finAddShadowPoints
finAddShadowPoints(source, options: null)
meta
| def | func:finAddShadowPoints |
| is | func |
| lib | lib:finStackCore |
| name | finAddShadowPoints |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finBackupRecord
finBackupRecord(recs, ops: ..., primaryTag: "equip")
Export all the related records referencing the recs parameter The recs can be a single id or a list of ids By default this will be an equip, but users can pass any record and specify the primaryTag that defines the entity for this record. Params are:
rec: ref or record to an equip
options: a optional dict that lists the export types, i.e {references, graphics, actions, connectors, programs, applyToAll, progressStart:0, progressEnd:100} Users can use {all} to use all options, or {everything} that maps to
primaryTag: an optional string, defaults to
equipbut can be customizale by the user by default the functions tries to find this based on the the equipPath tags
meta
| def | func:finBackupRecord |
| is | func |
| lib | lib:finStackCore |
| name | finBackupRecord |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finCheckForUpdate
finCheckForUpdate()
meta
| def | func:finCheckForUpdate |
| is | func |
| lib | lib:finStackCore |
| name | finCheckForUpdate |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finContentOn
finContentOn(target)
Get all O&M Manuals which are registered on the given target. The target may be any value accepted by toRec().
meta
| def | func:finContentOn |
| is | func |
| lib | lib:finStackCore |
| name | finContentOn |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finContext
finContext()
meta
| def | func:finContext |
| is | func |
| lib | lib:finStackCore |
| name | finContext |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finFileToSnapshot
finFileToSnapshot(fileRef)
meta
| def | func:finFileToSnapshot |
| is | func |
| lib | lib:finStackCore |
| name | finFileToSnapshot |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finFindDuplicateIdsInBackup
finFindDuplicateIdsInBackup(backup, ops: Etc.makeDict(["relTo":"/"]))
Looks inside a file for clashing IDs and returns a list duplicates
meta
| def | func:finFindDuplicateIdsInBackup |
| is | func |
| lib | lib:finStackCore |
| name | finFindDuplicateIdsInBackup |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finGenScram
finGenScram()
meta
| def | func:finGenScram |
| is | func |
| lib | lib:finStackCore |
| name | finGenScram |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finGetAllPodDocs
finGetAllPodDocs()
meta
| def | func:finGetAllPodDocs |
| is | func |
| lib | lib:finStackCore |
| name | finGetAllPodDocs |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finGetAllPodNames
finGetAllPodNames()
meta
| def | func:finGetAllPodNames |
| is | func |
| lib | lib:finStackCore |
| name | finGetAllPodNames |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finGetFinDocsForPodWithName
finGetFinDocsForPodWithName(podName)
meta
| def | func:finGetFinDocsForPodWithName |
| is | func |
| lib | lib:finStackCore |
| name | finGetFinDocsForPodWithName |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finGraphicOn
finGraphicOn(target, queryRelated: false)
Get all Fin graphics which are registered on the given target. The target may be any value accepted by toRec().
meta
| def | func:finGraphicOn |
| is | func |
| lib | lib:finStackCore |
| name | finGraphicOn |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finGridFilter
finGridFilter(target, filterExpr)
Filters a grid using a filter expression.
Parameters
- target: A grid to be filtered.
- filterExpr: An Axon filter expression.
Returns
- A grid containing elements that match the filterExpr.
Example
readAll(equip).finGridFilter(ahuRef and boilerRef)
meta
| def | func:finGridFilter |
| is | func |
| lib | lib:finStackCore |
| name | finGridFilter |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finHisRead
finHisRead(hisRefs, dates, opts: null)
meta
| def | func:finHisRead |
| is | func |
| lib | lib:finStackCore |
| name | finHisRead |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finImportGrid
finImportGrid(grid, newIds: true, oldNewIDMap: [:], parent: null, includeOptionalNavMeta: false)
Imports the grid in the local server. The grid is pre-processed so that it is conforming with the local navMeta. While importing all the missing required nav paths are created as mock entries
meta
| def | func:finImportGrid |
| is | func |
| lib | lib:finStackCore |
| name | finImportGrid |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finMigrateFilterIds
finMigrateFilterIds(filter: "id")
meta
| def | func:finMigrateFilterIds |
| is | func |
| lib | lib:finStackCore |
| name | finMigrateFilterIds |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finNavChildren
finNavChildren(treeName, baseRef: null, opts: null, filterSubEquipment: false, checkTaskAndVars: false)
meta
| def | func:finNavChildren |
| is | func |
| lib | lib:finStackCore |
| name | finNavChildren |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finParseModBus32
finParseModBus32(value)
meta
| def | func:finParseModBus32 |
| is | func |
| lib | lib:finStackCore |
| name | finParseModBus32 |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finPointConn
finPointConn(grid)
meta
| def | func:finPointConn |
| is | func |
| lib | lib:finStackCore |
| name | finPointConn |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finProgramOn
finProgramOn(target)
Get all Programs which are registered on the given target. The target may be any value accepted by toRec().
meta
| def | func:finProgramOn |
| is | func |
| lib | lib:finStackCore |
| name | finProgramOn |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finReadBinTag
finReadBinTag(recId, tagName)
FIN Read Binary Tag
This function will read the data in the given tag on the given record
this function will return a Str if the tag has text data and will return a handle for all other types
meta
| def | func:finReadBinTag |
| is | func |
| lib | lib:finStackCore |
| name | finReadBinTag |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finReadById
finReadById(recId)
meta
| def | func:finReadById |
| is | func |
| lib | lib:finStackCore |
| name | finReadById |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finReadByIds
finReadByIds(ids)
meta
| def | func:finReadByIds |
| is | func |
| lib | lib:finStackCore |
| name | finReadByIds |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finReadGraphicPoints
finReadGraphicPoints(pointFilters, queries, filterIsNavName: false, targetRef: null, resolveRequestBinding: false, treeName: "equip")
meta
| def | func:finReadGraphicPoints |
| is | func |
| lib | lib:finStackCore |
| name | finReadGraphicPoints |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finReadPoints
finReadPoints(filters, filterIsNavName: false, targetId: null, resolveRequestBinding: false, resolveShadowPoints: true, treeName: "equip")
meta
| def | func:finReadPoints |
| is | func |
| lib | lib:finStackCore |
| name | finReadPoints |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finRestoreFile
finRestoreFile(file, ops: ..., keepIds: false, parent: null)
Restores a FinStack template file
meta
| def | func:finRestoreFile |
| is | func |
| lib | lib:finStackCore |
| name | finRestoreFile |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finRestoreRecord
finRestoreRecord(rec, ops: ..., keepIds: false, parent: null)
Import equip from a zip backup stored on the record Params:
- rec: the record that stores a
fileBin tag that contains the actual backup - keepIds: true if the restored records should keep the original back up ids
meta
| def | func:finRestoreRecord |
| is | func |
| lib | lib:finStackCore |
| name | finRestoreRecord |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finSetSuperUserPassword
finSetSuperUserPassword(oldPassword, newPassword)
meta
| def | func:finSetSuperUserPassword |
| is | func |
| lib | lib:finStackCore |
| name | finSetSuperUserPassword |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finShadowPointToPoint
finShadowPointToPoint(shadowRef, refOnly: false)
meta
| def | func:finShadowPointToPoint |
| is | func |
| lib | lib:finStackCore |
| name | finShadowPointToPoint |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finSkySparkApps
finSkySparkApps()
Returns all SkySpark Apps
meta
| def | func:finSkySparkApps |
| is | func |
| lib | lib:finStackCore |
| name | finSkySparkApps |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finSkySparkViewsForApp
finSkySparkViewsForApp(appName)
Returns all Views for a SkySpark app name
meta
| def | func:finSkySparkViewsForApp |
| is | func |
| lib | lib:finStackCore |
| name | finSkySparkViewsForApp |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finSummaryOn
finSummaryOn(target)
Get all Summaries which are registered on the given target. The target may be any value accepted by toRec().
meta
| def | func:finSummaryOn |
| is | func |
| lib | lib:finStackCore |
| name | finSummaryOn |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finTasks
finTasks(programRef: null, targetRef: null)
meta
| def | func:finTasks |
| is | func |
| lib | lib:finStackCore |
| name | finTasks |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finTuningPolicies
finTuningPolicies(targets)
Get all tuning policies which are registered on the given target. The target may be any value accepted by toRec().
meta
| def | func:finTuningPolicies |
| is | func |
| lib | lib:finStackCore |
| name | finTuningPolicies |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finUpdate
finUpdate(fileId: null)
meta
| def | func:finUpdate |
| is | func |
| lib | lib:finStackCore |
| name | finUpdate |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finUpdateLicense
finUpdateLicense(fileRef)
meta
| def | func:finUpdateLicense |
| is | func |
| lib | lib:finStackCore |
| name | finUpdateLicense |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finWriteBinTag
finWriteBinTag(recId, tagName, handle, mimeType: "text/plain")
FIN Write Binary Tag
This function writes the data described by the handle to the given bin tag on the requested record.
meta
| def | func:finWriteBinTag |
| is | func |
| lib | lib:finStackCore |
| name | finWriteBinTag |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:firstRun
firstRun()
meta
| def | func:firstRun |
| is | func |
| lib | lib:finStackCore |
| name | firstRun |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:firstRunComplete
firstRunComplete()
meta
| def | func:firstRunComplete |
| is | func |
| lib | lib:finStackCore |
| name | firstRunComplete |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:fromJSON
fromJSON(value)
meta
| def | func:fromJSON |
| is | func |
| lib | lib:finStackCore |
| name | fromJSON |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:getNavURI
getNavURI(recId, treeName: "equip")
meta
| def | func:getNavURI |
| is | func |
| lib | lib:finStackCore |
| name | getNavURI |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:gridToZinc
gridToZinc(grid)
meta
| def | func:gridToZinc |
| is | func |
| lib | lib:finStackCore |
| name | gridToZinc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:migrateGetFileUrl
migrateGetFileUrl(original, projectName)
Allows you to change the project name on a getFinFile url
/getFinFile/projectA -> /getfinFile/projectB
@param original Original getFinFile URL @param projectName New project name to point the url to @return getFinFile URL that queries the project specified by the projectName
meta
| def | func:migrateGetFileUrl |
| is | func |
| lib | lib:finStackCore |
| name | migrateGetFileUrl |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:migrateRef
migrateRef(original, projectName)
Allows you to change the project name on an absolute or relative reference
@p:projectA:r:1234-5678 -> @p:projectB:r:1234-5678 or @1234-5678 -> @p:projectB:r:1234-5678
@param original Original Reference @param projectName New project name to point the reference to @return reference that points to the project specified by the projectName
meta
| def | func:migrateRef |
| is | func |
| lib | lib:finStackCore |
| name | migrateRef |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:toJSON
toJSON(item, complexNumbers: false)
meta
| def | func:toJSON |
| is | func |
| lib | lib:finStackCore |
| name | toJSON |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |