`lib-hx` 库参考

原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793652481/FIN+5.3.1+lib-hx 中文整理基于 FIN 5.3.1

导读： Haxall 框架定义

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

目录（导读）

lib
meta
tags
ops
filetypes
funcs
def
supertypes
tags
about()
commit(diffs)
context()
diff(orig, changes, flags: null)
isSteadyState()
isWatched(rec)
libAdd(name, tags: null)
libRemove(name)
libStatus()
passwordSet(key, val)
pods()
read(filterExpr, checked: true)
readAll(filterExpr, optsExpr: null)
readAllStream(filterExpr)
readAllTagNames(filterExpr)
readAllTagVals(filterExpr, tagName)
readById(id, checked: true)
readByIdPersistentTags(id, checked: true)
readByIdTransientTags(id, checked: true)
readByIds(ids, checked: true)
readByIdsStream(ids, checked: true)
readCount(filterExpr)
readLink(id)
services()
stripUncommittable(val, opts: null)
toRec(val)
toRecId(val)
toRecIdList(val)
toRecList(val)
tzdb()
unitdb()
watchAdd(watchId, grid)
watchClose(watchId)
watchOpen(grid, dis)
watchPoll(watchId)
watchRemove(watchId, grid)
xetoReload()
- subtypes

概述（中译）

Haxall 框架定义

API 正文（英文）

tags


created	The timestamp when entity was created
disKey	Localized string key formatted as `pod::key`
disMacro	Display name using macro syntax
disabled	Indicates the entity is in a disabled state
flags	Flags string
linter	Fantom qname of `Linter` class
mod	Last modified time of record - see docSkySpark
multiLine	Indicates that a multi-line text input should be used
noSkyarc	Marks a Haxall library as not runnable on SkySpark enabled products
password	Manages password which is hashed/stored to the password store
projMeta	Singleton record for project meta data
reader	Fantom type qname for reader class
steadyState	The delay before transitioning to the steady state
trash	Marks a record for deletion
typeName	Fantom type qname
uiInput	Fantom type qname for `Input` to use for a definition
username	Username for an authentication account
writer	Fantom type qname for writer class

ops


commit	Commit one or more diffs to the Folio database
eval	Evaluate an Axon expression

filetypes


excel	Excel 2003 XML spreadsheet
xml	EXtensible Markup Language

funcs


about	Return `about` dict
commit	Commit one or more diffs to the folio database
context	Get the current context as a Dict with the following tags
diff	Construct a modification "diff" used by `commit()`
isSteadyState	Return `HxRuntime.isSteadyState`
isWatched	Return if given record is under at least one watch
libAdd	Enable a library by name in the runtime
libRemove	Disable a library by name in the runtime
libStatus	Return grid of enabled libs and their current status
passwordSet	Store a password key/val pair into current project's password store
pods	Return list of installed Fantom pods
read	Read from database the first record which matches filter
readAll	Reall all records from the database which match the filter
readAllStream	Reall all records which match filter as stream of Dict records
readAllTagNames	Return the intersection of all tag names used by all the records matching the given filter
readAllTagVals	Return the range of all the values mapped to a given tag name used by all the records matching the given filter
readById	Read a record from database by `id`
readByIdPersistentTags	Given record id, read only the persistent tags from Folio
readByIdTransientTags	Given record id, read only the transient tags from Folio
readByIds	Read a list of record ids into a grid
readByIdsStream	Read a list of ids as a stream of Dict records
readCount	Return the number of records which match the given filter expression
readLink	Read a record Dict by its id for hyperlinking in a UI
services	Grid of installed services
stripUncommittable	Strip any tags which cannot be persistently committed to Folio
toRec	Coerce a value to a record Dict
toRecId	Coerce a value to a Ref identifier
toRecIdList	Coerce a value to a list of Ref identifiers
toRecList	Coerce a value to a list of record Dicts
tzdb	Return the installed timezone database as Grid with following columns
unitdb	Return the installed unit database as Grid with following columns
watchAdd	Add a grid of recs to an existing watch and return the grid passed in
watchClose	Close an open watch by id
watchOpen	Open a new watch on a grid of records
watchPoll	Poll an open watch and return all the records which have changed since the last poll
watchRemove	Remove a grid of recs from an existing watch and return grid passed in
xetoReload	Reload all the Xeto libraries

