FIN 5.3.1 中文文档

外观

fin5CoreExt 扩展参考 ​

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793325123/FIN+5.3.1+fin5CoreExt 中文整理基于 FIN 5.3.1

导读： 本页为 FIN 扩展 fin5CoreExt 的 API 参考文档。

以下为 API 参考，保留英文以便对照源码；目录已列出（英文标题便于检索）；概述已尽量中译。

目录（导读） ​

  • classes
  • Slot Details
    • data
    • make
    • makeExternal
    • record
    • time
    • api
    • lib
    • web
    • mod
    • onService
    • htmlEscape
    • DICT_TAGS
    • FIN_RESOURCE_URL
    • LIST_TAGS
    • URL_TAGS
    • getLoadedPods
    • getVisualComponents
    • main
    • onStart
    • onStop
    • queryFinRecord
    • queryFinRecords
    • refreshComponents
    • componentLicenses
    • cur
    • graphicsCache
    • loadedPods
    • processProjectForCacheBusting
    • refresh
    • RESOURCE_TAGS
    • constructFinFileGrid
    • createGraphicsLibrary
    • createModelFromPoint
    • createTemplateGraphic
    • finBuilderComponents
    • finBuilderContextMenu
    • finBuilderModels
    • finMigrateFinFile
    • finRemoteAsset
    • getDependenciesForRec
    • getFinComponent
    • getKioskConfig
    • getMixinsAndDependencies
    • getResourceRecord
    • mapToHaystackMap
    • readFinFile
    • readFinFileResources
    • refreshFinComponents
    • retrieveGraphicDependencies
    • subscribeToGraphic
    • watchSubOp
    • writeFinFile
    • cacheData
    • cacheExternalData
    • expireCache
    • getCachedData
    • getExternalCachedData
    • finUserLanguages

概述（中译） ​

类 FIN5GraphicCacheModel : Obj

构造函数

方法

插槽详情

对象？数据()

API 正文（英文） ​

make ​

new make(Dict record, Obj data)

makeExternal ​

new makeExternal(Ref key, DateTime time, Obj data)

record ​

Dict record()

time ​

DateTime time()

FIN5LangMod ​

const class FIN5LangMod : SysMod

Constructors

make

Fields

api
lib
web

Slot Details ​

api ​

const static Str api := "fin5Lang"

lib ​

const Fin5LangLib lib := ...

make ​

new make()

web ​

virtual const override FIN5LangWeb web := FIN5LangWeb.<ctor>(this)

FIN5LangWeb ​

const class FIN5LangWeb : SysWeb

Constructors

make

Fields

mod

Methods

onService

Slot Details ​

make ​

new make(FIN5LangMod mod)

mod ​

const FIN5LangMod mod

onService ​

virtual override Void onService()

FIN5Mod ​

const class FIN5Mod : SysMod

Constructors

make

Fields

api
web

Slot Details ​

api ​

const static Str api := "fin5"

make ​

new make()

web ​

virtual const override FIN5Web web := FIN5Web.<ctor>(this)

FIN5ResourceMod ​

const class FIN5ResourceMod : SysMod

Constructors

make

Fields

api
web

Slot Details ​

api ​

const static Str api := "fin5Resources"

make ​

new make()

web ​

virtual const override FIN5ResourceWeb web := FIN5ResourceWeb.<ctor>(this)

FIN5ResourceWeb ​

const class FIN5ResourceWeb : SysWeb

Constructors

make

Fields

mod

Methods

onService

Slot Details ​

make ​

new make(FIN5ResourceMod mod)

mod ​

const FIN5ResourceMod mod

onService ​

virtual override Void onService()

FIN5SessionMod ​

const class FIN5SessionMod : SysMod

Constructors

make

Fields

api
web

Slot Details ​

api ​

const static Str api := "finStackAuth"

make ​

new make()

web ​

virtual const override FIN5SessionWeb web := FIN5SessionWeb.<ctor>(this)

FIN5SessionWeb ​

const class FIN5SessionWeb : SysWeb

Constructors

make

Fields

mod

Methods

onService

Slot Details ​

make ​

new make(FIN5SessionMod mod)

mod ​

const FIN5SessionMod mod

onService ​

virtual override Void onService()

FIN5Web ​

const class FIN5Web : SysWeb

Constructors

make

Fields

mod

Methods

htmlEscape
onService

Slot Details ​

htmlEscape ​

static Str htmlEscape(Str text)

make ​

new make(FIN5Mod mod)

mod ​

const FIN5Mod mod

onService ​

virtual override Void onService()

Fin5ComponentService ​

const class Fin5ComponentService : Obj, Service

Constructors

make

Fields

DICT_TAGS
FIN_RESOURCE_URL
LIST_TAGS
URL_TAGS

Methods

getLoadedPods
getVisualComponents
main
onStart
onStop
queryFinRecordQuery FIN Record
queryFinRecordsQuery FIN Records
refreshComponents

Slot Details ​

DICT_TAGS ​

const static Str[] DICT_TAGS := Str["localCss","doc"]

FIN_RESOURCE_URL ​

const static Str FIN_RESOURCE_URL := "/finPod/"

LIST_TAGS ​

const static Str[] LIST_TAGS := ...

URL_TAGS ​

const static Str[] URL_TAGS := ...

getLoadedPods ​

Pod[] getLoadedPods()

getVisualComponents ​

Dict[] getVisualComponents(Str[] componentNames)

main ​

static Void main()

make ​

new make()

onStart ​

virtual override Void onStart()

onStop ​

virtual override Void onStop()

queryFinRecord ​

Dict? queryFinRecord(Filter filter)

Query FIN Record

queryFinRecords ​

Dict[]? queryFinRecords(Filter filter)

Query FIN Records

This method will query the FIN|5 records table and return the records that match the given filter.

