外观
lib-skyarc 库参考
原文: https://finproducts.atlassian.net/wiki/spaces/JIDD3/pages/34793554429/FIN+5.3.1+lib-skyarc 中文整理基于 FIN 5.3.1
导读: Skyarc 图书馆模块
以下为 API 参考,保留英文以便对照源码;目录已列出(英文标题便于检索);概述已尽量中译。
目录(导读)
- lib
- meta
- tags
- ops
- filetypes
- apps
- funcs
- views
- def
- supertypes
- enum
- tags
- actionNormInput(arg, type)
- chart(val)
- deprecatedTags()
- ext(name, checked: true)
- extAdd(name)
- extRemove(name)
- extSettings(extName, opts: {})
- extSettingsCommit(arg)
- exts()
- feed(stream)
- hostMeta()
- hostVars()
- licStatus()
- lint(recs, opts: null)
- pivot(input, shape)
- projSync(timeout: null)
- recDelete(refs)
- recDisable(refs)
- recDup(refs)
- recEdit(dict)
- recEnable(refs)
- recForm(rec, templateName, opts: null)
- recFormCommit(dict)
- recNew(dict)
- recTrash(refs)
- renameTags(recs, renames, opts: null)
- sysModAdd(name, opts: null)
- sysModRemove(name, opts: null)
- sysMods()
- sysReload(podNames: null)
- table(val)
- validateFilter(s)
- validateNotBlank(s)
- validateTagName(s)
- validateUsername(s)
- subtypes
- src
概述(中译)
Skyarc 图书馆模块
API 正文(英文)
tags
| addOn | Feature which may be enabled or disabled at runtime |
| alsoSee | Legacy tag definitions |
| app | UI application grouping of views |
| appName | View containing app name |
| auditCommit | Log each time a diff is committed to the folio database |
| beta | Indicates a beta quality definition |
| color | Color encoded as #RRGGBB, #RGB, or a CSS color keyword |
| confirm | Used on actions to prompt for confirmation |
| curRule | Marker tag for a cur rule type |
| currency | The currency unit related to the entity |
| defName | Specifies definition symbol name to use |
| defVal | Default value |
| An email address | |
| enumExpr | Axon expression to dynamically compute an enum |
| enumx | Extened enum tag definitions |
| expires | Expiration date |
| ext | Extension library |
| fav | Favorite saved view link |
| fontWeight | Font weight setting |
| halign | Horizontal layout alignment |
| haystackApi | Function which is a published Hasytack REST API op |
| help | End user documentation |
| hidden | Hide a column in a table or a field on a form |
| hisFuncReady | Indicates a function designed to be used directly as a computed history |
| hisSrc | Legacy 2.1 support for function picker in History App |
| hotKey | One or more key combinations separated by a comma |
| icon | Icon logical name - see Icons |
| imageSize | Image size in pixels |
| kpiRule | Marker tag for a KPI rule type |
| libStatus | Current status of an extension or sys module library |
| licStatus | License status |
| logLevel | Severity level |
| multi | Indicates multiple selection |
| navAuxFilter | Apply extra filter string to a navigation tree |
| navCluster | Select from all the nodes in the cluster |
| navHidden | Hide an entity in the navigation selection pickers |
| navName | Navigation name commonly used with disMacro to create computed display strings |
| navSelAny | Select any level of a navigation tree which might include groupings |
| navSelAnyRec | Select any level of a navigation tree which maps to Folio record |
| navTarget | Apply to a def to specify a default navigation target |
| navTree | Navigation tree name to use for ref tag |
| optional | Not required |
| optsTemplate | TODO |
| order | Used to order definitions |
| pageSize | Printed page size formatted as "width,height" with an explicit unit of "pt", "in", "mm", or "cm" |
| percentage | A percentage specified as as <percent> * 100 |
| placeholder | Hint displayed in a text field input |
| podName | Fantom pod name |
| projIncludeFilter | Selects other projects to include in UI navigation |
| readonly | Indicates a value which may be read, but not written |
| refresh | Indicates an operation which requires a page refresh |
| restart | Indicates a setting which requires restart when modified |
| ruleOn | Target filter for a rule or rule ready func |
| ruleType | Rule type choice |
| select | Used on an action to use current selection |
| showDis | Show display names in UI instead of programmatic names |
| spanModes | Restrict Span input modes |
| sparkRule | Marker tag for a spark rule type |
| sysMod | System module library |
| tag | Legacy backward compatible tag definitions |
| templateName | Template by name - legacy support |
| timeout | Maximum elapsed time to allow an operation to continue |
| ts | Timestamp |
| unitless | Hide the unit picker for a number field |
| usedWith | Legacy tag definitions |
| validate | Axon expression to validate def |
| view | Fresco UI view |
| viewLink | View name and state for linking to a saved view |
ops
| export | Export a view to a file |
| ext | Ext specific HTTP servicing |
| rec | Get a record by id |
filetypes
| html | HyperText Markup Language |
| Portable Document Format | |
| svg | Scalable Vector Graphics |
apps
| builder | Views used to build the database |
| code | Views used to edit and manage the function library |
| conn | Views used to manage and debug connectors |
| debug | Views used for system diagnostics |
| doc | Views used to browse the documentation |
| favs | Views used to browse and manage your saved favorites |
| home | Home screen showing the available applications |
| host | Views used to manage the system which hosts the software |
| misc | Container for ad hoc views |
| monitor | Views used to visualize real-time point data |
| platform | Platform level configuration and management |
| settings | Views used to edit SysMod and Ext settings |
| tools | Views used for administration including the Axon shell |
| users | Views used to manage user accounts |
funcs
| actionNormInput | Normalize action input - see Committer.actionNormInput |
| chart | Set the grid visualization view to chart |
| deprecatedTags | Return tags which have been deprecated as grid with following columns |
| ext | Return extension record for given extension name |
| extAdd | Enable the given extension name or list of names |
| extRemove | Disable the given extension name or list of names |
| extSettings | Return ext settings form data - see Exts |
| extSettingsCommit | Submit function for extSettings() - see Exts |
| exts | Get the list of exts and their current status |
| feed | Convert a stream into a live feed to populate a view |
| hostMeta | Read host metadata dict |
| hostVars | Read host variables dict |
| licStatus | Return current licensing status as Dict with following tags |
| lint | Run the lint report on the given recs |
| pivot | Transform a grid to a pivot table - see Axon Usage |
| projSync | Block until all folio/project message queues are fully processed |
| recDelete | Record delete action |
| recDisable | Record disable action |
| recDup | Record duplicate action |
| recEdit | Record edit action |
| recEnable | Record enable action |
| recForm | Return a data grid for a form view to edit the specified record |
| recFormCommit | Commit a rec based form to Folio |
| recNew | Record create action |
| recTrash | Record trash action |
| renameTags | Rename a set of tags on a list of records or across the entire project database |
| sysModAdd | Enable the given system module name such as "ldap" |
| sysModRemove | Disable the given system module name |
| sysMods | List the installed system mods |
| sysReload | Force a system reload |
| table | Set the grid visualization view to table |
| validateFilter | Raise an exception if string is not valid filter |
| validateNotBlank | Raise an exception if string is blank |
| validateTagName | Raise an exception if string is not a validate tag name |
| validateUsername | Raise an excpetion if string is not a validate username |
views
| alerts | Display system alerts such as licensing errors |
| apiSettings | Settings for the API system module |
| blank | Placeholder with no content |
| card | Display each row of a grid as a formatted card |
| chart | Display grid data as a chart |
| crypto | Manage cryto trust store |
| debugHost | Debug of host level system modules |
| debugSupport | Gather support diagnostics |
| diag | Diagnostics dashboard with real-time graphs |
| doc | Documentation viewer |
| emailSettings | Settings for the email system module |
| fandoc | Display fandoc markup as stylized content |
| form | Display a dict for editing using a form layout |
| hostSettings | Settings for the host system module |
| httpSettings | Settings for the HTTP system module |
| iframe | Display a URI as an embedded HTML iframe |
| lics | Manage software license files |
| log | System log browser |
| logSettings | Settings for the logging system module |
| page | Display subviews as a linear page-oriented report |
| pageBreak | Use in a page view to force a page break during PDF generation |
| pods | Debug all installed pod modules |
| sessionSettings | Settings for the session system module |
| sessions | Debug user sessions |
| sysModSettings | Enable and disable system modules |
| table | Display grid data as a two dimensional table |
| text | Display grid data as preformatted plain text |
| threads | Debug thread traces and deadlocks |
| tile | Display subviews using a preconfigured tile layout |
def
addOn
Feature which may be enabled or disabled at runtime
meta
| def | addOn |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
alsoSee
Legacy tag definitions
meta
| def | alsoSee |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
app
UI application grouping of views. See Apps
meta
| def | app |
| icon | app |
| is | feature |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
def
appName
View containing app name
meta
| def | appName |
| is | str |
| lib | lib:skyarc |
| uiInput | ui::AppNameInput |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
app:builder
Views used to build the database
meta
| def | app:builder |
| disKey | ui::builder |
| icon | compassDraft |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:code
Views used to edit and manage the function library
meta
| def | app:code |
| disKey | ui::code |
| icon | ide |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:conn
Views used to manage and debug connectors
meta
| def | app:conn |
| disKey | ui::connector |
| icon | conn |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:debug
Views used for system diagnostics
meta
| def | app:debug |
| disKey | ui::debug |
| icon | debug |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:doc
Views used to browse the documentation
meta
| def | app:doc |
| disKey | ui::doc |
| icon | help |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:favs
Views used to browse and manage your saved favorites
meta
| def | app:favs |
| disKey | ui::favorites |
| icon | star |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:home
Home screen showing the available applications
meta
| def | app:home |
| disKey | ui::home |
| icon | home |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:host
Views used to manage the system which hosts the software
meta
| def | app:host |
| disKey | ui::host |
| icon | host |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:misc
Container for ad hoc views
meta
| def | app:misc |
| disKey | ui::misc |
| icon | folder |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:monitor
Views used to visualize real-time point data
meta
| def | app:monitor |
| disKey | ui::monitor |
| icon | gauge |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:platform
Platform level configuration and management
meta
| def | app:platform |
| disKey | ui::platform |
| icon | cpu |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:settings
Views used to edit SysMod and Ext settings
meta
| def | app:settings |
| disKey | ui::settings |
| icon | settings |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:tools
Views used for administration including the Axon shell
meta
| def | app:tools |
| disKey | ui::tools |
| icon | toolbox |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
app:users
Views used to manage user accounts
meta
| def | app:users |
| disKey | ui::user |
| icon | user |
| is | app |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| app | UI application grouping of views |
def
auditCommit
Log each time a diff is committed to the folio database. See Security.
meta
| def | auditCommit |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
beta
Indicates a beta quality definition. Beta features might not should be used with caution as they might not provide production quality or might change over time.
meta
| def | beta |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
color
Color encoded as #RRGGBB, #RGB, or a CSS color keyword
meta
| def | color |
| is | str |
| lib | lib:skyarc |
| tagOn | rule |
| uiInput | ui::ColorInput |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
confirm
Used on actions to prompt for confirmation. Value is dict with following tags:
- icon: logical icon name (typically "warn")
- dis/disKey: display title for the confirmation dialog
- details/detailsKey: additional details
meta
| def | confirm |
| is | dict |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| dict | Map of name/value tag pairs |
def
curRule
Marker tag for a cur rule type. See rule.
meta
| def | curRule |
| is | ruleType |
| lib | lib:skyarc |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ruleType | Rule type choice |
def
currency
The currency unit related to the entity
meta
| def | currency |
| enum | See below |
| is | unit |
| lib | lib:skyarc |
| tagOn | tariff |
| uiInput | ui::UnitInput |
enum
| % | percent (dimensionless) |
| %RH | percent_relative_humidity (dimensionless) |
| px | pixel (dimensionless) |
| db | decibel (dimensionless) |
| pf | power_factor (dimensionless) |
| pH | ph (dimensionless) |
| gH₂O/kgAir | grams_of_water_per_kilogram_dry_air (dimensionless) |
| V/K | volts_per_degree_kelvin (dimensionless) |
| °daysC | degree_days_celsius (dimensionless) |
| °daysF | degree_days_fahrenheit (dimensionless) |
| %obsc/ft | percent_obscuration_per_foot (dimensionless) |
| %obsc/m | percent_obscuration_per_meter (dimensionless) |
| psi/°F | psi_per_degree_fahrenheit (dimensionless) |
| m²/N | square_meters_per_newton (dimensionless) |
| W/m²K | watts_per_square_meter_degree_kelvin (dimensionless) |
| dBmV | db_millivolt (dimensionless) |
| dBµV | db_microvolt (dimensionless) |
| ppu | parts_per_unit (dimensionless) |
| ppm | parts_per_million (dimensionless) |
| ppb | parts_per_billion (dimensionless) |
| g/kg | grams_per_kilogram (dimensionless) |
| rad | radian (dimensionless) |
| deg | degrees_angular (dimensionless) |
| degPh | degrees_phase (dimensionless) |
| sr | steradian (dimensionless) |
| ntu | nephelometric_turbidity_units (dimensionless) |
| fnu | formazin_nephelometric_unit (dimensionless) |
| PUE | power_usage_effectiveness (dimensionless) |
| DCIE | data_center_infrastructure_efficiency (dimensionless) |
| Af | afghani (currency) |
| DZD | algerian_dinar (currency) |
| ARS | argentine_peso (currency) |
| Դ | armenian_dram (currency) |
| ƒ | aruban_guilder_florin (currency) |
| AUD | australian_dollar (currency) |
| ман | azerbaijanian_manat (currency) |
| BSD | bahamian_dollar (currency) |
| BHD | bahraini_dinar (currency) |
| ฿ | baht (currency) |
| PAB | balboa (currency) |
| BBD | barbados_dollar (currency) |
| Br | belarussian_ruble (currency) |
| BZD | belize_dollar (currency) |
| BMD | bermudian_dollar (currency) |
| VEF | bolivar_fuerte (currency) |
| BOB | boliviano (currency) |
| R$ | brazilian_real (currency) |
| BND | brunei_dollar (currency) |
| лв | bulgarian_lev (currency) |
| BIF | burundi_franc (currency) |
| CAD | canadian_dollar (currency) |
| CVE | cape_verde_escudo (currency) |
| KYD | cayman_islands_dollar (currency) |
| ₵ | cedi (currency) |
| XAF | cfa_franc_bceao (currency) |
| XPF | cfp_franc (currency) |
| CLP | chilean_peso (currency) |
| 元 | chinese_yuan (currency) |
| CDF | congolese_franc (currency) |
| C$ | cordoba_oro (currency) |
| ₡ | costa_rican_colon (currency) |
| Kn | croatian_kuna (currency) |
| CUP | cuban_peso (currency) |
| Kč | czech_koruna (currency) |
| GMD | dalasi (currency) |
| kr | danish_krone (currency) |
| ден | denar (currency) |
| DJF | djibouti_franc (currency) |
| Db | dobra (currency) |
| DOP | dominican_peso (currency) |
| ₫ | dong (currency) |
| XCD | east_caribbean_dollar (currency) |
| EGP | egyptian_pound (currency) |
| ETB | ethiopian_birr (currency) |
| € | euro (currency) |
| FKP | falkland_islands_pound (currency) |
| FJD | fiji_dollar (currency) |
| HUF | forint (currency) |
| GIP | gibraltar_pound (currency) |
| HTG | gourde (currency) |
| ₲ | guarani (currency) |
| GNF | guinea_franc (currency) |
| GYD | guyana_dollar (currency) |
| HKD | hong_kong_dollar (currency) |
| ₴ | hryvnia (currency) |
| Kr | iceland_krona (currency) |
| ₹ | indian_rupee (currency) |
| IRR | iranian_rial (currency) |
| IQD | iraqi_dinar (currency) |
| JMD | jamaican_dollar (currency) |
| JOD | jordanian_dinar (currency) |
| Sh | kenyan_shilling (currency) |
| PGK | kina (currency) |
| ₭ | kip (currency) |
| КМ | konvertibilna_marka (currency) |
| KWD | kuwaiti_dinar (currency) |
| MK | kwacha (currency) |
| Kz | kwanza (currency) |
| MMK | kyat (currency) |
| ლ | lari (currency) |
| LBP | lebanese_pound (currency) |
| ALL | lek (currency) |
| HNL | lempira (currency) |
| Le | leone (currency) |
| RON | leu (currency) |
| LRD | liberian_dollar (currency) |
| LYD | libyan_dinar (currency) |
| SZL | lilangeni (currency) |
| LSL | loti (currency) |
| MGA | malagasy_ariary (currency) |
| RM | malaysian_ringgit (currency) |
| TMT | manat (currency) |
| MUR | mauritius_rupee (currency) |
| MTn | metical (currency) |
| MXN | mexican_peso (currency) |
| MDL | moldavian_leu (currency) |
| MAD | moroccan_dirham (currency) |
| ₦ | naira (currency) |
| Nfk | nakfa (currency) |
| NAD | namibia_dollar (currency) |
| NPR | nepalese_rupee (currency) |
| ₪ | new_israeli_shekel (currency) |
| NZD | new_zealand_dollar (currency) |
| BTN | ngultrum (currency) |
| KPW | north_korean_won (currency) |
| NOK | norwegian_krone (currency) |
| PEN | nuevo_sol (currency) |
| UM | ouguiya (currency) |
| ₨ | pakistan_rupee (currency) |
| MOP | pataca (currency) |
| UYU | peso_uruguayo (currency) |
| ₱ | philippine_peso (currency) |
| £ | pound_sterling (currency) |
| BWP | pula (currency) |
| zł | pzloty (currency) |
| QAR | qatari_rial (currency) |
| GTQ | quetzal (currency) |
| ZAR | rand (currency) |
| OMR | rial_omani (currency) |
| KHR | riel (currency) |
| MVR | rufiyaa (currency) |
| Rp | rupiah (currency) |
| RUB | russian_ruble (currency) |
| RWF | rwanda_franc (currency) |
| SHP | saint_helena_pound (currency) |
| SAR | saudi_riyal (currency) |
| din | serbian_dinar (currency) |
| SCR | seychelles_rupee (currency) |
| SGD | singapore_dollar (currency) |
| SBD | solomon_islands_dollar (currency) |
| KGS | som (currency) |
| SOS | somali_shilling (currency) |
| ЅМ | somoni (currency) |
| ₩ | south_korean_won (currency) |
| Rs | sri_lanka_rupee (currency) |
| SDG | sudanese_pound (currency) |
| SRD | suriname_dollar (currency) |
| SEK | swedish_krona (currency) |
| SFr | swiss_franc (currency) |
| SYP | syrian_pound (currency) |
| TWD | taiwan_dollar (currency) |
| ৳ | taka (currency) |
| WST | tala (currency) |
| TZS | tanzanian_shilling (currency) |
| 〒 | tenge (currency) |
| TTD | trinidad_and_tobago_dollar (currency) |
| ₮ | tugrik (currency) |
| TND | tunisian_dinar (currency) |
| ₤ | turkish_lira (currency) |
| AED | uae_dirham (currency) |
| UGX | uganda_shilling (currency) |
| $ | us_dollar (currency) |
| UZS | uzbekistan_sum (currency) |
| Vt | vatu (currency) |
| YER | yemeni_rial (currency) |
| ¥ | yen (currency) |
| ZK | zambian_kwacha (currency) |
| ZWL | zimbabwe_dollar (currency) |
| m/s² | meters_per_second_squared (acceleration) |
| rad/s² | radians_per_second_squared (angular acceleration) |
| Js | joule_second (angular momentum) |
| rad/s | radians_per_second (angular velocity) |
| rpm | revolutions_per_minute (angular velocity) |
| m² | square_meter (area) |
| mm² | square_millimeter (area) |
| cm² | square_centimeter (area) |
| km² | square_kilometer (area) |
| in² | square_inch (area) |
| ft² | square_foot (area) |
| yd² | square_yard (area) |
| mile² | square_mile (area) |
| acre | acre (area) |
| F | farad (capacitance) |
| COP | coefficient_of_performance (cooling efficiency) |
| EER | energy_efficiency_ratio (cooling efficiency) |
| kW/ton | kilowatt_per_ton (cooling efficiency) |
| kg/m³ | kilograms_per_cubic_meter (density) |
| g/m³ | grams_per_cubic_meter (density) |
| mg/m³ | milligrams_per_cubic_meter (density) |
| µg/m³ | micrograms_per_cubic_meter (density) |
| kg/L | kilograms_per_liter (density) |
| mg/L | milligrams_per_liter (density) |
| C | coulomb (electric charge) |
| Ah | ampere_hour (electric charge) |
| S | siemens (electric conductance) |
| A | ampere (electric current) |
| mA | milliampere (electric current) |
| Am² | ampere_square_meter (electromagnetic moment) |
| A/m² | amperes_per_square_meter (electric current density) |
| V/m | volts_per_meter (electric field strength) |
| V | volt (electric potential) |
| mV | millivolt (electric potential) |
| kV | kilovolt (electric potential) |
| MV | megavolt (electric potential) |
| Ω | ohm (electric resistance) |
| kΩ | kilohm (electric resistance) |
| MΩ | megohm (electric resistance) |
| mΩ | milliohm (electric resistance) |
| S/m | siemens_per_meter (electrical conductivity) |
| Ωm | ohm_meter (electrical resistivity) |
| J | joule (energy) |
| kJ | kilojoule (energy) |
| Wh | watt_hour (energy) |
| kWh | kilowatt_hour (energy) |
| MWh | megawatt_hour (energy) |
| GWh | gigawatt_hour (energy) |
| BTU | btu (energy) |
| kBTU | kilobtu (energy) |
| MMBTU | megabtu (energy) |
| hph | horsepower_hour (energy) |
| cal | calorie (energy) |
| therm | therm (energy) |
| tonrefh | tons_refrigeration_hour (energy) |
| MJ | megajoule (energy) |
| GJ | gigajoule (energy) |
| Nm | newton_meter (energy) |
| m³_gas | cubic_meters_natural_gas (energy) |
| ft³_gas | cubic_feet_natural_gas (energy) |
| Hcf_natural_gas | hundred_cubic_feet_natural_gas (energy) |
| Ccf_natural_gas | centum_cubic_feet_natural_gas (energy) |
| Mcf_natural_gas | thousand_cubic_feet_natural_gas (energy) |
| MMcf_natural_gas | million_cubic_feet_natural_gas (energy) |
| VAh | volt_ampere_hour (apparent energy) |
| kVAh | kilovolt_ampere_hour (apparent energy) |
| MVAh | megavolt_ampere_hour (apparent energy) |
| VARh | volt_ampere_reactive_hour (reactive energy) |
| kVARh | kilovolt_ampere_reactive_hour (reactive energy) |
| MVARh | megavolt_ampere_reactive_hour (reactive energy) |
| J/m² | joules_per_square_meter (energy by area) |
| Wh/m² | watt_hours_per_square_meter (energy by area) |
| Wh/ft² | watt_hours_per_square_foot (energy by area) |
| kWh/m² | kilowatt_hours_per_square_meter (energy by area) |
| kWh/ft² | kilowatt_hours_per_square_foot (energy by area) |
| MWh/m² | megawatt_hours_per_square_meter (energy by area) |
| MWh/ft² | megawatt_hours_per_square_foot (energy by area) |
| MJ/m² | megajoules_per_square_meter (energy by area) |
| MJ/ft² | megajoules_per_square_foot (energy by area) |
| BTU/ft² | btu_per_square_foot (energy by area) |
| kBTU/ft² | kilobtu_per_square_foot (energy by area) |
| MBTU/ft² | megabtu_per_square_foot (energy by area) |
| J/m³ | joules_per_cubic_meter (energy by volume) |
| GJ/m³ | gigajoules_per_cubic_meter (energy by volume) |
| kWh/m³ | kilowatt_hours_per_cubic_meter (energy by volume) |
| J/g | joules_per_gram (enthalpy) |
| J/kg | joules_per_kilogram (enthalpy) |
| J/kg_dry | joules_per_kilogram_dry_air (enthalpy) |
| BTU/lb | btu_per_pound (enthalpy) |
| btu/lb_dry | btus_per_pound_dry_air (enthalpy) |
| kJ/kg | kilojoules_per_kilogram (enthalpy) |
| kJ/kg_dry | kilojoules_per_kilogram_dry_air (enthalpy) |
| MJ/kg_dry | megajoules_per_kilogram_dry_air (enthalpy) |
| cal/g | calorie_per_gram (enthalpy) |
| J/°K | joules_per_degree_kelvin (entropy) |
| kJ/°K | kilojoules_per_degree_kelvin (entropy) |
| MJ/°K | megajoules_per_degree_kelvin (entropy) |
| N | newton (force) |
| lbf | pound_force (force) |
| Hz | hertz (frequency) |
| kHz | kilohertz (frequency) |
| cph | cycles_per_hour (frequency) |
| cpm | cycles_per_minute (frequency) |
| MHz | megahertz (frequency) |
| /min | per_minute (frequency) |
| /s | per_second (frequency) |
| /h | per_hour (frequency) |
| %/s | percent_per_second (frequency) |
| ACH | air_changes_per_hour (frequency) |
| kg/m² | kilograms_per_square_meter (grammage) |
| g/m² | grams_per_square_meter (grammage) |
| K/s | degrees_kelvin_per_second (heating rate) |
| °C/h | degrees_celsius_per_hour (heating rate) |
| °C/min | degrees_celsius_per_minute (heating rate) |
| °F/h | degrees_fahrenheit_per_hour (heating rate) |
| °F/min | degrees_fahrenheit_per_minute (heating rate) |
| K/h | degrees_kelvin_per_hour (heating rate) |
| K/min | degrees_kelvin_per_minute (heating rate) |
| lx | lux (illuminance) |
| fc | footcandle (illuminance) |
| phot | phot (illuminance) |
| H | henry (inductance) |
| W/m²_irr | watts_per_square_meter_irradiance (irradiance) |
| W/ft²_irr | watts_per_square_foot_irradiance (irradiance) |
| m | meter (length) |
| µm | micrometer (length) |
| mm | millimeter (length) |
| cm | centimeter (length) |
| km | kilometer (length) |
| in | inch (length) |
| ft | foot (length) |
| yd | yard (length) |
| mile | mile (length) |
| cd/m² | candelas_per_square_meter (luminance) |
| cd/ft² | candels_per_square_foot (luminance) |
| lm | lumen (luminous flux) |
| cd | candela (luminous intensity) |
| A/m | amperes_per_meter (magnetic field strength) |
| Wb | weber (magnetic flux) |
| T | tesla (magnetic flux density) |
| kg | kilogram (mass) |
| mg | milligram (mass) |
| g | gram (mass) |
| oz | ounce (mass) |
| lb | pound (mass) |
| klb | kilopound (mass) |
| ton | metric_ton (mass) |
| t | short_ton (mass) |
| kg/s | kilograms_per_second (mass flow) |
| kg/min | kilograms_per_minute (mass flow) |
| kg/h | kilograms_per_hour (mass flow) |
| lb/min | pounds_per_minute (mass flow) |
| lb/h | pounds_per_hour (mass flow) |
| lb/s | pounds_per_second (mass flow) |
| klb/h | kilopounds_per_hour (mass flow) |
| g/s | grams_per_second (mass flow) |
| g/min | grams_per_minute (mass flow) |
| ton/h | metric_tons_per_hour (mass flow) |
| Ns | newton_second (momentum) |
| W | watt (power) |
| mW | milliwatt (power) |
| kW | kilowatt (power) |
| MW | megawatt (power) |
| GW | gigawatt (power) |
| BTU/h | btus_per_hour (power) |
| therm/h | therms_per_hour (power) |
| hp | horsepower (power) |
| ftlbs/sec | foot_pounds_per_second (power) |
| tonref | tons_refrigeration (power) |
| kBTU/h | kilobtus_per_hour (power) |
| MMBTU/h | megabtus_per_hour (power) |
| J/h | joules_per_hour (power) |
| kJ/h | kilojoules_per_hour (power) |
| MJ/h | megajoules_per_hour (power) |
| GJ/h | gigajoules_per_hour (power) |
| W/m² | watts_per_square_meter (power by area) |
| W/ft² | watts_per_square_foot (power by area) |
| kW/m² | kilowatts_per_square_meter (power by area) |
| kW/ft² | kilowatts_per_square_foot (power by area) |
| kBTU/h/ft² | kilobtus_per_hour_per_square_foot (power by area) |
| W/m³/s | watts_per_cubic_meters_per_second (power by volumetric flow) |
| W/cfm | watts_per_cubic_feet_per_minute (power by volumetric flow) |
| kW/kcfm | kilowatts_per_kilocubic_feet_per_minute (power by volumetric flow) |
| kW/gal/min | kilowatts_per_gallons_per_minute (power by volumetric flow) |
| VA | volt_ampere (apparent power) |
| kVA | kilovolt_ampere (apparent power) |
| mVA | megavolt_ampere (apparent power) |
| VAR | volt_ampere_reactive (reactive power) |
| kVAR | kilovolt_ampere_reactive (reactive power) |
| MVAR | megavolt_ampere_reactive (reactive power) |
| Pa | pascal (pressure) |
| kPa | kilopascal (pressure) |
| bar | bar (pressure) |
| atm | atmosphere (pressure) |
| psi | pounds_per_square_inch (pressure) |
| cmH₂O | centimeters_of_water (pressure) |
| inH₂O | inches_of_water (pressure) |
| mmHg | millimeters_of_mercury (pressure) |
| cmHg | centimeters_of_mercury (pressure) |
| inHg | inches_of_mercury (pressure) |
| hPa | hectopascal (pressure) |
| mbar | millibar (pressure) |
| J/kg°K | joules_per_kilogram_degree_kelvin (specific entropy) |
| N/m | newtons_per_meter (surface tension) |
| °F | fahrenheit (temperature) |
| °C | celsius (temperature) |
| K | kelvin (temperature) |
| Δ°F | fahrenheit_degrees (temperature differential) |
| Δ°C | celsius_degrees (temperature differential) |
| ΔK | kelvin_degrees (temperature differential) |
| W/m°K | watts_per_meter_degree_kelvin (thermal conductivity) |
| ns | nanosecond (time) |
| µs | microsecond (time) |
| ms | millisecond (time) |
| cs | hundredths_second (time) |
| ds | tenths_second (time) |
| sec | second (time) |
| min | minute (time) |
| hr | hour (time) |
| day | day (time) |
| wk | week (time) |
| mo | julian_month (time) |
| yr | year (time) |
| m/s | meters_per_second (velocity) |
| km/s | kilometers_per_second (velocity) |
| km/h | kilometers_per_hour (velocity) |
| mph | miles_per_hour (velocity) |
| ft/s | feet_per_second (velocity) |
| ft/min | feet_per_minute (velocity) |
| in/h | inches_per_hour (velocity) |
| mm/s | millimeters_per_second (velocity) |
| mm/min | millimeters_per_minute (velocity) |
| mm/h | millimeters_per_hour (velocity) |
| m/min | meters_per_minute (velocity) |
| m/h | meters_per_hour (velocity) |
| knot | knot (velocity) |
| cfm/ft² | cubic_feet_per_minute_per_square_foot (velocity) |
| m³ | cubic_meter (volume) |
| mm³ | cubic_millimeter (volume) |
| cm³ | cubic_centimeter (volume) |
| mL | milliliter (volume) |
| hL | hectoliter (volume) |
| L | liter (volume) |
| kL | kiloliter (volume) |
| in³ | cubic_inch (volume) |
| ft³ | cubic_foot (volume) |
| yd³ | cubic_yard (volume) |
| gal | gallon (volume) |
| kgal | kilogallon (volume) |
| qt | quart (volume) |
| pt | pint (volume) |
| fl_oz | fluid_ounce (volume) |
| galUK | imperial_gallon (volume) |
| hft³ | hecto_cubic_foot (volume) |
| Hcf | hundred_cubic_feet (volume) |
| Ccf | centum_cubic_feet (volume) |
| Mcf | thousand_cubic_feet (volume) |
| MMcf | million_cubic_feet (volume) |
| m³/s | cubic_meters_per_second (volumetric flow) |
| mL/s | milliliters_per_second (volumetric flow) |
| hL/s | hectoliters_per_second (volumetric flow) |
| L/s | liters_per_second (volumetric flow) |
| cfs | cubic_feet_per_second (volumetric flow) |
| cfm | cubic_feet_per_minute (volumetric flow) |
| cfh | cubic_feet_per_hour (volumetric flow) |
| kcfm | kilocubic_feet_per_minute (volumetric flow) |
| galUK/min | imperial_gallons_per_minute (volumetric flow) |
| L/min | liters_per_minute (volumetric flow) |
| gal/min | gallons_per_minute (volumetric flow) |
| gph | gallons_per_hour (volumetric flow) |
| L/h | liters_per_hour (volumetric flow) |
| m³/min | cubic_meters_per_minute (volumetric flow) |
| m³/h | cubic_meters_per_hour (volumetric flow) |
| byte | byte (bytes) |
| kB | kilobyte (bytes) |
| MB | megabyte (bytes) |
| GB | gigabyte (bytes) |
| TB | terabyte (bytes) |
| PB | petabyte (bytes) |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
| unit | Unit identifier from standard unit database |
def
defName
Specifies definition symbol name to use
meta
| def | defName |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
defVal
Default value
meta
| def | defVal |
| is | val |
| lib | lib:skyarc |
| tagOn | finSetting |
supertypes
| val | Data value type |
def
email
An email address
meta
| def | |
| is | str |
| lib | lib:skyarc |
| tagOn | user |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
enumExpr
Axon expression to dynamically compute an enum. This tag is used on view inputs to display a dropdown that is populated via a call to the server. The function should return one of the standardized enum value types (typically a list of strings).
Example:
// Axon function that generates an enum from site names
getSiteEnum: () => do
readAll(site).toRecList.map(s=>s.dis)
end
// Input variable in a view which uses that enum
dynamicEnum: {var input kind:"Str" enumExpr:"getSiteEnum()"}meta
| def | enumExpr |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
enumx
Extened enum tag definitions
meta
| def | enumx |
| is | dict |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| dict | Map of name/value tag pairs |
def
expires
Expiration date
meta
| def | expires |
| is | date |
| lib | lib:skyarc |
| tagOn | user |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| date | ISO 8601 date as year, month, day |
def
ext
Extension library. Exts are enabled on a per project basis. See Exts
meta
| def | ext |
| is | lib |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| lib | Library module of symbolic definitions |
tags
| baseUri | Base URI for normalizing relative URIs |
| connTuningRef | Reference to a tuning configuration defined by a connTuning rec |
| depends | List of this library's dependencies |
| libStatus | Current status of an extension or sys module library |
| version | Version string formatted as decimal integers separated by a dot |
def
fav
Favorite saved view link.
meta
| def | fav |
| is | entity |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
| entity | Top-level dicts with a unique identifier |
tags
| 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 |
| viewLink | View name and state for linking to a saved view |
def
filetype:html
HyperText Markup Language
meta
| def | filetype:html |
| dis | HTML |
| fileExt | html |
| icon | html |
| is | filetype |
| lib | lib:skyarc |
| mime | text/html |
| writer | view::HtmlWriter |
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 |
def
filetype:pdf
Portable Document Format
meta
| def | filetype:pdf |
| dis | |
| fileExt | |
| icon | worksheet |
| is | filetype |
| lib | lib:skyarc |
| mime | application/pdf |
| optsTemplate | pdfOpts |
| writer | view::PdfWriter |
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 |
def
filetype:svg
Scalable Vector Graphics
meta
| def | filetype:svg |
| dis | SVG |
| fileExt | svg |
| icon | paintBrush |
| is | filetype |
| lib | lib:skyarc |
| mime | image/svg+xml |
| optsTemplate | svgOpts |
| writer | view::SvgWriter |
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 |
def
fontWeight
Font weight setting
meta
| def | fontWeight |
| is | str |
| lib | lib:skyarc |
| uiInput | ui::FontWeightInput |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
func:actionNormInput
actionNormInput(arg, type)
Normalize action input - see Committer.actionNormInput
meta
| def | func:actionNormInput |
| is | func |
| lib | lib:skyarc |
| name | actionNormInput |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:chart
chart(val)
Set the grid visualization view to chart.
meta
| def | func:chart |
| is | func |
| lib | lib:skyarc |
| name | chart |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:deprecatedTags
deprecatedTags()
Return tags which have been deprecated as grid with following columns:
- old: original name of tag deprecated
- new: new tag name which should be used or Remove.val
- version: SkySpark version when tag was tag was deprecated
- comment: free form comments about the deprecation
This function can be paired with renameTags() to script migration.
meta
| admin | ✓ |
| def | func:deprecatedTags |
| is | func |
| lib | lib:skyarc |
| name | deprecatedTags |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:ext
ext(name, checked: true)
Return extension record for given extension name. If extension is not enabled then raise exception or return null based on checked flag.
Examples:
ext("haystack") // rec for haystack extensions
ext("haystack", false) // return null if haystack not enabledmeta
| admin | ✓ |
| def | func:ext |
| is | func |
| lib | lib:skyarc |
| name | ext |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:extAdd
extAdd(name)
Enable the given extension name or list of names. All dependencies must be already enabled.
Examples:
extAdd("bacnet")
extAdd(["bacnet", "opc"])meta
| admin | ✓ |
| def | func:extAdd |
| is | func |
| lib | lib:skyarc |
| name | extAdd |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:extRemove
extRemove(name)
Disable the given extension name or list of names. Raise exception if other extensions currently depend on this one.
Examples:
extRemove("bacnet")
extRemove(["bacnet", "opc"])meta
| admin | ✓ |
| def | func:extRemove |
| is | func |
| lib | lib:skyarc |
| name | extRemove |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:extSettings
extSettings(extName, opts: {})
Return ext settings form data - see Exts
meta
| admin | ✓ |
| def | func:extSettings |
| is | func |
| lib | lib:skyarc |
| name | extSettings |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:extSettingsCommit
extSettingsCommit(arg)
Submit function for extSettings() - see Exts
meta
| admin | ✓ |
| def | func:extSettingsCommit |
| is | func |
| lib | lib:skyarc |
| name | extSettingsCommit |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:exts
exts()
Get the list of exts and their current status. Result format is subject to change
meta
| def | func:exts |
| is | func |
| lib | lib:skyarc |
| name | exts |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:feed
feed(stream)
Convert a stream into a live feed to populate a view. See Streams
meta
| def | func:feed |
| is | func |
| lib | lib:skyarc |
| name | feed |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:hostMeta
hostMeta()
Read host metadata dict
meta
| def | func:hostMeta |
| is | func |
| lib | lib:skyarc |
| name | hostMeta |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:hostVars
hostVars()
Read host variables dict. This is an arbitary dict of user defined host-level configuration variables which may be configured in the Settings | Host view.
meta
| def | func:hostVars |
| is | func |
| lib | lib:skyarc |
| name | hostVars |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:licStatus
licStatus()
Return current licensing status as Dict with following tags:
- dis: summary of licensing status
- mode: status string
- usage: current point usage across projects
- points: licensing capacity
- level: info, warn, or err
- devOnly: marker if development only license
meta
| def | func:licStatus |
| is | func |
| lib | lib:skyarc |
| name | licStatus |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:lint
lint(recs, opts: null)
Run the lint report on the given recs. Recs may be any value accepted by toRecList() or if null then lint is run on the entire project. By default lint will only run for 10sec or until it finds 1000 issues. You can adjust these limts via the opts parameter:
- timeout: max amount of time to run lint (10sec default)
- limit: max number of issues (1000 default)
Pass {-timeout, -limit} to remove the timeout and limit.
Results are returned as grid with the following columns:
- id: record id
- tag: tag name with the lint issue
- logLevel: either "warn" or "err"
- msg: issue as string
meta
| def | func:lint |
| is | func |
| lib | lib:skyarc |
| name | lint |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:pivot
pivot(input, shape)
Transform a grid to a pivot table - see Axon Usage. Note: column names and meta are subject to change.
meta
| def | func:pivot |
| is | func |
| lib | lib:skyarc |
| name | pivot |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:projSync
projSync(timeout: null)
Block until all folio/project message queues are fully processed.
meta
| admin | ✓ |
| def | func:projSync |
| is | func |
| lib | lib:skyarc |
| name | projSync |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:recDelete
recDelete(refs)
Record delete action. This function implicitly operates on all contained recs. NOTE: this function should only be used for actions.
meta
| admin | ✓ |
| confirm | |
| def | func:recDelete |
| disKey | ui::delete |
| is | func |
| lib | lib:skyarc |
| multi | ✓ |
| name | recDelete |
| select | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:recDisable
recDisable(refs)
Record disable action. NOTE: this function should only be used for actions.
meta
| admin | ✓ |
| def | func:recDisable |
| disKey | ui::disable |
| is | func |
| lib | lib:skyarc |
| multi | ✓ |
| name | recDisable |
| select | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:recDup
recDup(refs)
Record duplicate action. This function implicitly operates on all contained recs. NOTE: this function should only be used for actions.
meta
| admin | ✓ |
| confirm | |
| def | func:recDup |
| disKey | ui::duplicate |
| is | func |
| lib | lib:skyarc |
| multi | ✓ |
| name | recDup |
| select | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:recEdit
recEdit(dict)
Record edit action. NOTE: this function should only be used for actions.
meta
| admin | ✓ |
| def | func:recEdit |
| disKey | ui::edit |
| is | func |
| lib | lib:skyarc |
| multi | ✓ |
| name | recEdit |
| select | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:recEnable
recEnable(refs)
Record enable action. NOTE: this function should only be used for actions.
meta
| admin | ✓ |
| def | func:recEnable |
| disKey | ui::enable |
| is | func |
| lib | lib:skyarc |
| multi | ✓ |
| name | recEnable |
| select | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:recForm
recForm(rec, templateName, opts: null)
Return a data grid for a form view to edit the specified record. If the record is null a new default one is created from the template. See recFormCommit() for the submit action function. TODO: subject to change
meta
| def | func:recForm |
| is | func |
| lib | lib:skyarc |
| name | recForm |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:recFormCommit
recFormCommit(dict)
Commit a rec based form to Folio. Also see recForm() TODO: subject to change
meta
| admin | ✓ |
| def | func:recFormCommit |
| is | func |
| lib | lib:skyarc |
| name | recFormCommit |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:recNew
recNew(dict)
Record create action. NOTE: this function should only be used for actions.
meta
| admin | ✓ |
| def | func:recNew |
| disKey | ui::new |
| is | func |
| lib | lib:skyarc |
| name | recNew |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:recTrash
recTrash(refs)
Record trash action. This function implicitly operates on all contained recs. NOTE: this function should only be used for actions.
meta
| admin | ✓ |
| confirm | |
| def | func:recTrash |
| disKey | ui::trash |
| is | func |
| lib | lib:skyarc |
| multi | ✓ |
| name | recTrash |
| select | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:renameTags
renameTags(recs, renames, opts: null)
Rename a set of tags on a list of records or across the entire project database. This function is easily paired with deprecatedTags() to preview and fix standard tags which are deprecated over time.
The recs parameters specify the recs for the operation. Or pass null to rename every rec in the project database.
The renames parameter may be any of the following shapes:
- Dict of old to new tag names
- Grid with
oldandnewcolumns
If the new value is a string, then the tag is renamed to the given new name. If new value is the Remove value then the tag is simply removed (only if removeOld option passed). If the new value is a conjuct formatted as "foo-bar-baz", then each part is created as a marker tag.
Summary of options:
- commit: marker to force commit (preview by default)
- removeOld: remove the old tag (old tag left by default)
- limit: number of diffs (defaults to 1000)
The default behavior is to preview the changes only and to leave the old tags in place side-by-side with the new tags. To apply the changes pass the commit option. To force removal of the old tags pass the removeOld.
As a saftey measure no more than 1000 diffs are previewed or committed. You can remove the limit by passing -limit in the options. However if removing the limit in a large project, then both thew preview or commit results might be too large to view in the Shell view. In this case, pipe the results to a file using ioWriteZinc().
Examples:
// rename of foo -> bar across all records
// opts: preview, leave old tag, limit 1000
renameTags(null, {foo: "bar"})
// rename of foo -> bar across all records
// opts: commit, remove old tag, no limit
renameTags(null, {foo: "bar"}, {commit, removeOld, -limit})
// remove of foo across all points
// opts: preview, remove old tag, limit 10
readAll(point).renameTags({-foo}, {removeOld, limit:10})
// rename of elecMeter -> elec + meter and steamPlant -> steam + plant
// across all equip records
readAll(equip).renameTags({elecMeter: "elec-meter", steamPlant: "steam-plant"})
// combine with deprecatedTags() to rename all deprecated tags
// and pipe results to a zinc file in the io/ directory
renameTags(null, deprecatedTags()).ioWriteZinc(`io/rename-log.zinc`)meta
| admin | ✓ |
| def | func:renameTags |
| is | func |
| lib | lib:skyarc |
| name | renameTags |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:sysModAdd
sysModAdd(name, opts: null)
Enable the given system module name such as "ldap". All dependencies must be already enabled.
meta
| def | func:sysModAdd |
| is | func |
| lib | lib:skyarc |
| name | sysModAdd |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:sysModRemove
sysModRemove(name, opts: null)
Disable the given system module name. Raise exception if it is a boot module or it is required for dependencies.
meta
| def | func:sysModRemove |
| is | func |
| lib | lib:skyarc |
| name | sysModRemove |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:sysMods
sysMods()
List the installed system mods. Result format is subject to change
meta
| def | func:sysMods |
| is | func |
| lib | lib:skyarc |
| name | sysMods |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:sysReload
sysReload(podNames: null)
Force a system reload. This function takes an optional list of pod names which have been modified to reopen from disk. Only resource pods with no Fantom code can be reloaded. The reload process is:
- Reload pods specified by podNames parameter
- Reload the full list of pods to see if new pods have been added
- Rebuild the def namespace of every project
- Delete documentation if generated
We have documented this function to enable hot reloading. However it might change in the future.
Examples:
sysReload() // if adding a new pod
sysReload(["myResourceExt"]) // to reload a specific podmeta
| def | func:sysReload |
| is | func |
| lib | lib:skyarc |
| name | sysReload |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:table
table(val)
Set the grid visualization view to table.
meta
| def | func:table |
| is | func |
| lib | lib:skyarc |
| name | table |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:validateFilter
validateFilter(s)
Raise an exception if string is not valid filter
meta
| def | func:validateFilter |
| is | func |
| lib | lib:skyarc |
| name | validateFilter |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:validateNotBlank
validateNotBlank(s)
Raise an exception if string is blank
meta
| def | func:validateNotBlank |
| is | func |
| lib | lib:skyarc |
| name | validateNotBlank |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:validateTagName
validateTagName(s)
Raise an exception if string is not a validate tag name
meta
| def | func:validateTagName |
| is | func |
| lib | lib:skyarc |
| name | validateTagName |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
func:validateUsername
validateUsername(s)
Raise an excpetion if string is not a validate username
meta
| def | func:validateUsername |
| is | func |
| lib | lib:skyarc |
| name | validateUsername |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| func | Axon function |
def
halign
Horizontal layout alignment
meta
| def | halign |
| is | str |
| lib | lib:skyarc |
| uiInput | ui::HalignInput |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
haystackApi
Function which is a published Hasytack REST API op
meta
| def | haystackApi |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
help
End user documentation. The string value should be formatted in fandoc. Note that help is targetted for end users versus doc which is reference documentation targetted for developers. For example in a rule, the help tag is displayed directly to users in the UI.
meta
| def | help |
| is | str |
| lib | lib:skyarc |
| multiLine | ✓ |
| tagOn | func, rule |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
hidden
Hide a column in a table or a field on a form
meta
| def | hidden |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
hisFuncReady
Indicates a function designed to be used directly as a computed history
meta
| def | hisFuncReady |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
hisSrc
Legacy 2.1 support for function picker in History App
meta
| def | hisSrc |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
hotKey
One or more key combinations separated by a comma. Modifiers are prefixed as follows:
- Window/Linux: Ctrl+, Alt+, Meta+, Shift+
- Mac: ⌃, ⇧, ⌥, ⌘
meta
| def | hotKey |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
icon
Icon logical name - see Icons
meta
| def | icon |
| is | str |
| lib | lib:skyarc |
| uiInput | ui::IconInput |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
imageSize
Image size in pixels
meta
| def | imageSize |
| is | str |
| lib | lib:skyarc |
| tagOn | filetype:svg |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
kpiRule
Marker tag for a KPI rule type. See rule.
meta
| def | kpiRule |
| is | ruleType |
| lib | lib:skyarc |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ruleType | Rule type choice |
def
libStatus
Current status of an extension or sys module library
meta
| def | libStatus |
| enum | See below |
| is | str |
| lib | lib:skyarc |
| tagOn | sysMod, ext |
| transient | ✓ |
enum
| ok | Enabled and okay |
| err | Could not be loaded |
| fault | Configuration problem |
| warn | Degraded or inoperable functionality |
| disabled | Not enabled |
| notLoaded | Enabled, but not loaded yet |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
licStatus
License status
meta
| def | licStatus |
| enum | See below |
| is | str |
| lib | lib:skyarc |
enum
| ok | |
| warn | |
| err |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
logLevel
Severity level
meta
| def | logLevel |
| enum | See below |
| is | str |
| lib | lib:skyarc |
enum
| info | Informational |
| warn | Potential problem |
| err | Failure problem |
| debug | Tracing |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
multi
Indicates multiple selection
meta
| def | multi |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
navAuxFilter
Apply extra filter string to a navigation tree. See Nav
meta
| def | navAuxFilter |
| is | filterStr |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
| filterStr | Haystack filter string |
def
navCluster
Select from all the nodes in the cluster.
meta
| def | navCluster |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
navHidden
Hide an entity in the navigation selection pickers. Currently this is only used for project selection.
meta
| def | navHidden |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
navName
Navigation name commonly used with disMacro to create computed display strings.
meta
| def | navName |
| is | str |
| lib | lib:skyarc |
| tagOn | emission, equip, point, space, system |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
navSelAny
Select any level of a navigation tree which might include groupings. See Nav
meta
| def | navSelAny |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
navSelAnyRec
Select any level of a navigation tree which maps to Folio record. See Nav
meta
| def | navSelAnyRec |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
navTarget
Apply to a def to specify a default navigation target. This target is used along with an implicit navAuxFilter when navigating to the def. This navTarget is only used if uiMeta does not contain an explicit definition.
meta
| def | navTarget |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
navTree
Navigation tree name to use for ref tag
meta
| def | navTree |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
optional
Not required
meta
| def | optional |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
optsTemplate
TODO
meta
| def | optsTemplate |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
op:export
Export a view to a file; see Export
meta
| def | op:export |
| is | op |
| lib | lib:skyarc |
| noSideEffects | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| op | Operation for HTTP API |
def
op:ext
Ext specific HTTP servicing
meta
| def | op:ext |
| is | op |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| op | Operation for HTTP API |
def
op:rec
Get a record by id
meta
| def | op:rec |
| is | op |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| op | Operation for HTTP API |
def
order
Used to order definitions
meta
| def | order |
| is | number |
| lib | lib:skyarc |
| tagOn | finSetting |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| number | Integer or floating point numbers annotated with an optional unit |
def
pageSize
Printed page size formatted as "width,height" with an explicit unit of "pt", "in", "mm", or "cm". Examples "8.5in,11in" or "612pt,792pt"
meta
| def | pageSize |
| disKey | ui::pageSize |
| is | str |
| lib | lib:skyarc |
| tagOn | filetype:pdf |
| uiInput | ui::PageSizeInput |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
percentage
A percentage specified as as <percent> * 100
meta
| def | percentage |
| is | number |
| lib | lib:skyarc |
| tagOn | tariffPercentageCharge |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| number | Integer or floating point numbers annotated with an optional unit |
def
placeholder
Hint displayed in a text field input
meta
| def | placeholder |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
podName
Fantom pod name
meta
| def | podName |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
projIncludeFilter
Selects other projects to include in UI navigation. See Nav
meta
| def | projIncludeFilter |
| is | filterStr |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
| filterStr | Haystack filter string |
def
readonly
Indicates a value which may be read, but not written
meta
| def | readonly |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
refresh
Indicates an operation which requires a page refresh
meta
| def | refresh |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
restart
Indicates a setting which requires restart when modified
meta
| def | restart |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
ruleOn
Target filter for a rule or rule ready func.
meta
| def | ruleOn |
| is | filterStr |
| lib | lib:skyarc |
| tagOn | alarmRule, func, rule |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
| filterStr | Haystack filter string |
def
ruleType
Rule type choice
meta
| def | ruleType |
| is | choice |
| lib | lib:skyarc |
| tagOn | func, rule |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
subtypes
| curRule | Marker tag for a cur rule type |
| kpiRule | Marker tag for a KPI rule type |
| sparkRule | Marker tag for a spark rule type |
def
select
Used on an action to use current selection
meta
| def | select |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
showDis
Show display names in UI instead of programmatic names
meta
| def | showDis |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
spanModes
Restrict Span input modes. Value is string list with the following values: day, week, month, quarter, year, other, recent"
meta
| def | spanModes |
| is | list |
| lib | lib:skyarc |
| of | str |
supertypes
| val | Data value type |
| list | Ordered list of zero or more values |
def
sparkRule
Marker tag for a spark rule type. See rule.
meta
| def | sparkRule |
| is | ruleType |
| lib | lib:skyarc |
| uiInput | ui::ChoiceInput |
supertypes
| marker | Marker labels a dict with typing information |
| choice | Choice specifies an exclusive marker selection |
| ruleType | Rule type choice |
def
sysMod
System module library.
meta
| def | sysMod |
| is | lib |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| lib | Library module of symbolic definitions |
tags
| baseUri | Base URI for normalizing relative URIs |
| connTuningRef | Reference to a tuning configuration defined by a connTuning rec |
| depends | List of this library's dependencies |
| libStatus | Current status of an extension or sys module library |
| version | Version string formatted as decimal integers separated by a dot |
def
tag
Legacy backward compatible tag definitions
meta
| def | tag |
| is | feature |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
def
templateName
Template by name - legacy support
meta
| def | templateName |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
timeout
Maximum elapsed time to allow an operation to continue
meta
| def | timeout |
| is | duration |
| lib | lib:skyarc |
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
ts
Timestamp
meta
| def | ts |
| is | dateTime |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| dateTime | ISO 8601 timestamp followed by timezone identifier |
def
unitless
Hide the unit picker for a number field
meta
| def | unitless |
| is | marker |
| lib | lib:skyarc |
supertypes
| marker | Marker labels a dict with typing information |
def
usedWith
Legacy tag definitions
meta
| def | usedWith |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
validate
Axon expression to validate def
meta
| def | validate |
| is | str |
| lib | lib:skyarc |
supertypes
| val | Data value type |
| scalar | Scalar is an atomic value kind |
| str | Unicode string of characters |
def
view
Fresco UI view. See Views
meta
| def | view |
| icon | view |
| is | feature |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
tags
| admin | Requires admin permission |
| su | Requires superuser permission |
def
viewLink
View name and state for linking to a saved view
meta
| def | viewLink |
| is | dict |
| lib | lib:skyarc |
| tagOn | arc, fav |
| uiInput | ui::ViewLinkInput |
supertypes
| val | Data value type |
| dict | Map of name/value tag pairs |
def
view:alerts
Display system alerts such as licensing errors
meta
| appName | debug |
| def | view:alerts |
| disKey | ui::alerts |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"table"}
silence: {action:"alertSilence"}
data: {expr:"alerts()"}def
view:apiSettings
Settings for the API system module
meta
| appName | settings |
| def | view:apiSettings |
| disKey | ui::api |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"form"}
submit: {action:"hostCommit"}
data: {expr:"hostSettings(\"api\")"}def
view:blank
Placeholder with no content
meta
| def | view:blank |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: { uiType: "ui::BlankView" renderAs:"blank" }def
view:card
Display each row of a grid as a formatted card
meta
| def | view:card |
| disKey | ui::card |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "ui::CardView" renderAs:"card"}def
view:chart
Display grid data as a chart
meta
| def | view:chart |
| disKey | ui::chart |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "ui::ChartView" renderAs:"chart"}def
view:crypto
Manage cryto trust store
meta
| appName | host |
| def | view:crypto |
| disKey | ui::crypto |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"table"}
type: {var input kind:"Str" enum:"all,cryptoTrust,cryptoPrivKey" defVal:"all"}
trustUri: {action:"cryptoTrustUri" templateName:"cryptoTrust" hideAdd hideAdvanced}
cryptoCheckUri: {action:"cryptoCheckAction" templateName:"cryptoCheck" hideAdd hideAdvanced}
delete: {action:"cryptoEntryDelete" select multi confirm:{icon:"warn" disKey:"ui::cryptoDeleteConfirm" detailsKey: "ui::cryptoDeleteConfirmDetails"}}
rename: {action:"cryptoEntryRename" templateName:"cryptoRename" select hideAdd hideAdvanced}
addCert: {action:"uiMisc::CryptoView.onAddCert"}
showPub: {action:"cryptoShowPub" select}
data: {expr:"cryptoLocal({{type}})"}def
view:debugHost
Debug of host level system modules
meta
| appName | debug |
| def | view:debugHost |
| disKey | ui::host |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"text"}
data: {expr:"debugHost()"}def
view:debugSupport
Gather support diagnostics
meta
| appName | debug |
| def | view:debugSupport |
| disKey | ui::support |
| icon | view |
| is | view |
| lib | lib:skyarc |
| order | 900 |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"text"}
copy: {disKey: "ui::copy" action:"ui::TextView.copyToClipboard"}
data: {expr:"debugSupport()"}def
view:diag
Diagnostics dashboard with real-time graphs
meta
| appName | debug |
| def | view:diag |
| disKey | ui::diag |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "uiMisc::DiagDashboardView"}
uri: {var input kind:"Uri" defVal:`/`}
data: {expr:"diags({{uri}})"}def
view:doc
Documentation viewer
meta
| appName | doc |
| def | view:doc |
| disKey | ui::doc |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "uiMisc::DocView"}
uri: {var defVal:`/index`}def
view:emailSettings
Settings for the email system module
meta
| appName | settings |
| def | view:emailSettings |
| disKey | ui::email |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"form"}
submit: {action:"hostCommit"}
test: {action:"ui::EmailDialog.test"}
data: {expr:"hostSettings(\"email\", {password})"}def
view:fandoc
Display fandoc markup as stylized content
meta
| def | view:fandoc |
| disKey | ui::fandoc |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "ui::FandocView" renderAs:"fandoc"}def
view:form
Display a dict for editing using a form layout
meta
| def | view:form |
| disKey | ui::form |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "ui::FormView"}def
view:hostSettings
Settings for the host system module
meta
| appName | settings |
| def | view:hostSettings |
| disKey | ui::host |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"form"}
submit: {action:"hostCommit"}
data: {expr:"hostSettings(\"host\")"}def
view:httpSettings
Settings for the HTTP system module
meta
| appName | settings |
| def | view:httpSettings |
| disKey | ui::http |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"form"}
submit: {action:"hostCommit"}
data: {expr:"hostSettings(\"http\")"}def
view:iframe
Display a URI as an embedded HTML iframe
meta
| def | view:iframe |
| disKey | ui::iframe |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType:"ui::IframeView"}def
view:lics
Manage software license files
meta
| appName | host |
| def | view:lics |
| disKey | ui::lics |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "uiMisc::LicView"}
install: {disKey: "ui::install" action:"uiMisc::LicView.onInstall"}
update: {action:"licUpdate"}
uninstall: {action:"licUninstall"}
hostInfo: {action:"licHostInfo"}
status: {action:"licStatusInfo"}
show: {action:"licShow"}
eula: {action:"eula"}
data: {expr:"lics()"}def
view:log
System log browser
meta
| appName | debug |
| def | view:log |
| disKey | ui::log |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType:"uiMisc::LogView"}
span: {var input kind:"Span" defVal:Span("today")}
filter: {var input kind:"Str" defExpr:"null"}
data: {expr:"logRead({{span}}, {{filter}}, {feed})"}def
view:logSettings
Settings for the logging system module
meta
| appName | settings |
| def | view:logSettings |
| disKey | ui::log |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"form"}
submit: {action:"hostCommit"}
data: {expr:"hostSettings(\"log\")"}def
view:page
Display subviews as a linear page-oriented report
meta
| def | view:page |
| disKey | ui::page |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "ui::PageView" renderAs:"page"}def
view:pageBreak
Use in a page view to force a page break during PDF generation
meta
| def | view:pageBreak |
| disKey | ui::pageBreak |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "ui::PageBreakView" renderAs:"pageBreak"}def
view:pods
Debug all installed pod modules
meta
| appName | debug |
| def | view:pods |
| disKey | ui::pods |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"table"}
data: {expr:"pods()"}def
view:sessionSettings
Settings for the session system module
meta
| appName | settings |
| def | view:sessionSettings |
| disKey | ui::session |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"form"}
submit: {action:"hostCommit"}
data: {expr:"hostSettings(\"session\")"}def
view:sessions
Debug user sessions
meta
| appName | host |
| def | view:sessions |
| disKey | ui::sessions |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"table"}
logout: {action:"sessionLogout"}
details: {action:"sessionDetails"}
data: {expr:"sessions()"}def
view:sysModSettings
Enable and disable system modules
meta
| appName | settings |
| def | view:sysModSettings |
| disKey | ui::sysMods |
| icon | view |
| is | view |
| lib | lib:skyarc |
| order | 105 |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"table"}
enable: {disKey:"ui::enable" select multi action:"uiBuilder::LibActions.enable"}
disable: {disKey:"ui::disable" select multi action:"uiBuilder::LibActions.disable"}
data: {expr: "sysMods()"}def
view:table
Display grid data as a two dimensional table
meta
| def | view:table |
| disKey | ui::table |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "ui::TableView" renderAs:"table"}
sortCol: {var kind:"Str"}
sortDir: {var kind:"Str"}def
view:text
Display grid data as preformatted plain text
meta
| def | view:text |
| disKey | ui::text |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "ui::TextView" renderAs:"text"}def
view:threads
Debug thread traces and deadlocks
meta
| appName | debug |
| def | view:threads |
| disKey | ui::threads |
| icon | view |
| is | view |
| lib | lib:skyarc |
| su | ✓ |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {inherit:"text"}
data: {expr:"threadDump()"}def
view:tile
Display subviews using a preconfigured tile layout
meta
| def | view:tile |
| disKey | ui::tile |
| icon | view |
| is | view |
| lib | lib:skyarc |
supertypes
| feature | Feature namespace of definitions formatted as feature:name |
| view | Fresco UI view |
src
view: {uiType: "ui::TileView" renderAs:"tile"}