created

The timestamp when entity was created

meta


def	created
is	dateTime
lib	lib:hx
tagOn	alarm, arc, projMeta, user

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
dateTime	ISO 8601 timestamp followed by timezone identifier

disKey

Localized string key formatted as pod::key

meta


def	disKey
is	str
lib	lib:hx

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

disMacro

Display name using macro syntax. See Etc.dictToDis

meta


def	disMacro
is	str
lib	lib:hx
tagOn	space, equip, point, system

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

disabled

Indicates the entity is in a disabled state

meta


def	disabled
is	marker
lib	lib:hx
tagOn	conn, job, point, rule, task, user

supertypes


marker	Marker labels a dict with typing information

filetype:excel

Excel 2003 XML spreadsheet

meta


def	filetype:excel
dis	Excel
fileExt	xls
icon	table
is	filetype
lib	lib:hx
mime	application/vnd.ms-excel
writer	hxUtil::ExcelWriter

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
filetype	File format type definition

tags


fileExt	Filename extension such as "csv"
mime	Mime type formatted as type/subtype

filetype:xml

EXtensible Markup Language

meta


def	filetype:xml
dis	XML
fileExt	xml
icon	page
is	filetype
lib	lib:hx
mime	text/xml
writer	hxUtil::XmlWriter

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
filetype	File format type definition

tags


fileExt	Filename extension such as "csv"
mime	Mime type formatted as type/subtype

flags

Flags string

meta


def	flags
is	str
lib	lib:hx

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

func:about

about()

Return about dict

meta


def	func:about
is	func
lib	lib:hx
name	about

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

func:commit

commit(diffs)

Commit one or more diffs to the folio database. The argument may be one of the following:

result of diff()
list of diff() to commit multiple diffs at once
stream of diff(); see Streams.

If one diff is passed, return the new record. If a list of diffs is passed return a list of new records.

This is a synchronous blocking call which will return the new record or records as the result.

Examples:

// add new record
newRec: commit(diff(null, {dis:"New Rec!"}, {add}))

// add someTag to some group of records
readAll(filter).toRecList.map(r => diff(r, {someTag})).commit

meta


admin	✓
def	func:commit
is	func
lib	lib:hx
name	commit

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

func:context

context()

Get the current context as a Dict with the following tags:

username for current user
userRef id for current user
locale current locale

SkySpark tags:

projName if evaluating in context of a project
nodeId local cluster node id
ruleRef if evaluating in context of a rule engine
ruleTuning if evaluating in context of rule engine

meta


def	func:context
is	func
lib	lib:hx
name	context

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

func:diff

diff(orig, changes, flags: null)

Construct a modification "diff" used by commit(). The orig should be the instance which was read from the database, or it may be null only if the add flag is passed. Any tags to add/set/remove should be included in the changes dict.

The following flags are supported:

add: indicates diff is adding new record
remove: indicates diff is removing record (in general you should add trash tag instead of removing)
transient: indicate that this diff should not be flushed to persistent storage (it may or may not be persisted).
force: indicating that changes should be applied regardless of other concurrent changes which may be been applied after the orig version was read (use with caution!)

Examples:

// create new record
diff(null, {dis:"New Rec", someMarker}, {add})

// create new record with explicit id like Diff.makeAdd
diff(null, {id:151bd3c5-6ce3cb21, dis:"New Rec"}, {add})

// set/add dis tag and remove oldTag
diff(orig, {dis:"New Dis", -oldTag})

// set/add val tag transiently
diff(orig, {val:123}, {transient})

meta


def	func:diff
is	func
lib	lib:hx
name	diff

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:isSteadyState

isSteadyState()

Return HxRuntime.isSteadyState

meta


def	func:isSteadyState
is	func
lib	lib:hx
name	isSteadyState

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:isWatched

isWatched(rec)

Return if given record is under at least one watch. The rec argument can be any value accepted by toRecId().

