Globals

Simplicite.UI. Namespace

Globals

Description:

  • 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.

Members

(static) agenda

Description:

  • Global agenda/calendar options

Global agenda/calendar options

(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)

(static) compact

Properties:
Name Type Description
compact boolean

Compact the UI to limit padding sizes?

(static) container

Properties:
Name Type Description
container string

UI container, default body if null

(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

(static) defaultContentLoad

Properties:
Name Type Description
defaultContentLoad function

Optional handler when a content is loaded

(static) defaultContentUnload

Properties:
Name Type Description
defaultContentUnload function

Optional handler when a content is unloaded

(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
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

Properties:
Name Type Description
font string

Optional google font to use

(static) fontSize

Properties:
Name Type Description
fontSize string

Set the font-size zoom factor (100% = default size)

(static) form

Description:

  • Global object form options

Global object form options

(static) list

Description:

  • Global object list options

Global object list options

(static) news

Description:

  • Global News options

Global News options

(static) onbeforeunload

Properties:
Name Type Description
onbeforeunload function

Optional page beforeunload

(static) onload

Properties:
Name Type Description
onload function

Optional page loaded (called before the ready callback)

(static) onlogout

Properties:
Name Type Description
onlogout function

Optional logout handler, default call $ui.logout({ confirm: true })

(static) onunload

Properties:
Name Type Description
onunload function

Optional page unload

(static) resources

Properties:
Name Type Description
resources Array.<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

Properties:
Name Type Description
scope Object

Multi-apps configuration

Properties
Name Type Description
name string

Optional requested scope name
enabled boolean | Array.<Object>

Defaults to true

  • true : all granted scopes
  • false : no multi-apps access
  • or array of specific scopes \{home, url, icon|logo, label, help\}

(static) search

Description:

  • Global object search options

Global object search options

(static) shortcuts

Properties:
Name Type Description
shortcuts boolean | Array.<Object>

Display the shortcuts ?

  • true : all granted shortcuts
  • false : no shortcuts access
  • or array of specific shortcuts \{name, label, url, target, icon\}

(static) slideNav

Properties:
Name Type Description
slideNav boolean

Slide screen on push|pull navigation ? (default false)

(static) socialShare

Properties:
Name Type Description
socialShare Object

Based on SOCIAL_SHARE parameter if not set

(static) summary

Description:

  • Global object summary options

Global object summary options

(static) theme

Properties:
Name Type Description
theme string

Theme name ('dark', 'light', 'simplicite', or 'default' by default)

(static) themes

Properties:
Name Type Description
themes Array.<string>

Available CSS themes, null: user can't switch between themes, default ['default','light','dark','simplicite']

(static) timesheet

Description:

  • Global timesheet options

Global timesheet options

(static) tinymceOptions

Properties:
Name Type Description
tinymce Object

default tinymce options
Properties:
Name Type Description
useCopyLink boolean

Allows to copy deeplink to objects (default true)

(static) useMainParts

Properties:
Name Type Description
useMainParts boolean

Use the standard main site with context parts (MAIN, MENU, WORK, HEADER, FOOTER) ? (default true)

(static) useSocial

Properties:
Name Type Description
useSocial boolean

Use social posts (default true)

(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