refreshComponents ​

Void refreshComponents()

Fin5CoreExt ​

@ExtMeta { name="fin5Core" } @FinExtMeta { licFeature="finstack"; pngIcon=... } const class Fin5CoreExt : FinExt

Methods

componentLicenses
cur
graphicsCache
loadedPods
onStart
onStop
processProjectForCacheBusting
queryFinRecord
queryFinRecords
refresh

Slot Details ​

componentLicenses ​

Str:Str componentLicenses()

cur ​

static Fin5CoreExt? cur(Bool checked := true)

graphicsCache ​

Fin5GraphicsCache graphicsCache()

loadedPods ​

Pod[] loadedPods()

onStart ​

virtual override Void onStart()

onStop ​

virtual override Void onStop()

processProjectForCacheBusting ​

InStream processProjectForCacheBusting(Dict fileRec)

queryFinRecord ​

Dict? queryFinRecord(Filter filter)

queryFinRecords ​

Dict[]? queryFinRecords(Filter filter)

refresh ​

Bool refresh()

Fin5CoreLib ​

class Fin5CoreLib : Obj

Fields

RESOURCE_TAGS

Methods

constructFinFileGrid
createGraphicsLibrary
createModelFromPoint
createTemplateGraphic
finBuilderComponents
finBuilderContextMenu
finBuilderModels
finMigrateFinFileMigrates record tags and the ids inside a fin project file record
finRemoteAsset
getDependenciesForRec
getFinComponent
getKioskConfig
getMixinsAndDependencies
getResourceRecord
mapToHaystackMap
readFinFile
readFinFileResources
refreshFinComponents
retrieveGraphicDependencies
subscribeToGraphicSubscribe To Graphic
watchSubOp
writeFinFile

Slot Details ​

RESOURCE_TAGS ​

const static Str[] RESOURCE_TAGS := ...

constructFinFileGrid ​

static Grid constructFinFileGrid(Str name, Str viewHtml, Str graphicOn, Dict[] items)

createGraphicsLibrary ​

@Axon static Uri createGraphicsLibrary(Ref[] graphicFiles, Str libraryName, Bool moveToLib := false)

createModelFromPoint ​

static Map createModelFromPoint(Dict point, Obj model, Int yPos := 0, Context? cx := null)

createTemplateGraphic ​

@Axon static Grid createTemplateGraphic(Obj templateRef, Dict[] points, Dict? options, Dict[]? additionalRecords, Bool overwrite := false)

finBuilderComponents ​

@Axon static Grid finBuilderComponents()

finBuilderContextMenu ​

@Axon static Grid finBuilderContextMenu(Obj? firstArg := null, Ref? targetRef := null)

finBuilderModels ​

@Axon static Grid finBuilderModels()

finMigrateFinFile ​

@Axon static Bool finMigrateFinFile(Obj input)

Migrates record tags and the ids inside a fin project file record

Returns true if project was migrated.

Usage:

finMigrateFinFile(@projectFileId)

finRemoteAsset ​

@Axon static Grid finRemoteAsset()

getDependenciesForRec ​

static Dict getDependenciesForRec(Dict rec, Map? collector, Str depTagName := "deps")

getFinComponent ​

@Axon static Grid getFinComponent(Obj componentRequest, Bool? dependenciesOnly := null)

getKioskConfig ​

@Axon static Dict? getKioskConfig(Obj request)

getMixinsAndDependencies ​

@Axon static Grid getMixinsAndDependencies(List mixinNames)

getResourceRecord ​

static Dict? getResourceRecord(Context cx, Dict row, Str tagName, Obj? value)

mapToHaystackMap ​

static Map mapToHaystackMap(Map item)

readFinFile ​

@Axon static Grid readFinFile(Obj input, Bool expandModels := false, Bool updateModelIds := false)

readFinFileResources ​

@Axon static Grid readFinFileResources(Obj input)

refreshFinComponents ​

@Axon static Bool refreshFinComponents()

retrieveGraphicDependencies ​

@Axon static Grid? retrieveGraphicDependencies(Obj graphicRef)

subscribeToGraphic ​

@Axon static Grid[] subscribeToGraphic(Obj graphicRef, Ref? 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

watchSubOp ​

@Axon static Grid watchSubOp(Grid request)

writeFinFile ​

@Axon static Obj? writeFinFile(Grid finGrid, Ref? fileId := null, Str resultType := "file")

Fin5GraphicsCache ​

class Fin5GraphicsCache : Obj

Constructors

make

Methods

cacheData
cacheExternalData
expireCache
getCachedData
getExternalCachedData

Slot Details ​

cacheData ​

Void cacheData(Dict record, Obj data)

cacheExternalData ​

Void cacheExternalData(Ref key, DateTime? modTime, Obj data)

expireCache ​

Void expireCache(Ref id)

getCachedData ​

Obj? getCachedData(Dict record)

getExternalCachedData ​

Obj? getExternalCachedData(Ref key, DateTime modTime)

make ​

new make()

Fin5LangLib ​

const class Fin5LangLib : Obj

Methods

finUserLanguages

Slot Details ​

finUserLanguages ​

@Axon static Dict[] finUserLanguages()

VisualComponentsMod ​

const class VisualComponentsMod : SysMod

Constructors

make

Fields

api
web

Slot Details ​

api ​

const static Str api := "visualComponents"

make ​

new make()

web ​

virtual const override VisualComponentsWeb web := VisualComponentsWeb.<ctor>(this)

VisualComponentsWeb ​

const class VisualComponentsWeb : SysWeb

Constructors

make

Fields

mod

Methods

onService

Slot Details ​

make ​

new make(VisualComponentsMod mod)

mod ​

const VisualComponentsMod mod

onService ​

virtual override Void onService()