meta


def	func:isWatched
is	func
lib	lib:hx
name	isWatched

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:libAdd

libAdd(name, tags: null)

Enable a library by name in the runtime:

libAdd("mqtt")

meta


admin	✓
def	func:libAdd
is	func
lib	lib:hx
name	libAdd

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:libRemove

libRemove(name)

Disable a library by name in the runtime:

libRemove("mqtt")

meta


admin	✓
def	func:libRemove
is	func
lib	lib:hx
name	libRemove

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:libStatus

libStatus()

Return grid of enabled libs and their current status. Columns:

name: library name string
libStatus: status enumeration string
statusMsg: additional message string or null

meta


admin	✓
def	func:libStatus
is	func
lib	lib:hx
name	libStatus

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:passwordSet

passwordSet(key, val)

Store a password key/val pair into current project's password store. The key is typically a Ref of the associated record. If the val is null, then the password will be removed. See Folio.

passwordSet(@abc-123, "password")
passwordSet(@abc-123, null)

meta


admin	✓
def	func:passwordSet
is	func
lib	lib:hx
name	passwordSet

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:pods

pods()

Return list of installed Fantom pods

meta


admin	✓
def	func:pods
is	func
lib	lib:hx
name	pods

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:read

read(filterExpr, checked: true)

Read from database the first record which matches filter. If no matches found throw UnknownRecErr or null based on checked flag. If there are multiple matches it is indeterminate which one is returned. See readAll() for how filter works.

Examples:

read(site)                 // read any site rec
read(site and dis=="HQ")   // read site rec with specific dis tag
read(chiller)              // raise exception if no recs with chiller tag
read(chiller, false)       // return null if no recs with chiller tag

meta


def	func:read
is	func
lib	lib:hx
name	read

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readAll

readAll(filterExpr, optsExpr: null)

Reall all records from the database which match the filter. The filter must an expression which matches the filter structure. String values may parsed into a filter using parseFilter() function.

Options:

limit: max number of recs to return
sort: sort by display name

Examples:

readAll(site)                      // read all site recs
readAll(equip and siteRef==@xyz)   // read all equip in a given site
readAll(equip, {limit:10})         // read up to ten equips
readAll(equip, {sort})             // read all equip sorted by dis

meta


def	func:readAll
is	func
lib	lib:hx
name	readAll

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readAllStream

readAllStream(filterExpr)

Reall all records which match filter as stream of Dict records. See Streams.

meta


def	func:readAllStream
is	func
lib	lib:hx
name	readAllStream

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readAllTagNames

readAllTagNames(filterExpr)

Return the intersection of all tag names used by all the records matching the given filter. The results are returned as a grid with following columns:

name: string name of the tag
kind: all the different value kinds separated by "|"
count: total number of recs with the tag Also see readAllTagVals() and gridColKinds().

Examples:

// read statistics on all tags used by equip recs
readAllTagNames(equip)

meta


def	func:readAllTagNames
is	func
lib	lib:hx
name	readAllTagNames

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readAllTagVals

readAllTagVals(filterExpr, tagName)

Return the range of all the values mapped to a given tag name used by all the records matching the given filter. This method is capped to 200 results. The results are returned as a grid with a single val column. Also see readAllTagNames().

Examples:

// read grid of all unique point unit tags
readAllTagVals(point, "unit")

meta


def	func:readAllTagVals
is	func
lib	lib:hx
name	readAllTagVals

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readById

readById(id, checked: true)

Read a record from database by id. If not found throw UnknownRecErr or return null based on checked flag. In Haxall all refs are relative, but in SkySpark refs may be prefixed with something like "p:projName:r:". This function will accept both relative and absolute refs.

Examples:

readById(@2b00f9dc-82690ed6)          // relative ref literal
readById(@:demo:r:2b00f9dc-82690ed6)  // project absolute literal
readById(id)                          // read using variable
readById(equip->siteRef)              // read from ref tag

meta


def	func:readById
is	func
lib	lib:hx
name	readById

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readByIdPersistentTags

readByIdPersistentTags(id, checked: true)

Given record id, read only the persistent tags from Folio. Also see readByIdTransientTags() and readById().

meta


def	func:readByIdPersistentTags
is	func
lib	lib:hx
name	readByIdPersistentTags

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readByIdTransientTags

readByIdTransientTags(id, checked: true)

Given record id, read only the transient tags from Folio. Also see readByIdPersistentTags() and readById().

meta


def	func:readByIdTransientTags
is	func
lib	lib:hx
name	readByIdTransientTags

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readByIds

readByIds(ids, checked: true)

Read a list of record ids into a grid. The rows in the result correspond by index to the ids list. If checked is true, then every id must be found in the database or UnknownRecErr is thrown. If checked is false, then an unknown record is returned as a row with every column set to null (including the id tag). Either relative or project absolute refs may be used.

Examples:

// read two relative refs
readByIds([@2af6f9ce-6ddc5075, @2af6f9ce-2d56b43a])

// read two project absolute refs
readByIds([@p:demo:r:2af6f9ce-6ddc5075, @p:demo:r:2af6f9ce-2d56b43a])

// return null for a given id if it does not exist
readByIds([@2af6f9ce-6ddc5075, @2af6f9ce-2d56b43a], false)

meta


def	func:readByIds
is	func
lib	lib:hx
name	readByIds

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readByIdsStream

readByIdsStream(ids, checked: true)

Read a list of ids as a stream of Dict records. If checked if false, then records not found are skipped. See Streams.

meta


def	func:readByIdsStream
is	func
lib	lib:hx
name	readByIdsStream

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readCount

readCount(filterExpr)

Return the number of records which match the given filter expression.

Examples:

readCount(point)    // return number of recs with point tag

meta


def	func:readCount
is	func
lib	lib:hx
name	readCount

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:readLink

readLink(id)

Read a record Dict by its id for hyperlinking in a UI. Unlike other reads which return a Dict, this read returns the columns ordered in the same order as reads which return a Grid.

meta


def	func:readLink
is	func
lib	lib:hx
name	readLink

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:services

services()

Grid of installed services. Format of the grid is subject to change.

meta


admin	✓
def	func:services
is	func
lib	lib:hx
name	services

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:stripUncommittable

stripUncommittable(val, opts: null)

Strip any tags which cannot be persistently committed to Folio. This includes special tags such as hisSize and any transient tags the record has defined. If val is Dict, then a single Dict is returned. Otherwise val must be Dict[] or Grid and Dict[] is returned. The mod tag is stripped unless the {mod} option is specified. The id tag is not stripped for cases when adding records with swizzled ids; pass {-id} in options to strip the id tag also.

Examples:

// strip uncommittable tags and keep id
toCommit: rec.stripUncommittable

// strip uncommittable tags and the id tag
toCommit: rec.stripUncommittable({-id})

// strip uncommittable tags, but keep id and mod
toCommit: rec.stripUncommittable({mod})

meta


def	func:stripUncommittable
is	func
lib	lib:hx
name	stripUncommittable

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:toRec

toRec(val)

Coerce a value to a record Dict:

Row or Dict returns itself
Grid returns first row
List returns first row (can be either Ref or Dict)
Ref will make a call to read database

meta


def	func:toRec
is	func
lib	lib:hx
name	toRec

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:toRecId

toRecId(val)

Coerce a value to a Ref identifier:

Ref returns itself
Row or Dict, return id tag
Grid return first row id

meta


def	func:toRecId
is	func
lib	lib:hx
name	toRecId

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:toRecIdList

toRecIdList(val)

Coerce a value to a list of Ref identifiers:

Ref returns itself as list of one
Ref[] returns itself
Dict return id tag
Dict[] return id tags
Grid return id column

meta


def	func:toRecIdList
is	func
lib	lib:hx
name	toRecIdList

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:toRecList

toRecList(val)

Coerce a value to a list of record Dicts:

null return empty list
Ref or Ref[] (will make a call to read database)
Row or Row[] returns itself
Dict or Dict[] returns itself
Grid is mapped to list of rows

meta


def	func:toRecList
is	func
lib	lib:hx
name	toRecList

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:tzdb

tzdb()

Return the installed timezone database as Grid with following columns:

name: name of the timezone
fullName: qualified name used by Olson database

meta


def	func:tzdb
is	func
lib	lib:hx
name	tzdb

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:unitdb

unitdb()

Return the installed unit database as Grid with following columns:

quantity: dimension of the unit
name: full name of the unit
symbol: the abbreviated Unicode name of the unit

meta


def	func:unitdb
is	func
lib	lib:hx
name	unitdb

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:watchAdd

watchAdd(watchId, grid)

Add a grid of recs to an existing watch and return the grid passed in.

meta


def	func:watchAdd
is	func
lib	lib:hx
name	watchAdd

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:watchClose

watchClose(watchId)

Close an open watch by id. If the watch does not exist or has expired then this is a no op. Also see HxWatch.close and Watches.

meta


def	func:watchClose
is	func
lib	lib:hx
name	watchClose

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:watchOpen

watchOpen(grid, dis)

Open a new watch on a grid of records. The dis parameter is used for the watch's debug display string. Update and return the grid with a meta watchId tag. Also see HxWatchService.open and Watches.

Example:

readAll(myPoints).watchOpen("MyApp|Points")

meta


def	func:watchOpen
is	func
lib	lib:hx
name	watchOpen

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:watchPoll

watchPoll(watchId)

Poll an open watch and return all the records which have changed since the last poll. Raise exception if watchId doesn't exist or has expired. Also see HxWatch.poll and Watches.

meta


def	func:watchPoll
is	func
lib	lib:hx
name	watchPoll

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:watchRemove

watchRemove(watchId, grid)

Remove a grid of recs from an existing watch and return grid passed in.

meta


def	func:watchRemove
is	func
lib	lib:hx
name	watchRemove

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

func:xetoReload

xetoReload()

Reload all the Xeto libraries

meta


def	func:xetoReload
is	func
lib	lib:hx
name	xetoReload
su	✓

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
func	Axon function

def

linter

Fantom qname of Linter class.

meta


accumulate	✓
def	linter
is	list
lib	lib:hx
of	str

supertypes


val	Data value type
list	Ordered list of zero or more values

def

mod

Last modified time of record - see docSkySpark.

meta


def	mod
is	dateTime
lib	lib:hx

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
dateTime	ISO 8601 timestamp followed by timezone identifier

def

multiLine

Indicates that a multi-line text input should be used

meta


def	multiLine
is	marker
lib	lib:hx

supertypes


marker	Marker labels a dict with typing information

def

noSkyarc

Marks a Haxall library as not runnable on SkySpark enabled products

meta


def	noSkyarc
is	marker
lib	lib:hx

supertypes


marker	Marker labels a dict with typing information

def

op:commit

Commit one or more diffs to the Folio database

meta


def	op:commit
is	op
lib	lib:hx

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
op	Operation for HTTP API

def

op:eval

Evaluate an Axon expression

meta


def	op:eval
is	op
lib	lib:hx

supertypes


feature	Feature namespace of definitions formatted as `feature:name`
op	Operation for HTTP API

def

password

Manages password which is hashed/stored to the password store.

meta


def	password
is	str
lib	lib:hx
tagOn	energyStarConn, haystackConn, mqttConn, obixConn, opcConn, sedonaConn, snmpConn, sqlConn, tplTrendConn
uiInput	ui::PasswordInput

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

subtypes


ecobeeClientId	Your Ecobee API Key
ecobeeRefreshToken	The refresh token you obtained for your API key
nestClientId	The OAuth client_id for your application
nestClientSecret	The OAuth client_secret for your application
nestRefreshToken	The OAuth refresh_token for your application

def

projMeta

Singleton record for project meta data

meta


def	projMeta
is	entity
lib	lib:hx

supertypes


marker	Marker labels a dict with typing information
entity	Top-level dicts with a unique identifier

tags


created	The timestamp when entity was created
dis	Display name for an entity
doc	Documentation in simplified flavor of markdown
id	Defines the unique identifier of an entity in system using a `ref` value type
steadyState	The delay before transitioning to the steady state
version	Version string formatted as decimal integers separated by a dot

