Namespace: Globals

Simplicite.UI.Globals

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

agenda
form
list
search
summary

Members

<static> ajaxSetup

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)
Source:
  • globals.js, line 42

<static> container

Properties:
Name Type Description
container string UI container, default body if null
Source:
  • globals.js, line 22

<static> context

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
Source:
  • globals.js, line 55

<static> defaultContentLoad

Properties:
Name Type Description
defaultContentLoad function Optional handler when a content is loaded
Source:
  • globals.js, line 87

<static> defaultContentUnload

Properties:
Name Type Description
defaultContentUnload function Optional handler when a content is unloaded
Source:
  • globals.js, line 93

<static> exports

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)
Source:
  • globals.js, line 205

<static> font

Properties:
Name Type Description
font string optional google font to use
Source:
  • globals.js, line 80

<static> onbeforeunload

Properties:
Name Type Description
onbeforeunload function Optional page beforeunload
Source:
  • globals.js, line 106

<static> onload

Properties:
Name Type Description
onload function Optional page loaded (called before the ready callback)
Source:
  • globals.js, line 100

<static> onlogout

Properties:
Name Type Description
onlogout function Optional logout handler, default call $ui.logout({ confirm: true })
Source:
  • globals.js, line 118

<static> onunload

Properties:
Name Type Description
onunload function Optional page unload
Source:
  • globals.js, line 112

<static> resources

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
Source:
  • globals.js, line 32

<static> scope

Properties:
Name Type Description
scope object Multi-apps configuration
Properties
Name Type Description
name string optional requested scope name
enabled boolean | object[] default true
  • true : all granted scopes
  • false : no multi-apps access
  • or array of specific scopes {home, url, icon|logo, label, help}
backend boolean allows to return to legacy ? (default false)
Source:
  • globals.js, line 168

<static> shortcuts

Properties:
Name Type Description
shortcuts boolean | object[] Display the shortcuts ?
  • true : all granted shortcuts
  • false : no shortcuts access
  • or array of specific shortcuts {name, label, url, target, icon}
Source:
  • globals.js, line 183

<static> slideNav

Properties:
Name Type Description
slideNav boolean Slide screen on push|pull navigation ? (default false)
Source:
  • globals.js, line 190

<static> socialShare

Properties:
Name Type Description
socialShare object based on SOCIAL_SHARE parameter if not set
Source:
  • globals.js, line 139

<static> theme

Properties:
Name Type Description
theme string Theme name ('dark, 'light', or 'default' by default)
Source:
  • globals.js, line 66

<static> themes

Properties:
Name Type Description
themes string[] available CSS themes, null: user can't switch between themes, default ['default','light','dark']
Source:
  • globals.js, line 73

<static> tinymceOptions

Properties:
Name Type Description
tinymce object default tinymce options
Source:
  • globals.js, line 221
Properties:
Name Type Description
useCopyLink boolean Allows to copy deeplink to objects (default true)
Source:
  • globals.js, line 146

<static> useMainParts

Properties:
Name Type Description
useMainParts boolean Use the standard main site with context parts (MAIN, MENU, WORK, HEADER, FOOTER) ? (default true)
Source:
  • globals.js, line 125

<static> useSocial

Properties:
Name Type Description
useSocial boolean Use social posts (default true)
Source:
  • globals.js, line 132

<static> useUndoRedo

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
Source:
  • globals.js, line 153