外观
lib-fin5Core 库参考
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793554242/FIN+5.3.1+lib-fin5Core 中文整理基于 FIN 5.3.1
导读： 本页为
lib-fin5Core的 API / 标签 / 函数参考文档。
以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。
目录（导读）
- lib
- meta
- funcs
- def
- createGraphicsLibrary(graphicFiles, libraryName, moveToLib: false)
- createTemplateGraphic(templateRef, points, options, additionalRecords, overwrite: false)
- finBuilderComponents()
- finBuilderContextMenu(firstArg: null, targetRef: null)
- finBuilderModels()
- finMigrateFinFile(input)
- finRemoteAsset()
- getFinComponent(componentRequest, dependenciesOnly: null)
- getKioskConfig(request)
- getMixinsAndDependencies(mixinNames)
- readFinFile(input, expandModels: false, updateModelIds: false)
- readFinFileResources(input)
- refreshFinComponents()
- retrieveGraphicDependencies(graphicRef)
- subscribeToGraphic(graphicRef, targetRef: null)
- watchSubOp(request)
- writeFinFile(finGrid, fileId: null, resultType: "file")
概述（中译）
FIN 5 核心扩展
API 正文（英文）
funcs
| createGraphicsLibrary | |
| createTemplateGraphic | |
| finBuilderComponents | |
| finBuilderContextMenu | |
| finBuilderModels | |
| finMigrateFinFile | Migrates record tags and the ids inside a fin project file record Returns true if project was migrated |
| finRemoteAsset | |
| getFinComponent | |
| getKioskConfig | |
| getMixinsAndDependencies | |
| readFinFile | |
| readFinFileResources | |
| refreshFinComponents | |
| retrieveGraphicDependencies | |
| subscribeToGraphic | Subscribe To Graphic This method takes a graphic reference and a target reference and will find all of the points utilized in the database and instantiate the watch for this graphic/target combination |
| watchSubOp | |
| writeFinFile |
def
func:createGraphicsLibrary
createGraphicsLibrary(graphicFiles, libraryName, moveToLib: false)
meta
| def | func:createGraphicsLibrary |
| is | func |
| lib | lib:fin5Core |
| name | createGraphicsLibrary |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:createTemplateGraphic
createTemplateGraphic(templateRef, points, options, additionalRecords, overwrite: false)
meta
| def | func:createTemplateGraphic |
| is | func |
| lib | lib:fin5Core |
| name | createTemplateGraphic |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finBuilderComponents
finBuilderComponents()
meta
| def | func:finBuilderComponents |
| is | func |
| lib | lib:fin5Core |
| name | finBuilderComponents |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finBuilderContextMenu
finBuilderContextMenu(firstArg: null, targetRef: null)
meta
| def | func:finBuilderContextMenu |
| is | func |
| lib | lib:fin5Core |
| name | finBuilderContextMenu |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finBuilderModels
finBuilderModels()
meta
| def | func:finBuilderModels |
| is | func |
| lib | lib:fin5Core |
| name | finBuilderModels |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finMigrateFinFile
finMigrateFinFile(input)
Migrates record tags and the ids inside a fin project file record
Returns true if project was migrated.
Usage:
finMigrateFinFile(@projectFileId)meta
| def | func:finMigrateFinFile |
| is | func |
| lib | lib:fin5Core |
| name | finMigrateFinFile |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:finRemoteAsset
finRemoteAsset()
meta
| def | func:finRemoteAsset |
| is | func |
| lib | lib:fin5Core |
| name | finRemoteAsset |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:getFinComponent
getFinComponent(componentRequest, dependenciesOnly: null)
meta
| def | func:getFinComponent |
| is | func |
| lib | lib:fin5Core |
| name | getFinComponent |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:getKioskConfig
getKioskConfig(request)
meta
| def | func:getKioskConfig |
| is | func |
| lib | lib:fin5Core |
| name | getKioskConfig |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:getMixinsAndDependencies
getMixinsAndDependencies(mixinNames)
meta
| def | func:getMixinsAndDependencies |
| is | func |
| lib | lib:fin5Core |
| name | getMixinsAndDependencies |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:readFinFile
readFinFile(input, expandModels: false, updateModelIds: false)
meta
| def | func:readFinFile |
| is | func |
| lib | lib:fin5Core |
| name | readFinFile |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:readFinFileResources
readFinFileResources(input)
meta
| def | func:readFinFileResources |
| is | func |
| lib | lib:fin5Core |
| name | readFinFileResources |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:refreshFinComponents
refreshFinComponents()
meta
| def | func:refreshFinComponents |
| is | func |
| lib | lib:fin5Core |
| name | refreshFinComponents |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:retrieveGraphicDependencies
retrieveGraphicDependencies(graphicRef)
meta
| def | func:retrieveGraphicDependencies |
| is | func |
| lib | lib:fin5Core |
| name | retrieveGraphicDependencies |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:subscribeToGraphic
subscribeToGraphic(graphicRef, targetRef: null)
Subscribe To Graphic
This method takes a graphic reference and a target reference and will find all of the points utilized in the database and instantiate the watch for this graphic/target combination. It will return all of the points found -- absolute and relative -- in a grid.
<example>
read(finProject).subscribeToGraphic(@targetRef) </example>
@param graphicRef - A Ref or Dict of the graphic to subscribe to @param targetRef - Reference to the target record that the graphic will be displayed on
@return Grid of points resolved for the graphic/target combination
meta
| def | func:subscribeToGraphic |
| is | func |
| lib | lib:fin5Core |
| name | subscribeToGraphic |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:watchSubOp
watchSubOp(request)
meta
| def | func:watchSubOp |
| is | func |
| lib | lib:fin5Core |
| name | watchSubOp |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:writeFinFile
writeFinFile(finGrid, fileId: null, resultType: "file")
meta
| def | func:writeFinFile |
| is | func |
| lib | lib:fin5Core |
| name | writeFinFile |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |