UI globals options (shorthand $ui.options or obj.ui.options). Each UI object gets a copy in obj.locals.ui to override the default behaviors.
- Source:
- globals.js, line 9
Namespaces
Members
-
<static> ajaxSetup
-
- Source:
- globals.js, line 42
Properties:
Name Type Description ajaxSetup
object Ajax default setup Properties
Name Type Description crossDomain
string true to use CORS request xhrFields
object optional xhr fields Properties
Name Type Description withCredentials
object credential to use the session cookie (default true) -
<static> container
-
- Source:
- globals.js, line 22
Properties:
Name Type Description container
string UI container, default body if null -
<static> context
-
- Source:
- globals.js, line 55
Properties:
Name Type Description context
object Engine context: none, disposition or object Properties
Name Type Description object
string 'ObjectExternal' or 'ObjectInternal' (null means Disposition) name
string Related (external) object name rowId
string Related object row ID -
<static> defaultContentLoad
-
- Source:
- globals.js, line 87
Properties:
Name Type Description defaultContentLoad
function Optional handler when a content is loaded -
<static> defaultContentUnload
-
- Source:
- globals.js, line 93
Properties:
Name Type Description defaultContentUnload
function Optional handler when a content is unloaded -
<static> exports
-
- Source:
- globals.js, line 205
Properties:
Name Type Description exports
object Export configuration, all are { enabled:true } by default Properties
Name Type Description CSV
object CVS export with default sep:';' XLS
object Excel export with default formats: { binary: 'Excel', html: 'HTML' } PDF
object PDF export ARC
object Archive ZIP XML
object XML Simplicite (reserved to ADMIN) with default inline:true, timestamp:false JSON
object JSON Simplicite (reserved to ADMIN) YAML
object YAML Simplicite (reserved to ADMIN) ZIP
object ZIP Simplicite (reserved to ADMIN) -
<static> font
-
- Source:
- globals.js, line 80
Properties:
Name Type Description font
string optional google font to use -
<static> onbeforeunload
-
- Source:
- globals.js, line 106
Properties:
Name Type Description onbeforeunload
function Optional page beforeunload -
<static> onload
-
- Source:
- globals.js, line 100
Properties:
Name Type Description onload
function Optional page loaded (called before the ready callback) -
<static> onlogout
-
- Source:
- globals.js, line 118
Properties:
Name Type Description onlogout
function Optional logout handler, default call $ui.logout({ confirm: true }) -
<static> onunload
-
- Source:
- globals.js, line 112
Properties:
Name Type Description onunload
function Optional page unload -
<static> resources
-
- Source:
- globals.js, line 32
Properties:
Name Type Description resources
object[] Use specified resources or generic ones if null (MAIN, HEADER, FOOTER, MENU, WORK) Properties
Name Type Description name
string resource name like MAIN, HEADER, FOOTER, MENU, WORK type
string resource type HTML, CSS, JS target
string optional target for HTML type -
<static> scope
-
- true : all granted scopes
- false : no multi-apps access
- or array of specific scopes {home, url, icon|logo, label, help}
- Source:
- globals.js, line 168
Properties:
Name Type Description scope
object Multi-apps configuration Properties
Name Type Description name
string optional requested scope name enabled
boolean | object[] default true backend
boolean allows to return to legacy ? (default false) -
<static> shortcuts
-
- true : all granted shortcuts
- false : no shortcuts access
- or array of specific shortcuts {name, label, url, target, icon}
- Source:
- globals.js, line 183
Properties:
Name Type Description shortcuts
boolean | object[] Display the shortcuts ? -
<static> slideNav
-
- Source:
- globals.js, line 190
Properties:
Name Type Description slideNav
boolean Slide screen on push|pull navigation ? (default false) -
<static> socialShare
-
- Source:
- globals.js, line 139
Properties:
Name Type Description socialShare
object based on SOCIAL_SHARE parameter if not set -
<static> theme
-
- Source:
- globals.js, line 66
Properties:
Name Type Description theme
string Theme name ('dark, 'light', or 'default' by default) -
<static> themes
-
- Source:
- globals.js, line 73
Properties:
Name Type Description themes
string[] available CSS themes, null: user can't switch between themes, default ['default','light','dark'] -
<static> tinymceOptions
-
- Source:
- globals.js, line 221
Properties:
Name Type Description tinymce
object default tinymce options -
<static> useCopyLink
-
- Source:
- globals.js, line 146
Properties:
Name Type Description useCopyLink
boolean Allows to copy deeplink to objects (default true) -
<static> useMainParts
-
- Source:
- globals.js, line 125
Properties:
Name Type Description useMainParts
boolean Use the standard main site with context parts (MAIN, MENU, WORK, HEADER, FOOTER) ? (default true) -
<static> useSocial
-
- Source:
- globals.js, line 132
Properties:
Name Type Description useSocial
boolean Use social posts (default true) -
<static> useUndoRedo
-
- Source:
- globals.js, line 153
Properties:
Name Type Description undoredo
object true: see controls in header, false: disable feature or 'keys' to use CTRL-Z/Y only and hide controls