def

reader

Fantom type qname for reader class

meta


def	reader
is	str
lib	lib:hx

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

steadyState

The delay before transitioning to the steady state. See Runtime

meta


def	steadyState
is	duration
lib	lib:hx
maxVal	1hr
minVal	0
tagOn	projMeta

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
number	Integer or floating point numbers annotated with an optional unit
duration	Number with a unit of time

def

trash

Marks a record for deletion

meta


def	trash
is	marker
lib	lib:hx

supertypes


marker	Marker labels a dict with typing information

def

typeName

Fantom type qname

meta


def	typeName
is	str
lib	lib:hx

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

subtypes


uiInput	Fantom type qname for `Input` to use for a definition

def

uiInput

Fantom type qname for Input to use for a definition

meta


def	uiInput
is	typeName
lib	lib:hx

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters
typeName	Fantom type qname

def

username

Username for an authentication account

meta


def	username
is	str
lib	lib:hx
tagOn	energyStarConn, haystackConn, mqttConn, obixConn, opcConn, sedonaConn, snmpConn, sqlConn, tplTrendConn, user

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

def

writer

Fantom type qname for writer class

meta


def	writer
is	str
lib	lib:hx

supertypes


val	Data value type
scalar	Scalar is an atomic value kind
str	Unicode string of characters

lib-hx 库参考 ​

目录（导读） ​

概述（中译） ​

API 正文（英文） ​

ops ​

filetypes ​

funcs ​

created ​

disKey ​

disMacro ​

disabled ​

filetype:excel ​

filetype:xml ​

flags ​

func:about ​

about() ​

func:commit ​

commit(diffs) ​

func:context ​

context() ​

func:diff ​

diff(orig, changes, flags: null) ​

func:isSteadyState ​

isSteadyState() ​

func:isWatched ​

isWatched(rec) ​

func:libAdd ​

libAdd(name, tags: null) ​

func:libRemove ​

libRemove(name) ​

func:libStatus ​

libStatus() ​

func:passwordSet ​

passwordSet(key, val) ​

func:pods ​

pods() ​

func:read ​

read(filterExpr, checked: true) ​

func:readAll ​

readAll(filterExpr, optsExpr: null) ​

func:readAllStream ​

readAllStream(filterExpr) ​

func:readAllTagNames ​

readAllTagNames(filterExpr) ​

func:readAllTagVals ​

readAllTagVals(filterExpr, tagName) ​

func:readById ​

readById(id, checked: true) ​

func:readByIdPersistentTags ​

readByIdPersistentTags(id, checked: true) ​

func:readByIdTransientTags ​

readByIdTransientTags(id, checked: true) ​

func:readByIds ​

readByIds(ids, checked: true) ​

func:readByIdsStream ​

readByIdsStream(ids, checked: true) ​

`lib-hx` 库参考

目录（导读）

概述（中译）

API 正文（英文）

ops

filetypes

funcs

created

disKey

disMacro

disabled

filetype:excel

filetype:xml

flags

func:about

about()

func:commit

commit(diffs)

func:context

context()

func:diff

diff(orig, changes, flags: null)

func:isSteadyState

isSteadyState()

func:isWatched

isWatched(rec)

func:libAdd

libAdd(name, tags: null)

func:libRemove

libRemove(name)

func:libStatus

libStatus()

func:passwordSet

passwordSet(key, val)

func:pods

pods()

func:read

read(filterExpr, checked: true)

func:readAll

readAll(filterExpr, optsExpr: null)

func:readAllStream

readAllStream(filterExpr)

func:readAllTagNames

readAllTagNames(filterExpr)

func:readAllTagVals

readAllTagVals(filterExpr, tagName)

func:readById

readById(id, checked: true)

func:readByIdPersistentTags

readByIdPersistentTags(id, checked: true)

func:readByIdTransientTags

readByIdTransientTags(id, checked: true)

func:readByIds

readByIds(ids, checked: true)

func:readByIdsStream

readByIdsStream(ids, checked: true)