Render

Simplicite.UI. Render

new Render()

Description:
  • UI Rendering tool

Methods

alert(params)

Description:
  • Alert dialog box

Parameters:
Name Type Description
params string | Object

Message or object with:

Properties
Name Type Description
name string

Optional name

title string

Optional title, default "ALERT"

type string

Optional 'error|danger|warning|info'

content string | jQuery

Optional alert body

okLabel string

Optional "OK" button label, default: 'OK'

help string | jQuery

Optional help

onOk function

Optional callback on "OK" button

dontAskAgain string

Use the 'dont't ask again' local storage (true=keep user's action or string=forced response), needs a name

toast boolean

True to display a toast instead a dialog

modal boolean

True to display a modal dialog

moveable boolean

True to allow drag&drop

backendException(msg)

Description:
  • Back-end exception

Parameters:
Name Type Description
msg string | Object | Array

Simple text or { level, message or messages }, or first item of array

backendMessage(msg, toast, title)

Description:
  • Back-end message(s)

Parameters:
Name Type Description
msg string | Object | Array

Plain text / encoded message (code:text#level) / object { code, level, text, label } / or array of messages

toast boolean

True to display a toast instead a dialog box

title string

Optional title

backendMessages(msg)

Description:
  • Back-end messages in a single dialog

Parameters:
Name Type Description
msg Object

Array of backend messages per rowId

confirm(params)

Description:
  • Confirm dialog box

Parameters:
Name Type Description
params string | Object

Message or object with:

Properties
Name Type Description
name string

Optional name

title string

Optional title, default: 'CONFIRM'

content string | jQuery

Optional alert body

okLabel string

Optional "OK" button label, default: 'OK'

cancelLabel string

Optional "CANCEL" button label, default: 'CANCEL'

help string | jQuery

Optional help

onOk function

Optional callback on "OK" button

onCancel function

Optional callback on "CANCEL" button

dontAskAgain string

Use the 'dont't ask again' local storage (true=keep user's action or string=forced response), needs a name

moveable boolean

True to allow drag&drop

createObjectDialog(ctn, obj, cbk)

Description:
  • Create an object in a dialog

Parameters:
Name Type Description
ctn string | jQuery

Parent container

obj string | Simplicite.UI.BusinessObject

Object

cbk function

Callback with the created object

createReference(ctn, obj, ref, index)

Description:
  • Create an object in a dialog to populate a reference

Parameters:
Name Type Description
ctn string | jQuery

Parent container to populate

obj string | Simplicite.UI.BusinessObject

Object

ref string | Simplicite.Ajax.ObjectField

Referenced field or FK itself

index string

Optional row index (edit list)

datamapCompletion(ctn, obj, field, index, sel, disp)

Description:
  • Datamap completion

Parameters:
Name Type Description
ctn jQuery

Container

obj Simplicite.UI.BusinessObject

Object

field string | Simplicite.Ajax.ObjectField

Referenced field

index string

Optional row index (edit list)

sel function

Optional select item callback(item)

disp function

Optional display item callback(item, ref)

displayAssociate(ctn, obj, def)

Description:
  • Bulk association between objects

Parameters:
Name Type Description
ctn string | jQuery

Parent container

obj Simplicite.UI.BusinessObject

Object from panel instance

def Object

Associate definition

Properties
Name Type Description
parent string

Parent object name

parentRefField string

Foreign key field to parent

child string

Optional child object name (when obj is a N,N relationship)

childRefField string

Foreign key field to child

displayBookmarks(ctn, options)

Description:
  • Display the bookmarks

Parameters:
Name Type Description
ctn string | jQuery

Optional container

options Object

{show:top|bottom|true|false} or {action,object,rowId,element} to delete/toggle the object bookmark

displayCalendar(ctn, obj, agenda, params, cbk)

Description:
  • Calendar rendering

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Name or Business object

agenda string

Agenda name

params Object

Options

cbk function

Optional callback

displayColorPicker(ctn, input, dropdown, cbk)

Description:
  • Color picker

Parameters:
Name Type Description
ctn string | jQuery

Container

input string | jQuery

Element to receive selected color as #RRGGBB

dropdown boolean

Displays as dropdown or dialog box

cbk function

Optional callback(color,valid)

displayCompletion(ctn, obj, field, index, req, cbk, ctx)

Description:
  • Field completion on field

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Object or name

field string | Simplicite.Ajax.ObjectField

Field or name

index string

Optional row index (edit list)

req string

User request

cbk function

Callback with search result

ctx number

Optional context CONTEXT_SEARCH or UPDATE

displayCrosstab(ctn, obj, name, options, cbk)

Description:
  • Crosstab

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Name or Object

name string

Crosstab name

options Object

Options { inst, filters, options, nav, showNav }

Properties
Name Type Description
inst string

Instance of object

filters Object

Optional filters to limit crosstab data

options Object

Optional crosstab options { zstotal, zstcolor, zcaption, ztable, zgraph... }

cbk function

Optional callback

displayDashboard(ctn, name, options, cbk)

Description:
  • Display a user dashboard

Parameters:
Name Type Description
ctn string | jQuery

Container

name string

Dashboard name

options Object

View options

Properties
Name Type Description
home boolean

True on main/domain home view (to get home instance of objects)

nav string

'new' or 'add'

showNav boolean

True to display the nav

beforeload function

Optional before load callback

onload function

Optional onload callback

onunload function

Optional unload callback

cbk function

Optional callback

displayEditor(ctn, options, cbk)

Description:
  • Code editor

Parameters:
Name Type Description
ctn jQuery

Container

options Object

Optional parameters { showNav, nav }

cbk function

Optional callback

displayExport(ctn, obj, rowId)

Description:
  • Display the export dialog and get exported data

Parameters:
Name Type Description
ctn jQuery

Container

obj Simplicite.UI.BusinessObject

Object or name

rowId string

Optional row ID to export only one record

displayFeedback()

Description:
  • User feedback

displayField(ctn, obj, field, index, disp, p)

Description:
  • Display a field in the container

Parameters:
Name Type Description
ctn string | jQuery

Target container

obj Simplicite.UI.BusinessObject

Business Object

field Object | Simplicite.UI.Field

Field definition

index string

Optional index for edit list

disp string

optional display 'full' (default = label+input+help) | 'label' | 'input' | 'preview' | 'value' | 'help'

p Object

context parameters (form, formTab to focus, inline field of link, parent object, isExtended, hasMore, refb buttons, promises...)

Returns:

Field with 'ui' initialized

displayForm(ctn, obj, rowId, options, cbk)

Description:
  • Build a form with the object item

Parameters:
Name Type Description
ctn string | jQuery

Target container

obj string | Simplicite.UI.BusinessObject

Object

rowId string

Row ID to get

options Simplicite.UI.Globals.form

Options to override globals

cbk function

Optional callback(obj, params)

displayGantt(ctn, obj, ts, options, cbk)

Description:
  • Gantt diagram based on timesheet data

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Assignment object

ts String

Timesheet name

options Object

Options

cbk function

Optional callback

displayHelp(ctn, obj)

Description:
  • Object help: call the help service and open a dialog

Parameters:
Name Type Description
ctn string | jQuery

Parent container

obj Simplicite.UI.BusinessObject

Object

displayHome(ctn, options, cbk)

Description:
  • Home page

Parameters:
Name Type Description
ctn string | jQuery

Container

options Object

Options { nav, showNav }

cbk function

Optional callback

displayImportCSV(ctn)

Description:
  • Manage import CSV thru UI

Parameters:
Name Type Description
ctn string | jQuery

Optional container

displayImportXML(ctn)

Description:
  • Manage import XML thru UI

Parameters:
Name Type Description
ctn string | jQuery

Optional container

displayIndex(ctn, options, cbk)

Description:
  • Index search form

Parameters:
Name Type Description
ctn string | jQuery

Container

options Object

Options

Properties
Name Type Description
title string

Search title, the request by default

nav string

'add' or 'new' (default)

showNav boolean

Display the navigation railway, default true

object string

Optional business object to limit search

domain string

Optional domain search

cbk function

Optional callback

displayIndexSearch(ctn, req, options, cbk)

Description:
  • Index search result

Parameters:
Name Type Description
ctn string | jQuery

Container

req string

User request (see Simplicite.Ajax.indexsearch service)

options Object

Options { object, nav, showNav }

cbk function

Optional callback

displayIndexSearchDocs(ctn, req, list, options)

Description:
  • Index search in documents

Parameters:
Name Type Description
ctn string | jQuery

Container for result

req string

User request

list Array.<string>

Array of objects with documents

options Object

Options { object, nav, showNav }

displayIndexSearchDomain(ctn, domain, filter, all, options)

Description:
  • Index search in domain

Parameters:
Name Type Description
ctn string | jQuery

Container for result

domain string

Domain name

filter string

Optional filter

all boolean

False to limit search to objects updated by the user

options Object

Options { object, nav, showNav }

displayIndexSearchSession(ctn)

Description:
  • Session index

Parameters:
Name Type Description
ctn string | jQuery

Container for result

displayInlinedForm(ctn, o, params)

Description:
  • Display form of inlined link (cardinlity 0,1 or 1,1 with inline rendering)

Parameters:
Name Type Description
ctn string | jQuery

Container

o Simplicite.UI.BusinessObject

object

params Simplicite.UI.Globals.list

Reference data

Properties
Name Type Description
inline boolean

true

parent Object

Parent object { name, inst, field, rowId, object }

link Object

Link metadata

title string

Optional link title (empty = no title)

displayList(ctn, obj, options, cbk)

Description:
  • Build a list with the object search

Parameters:
Name Type Description
ctn string | jQuery

Target container

obj string | Simplicite.UI.BusinessObject

Name or Business Object

options Simplicite.UI.Globals.list

Options to override Globals

cbk function

Optional callback

displayLogs(ctn, {string, {string)

Description:
  • Show server logs thru web-socket. Useful when UI has no console.

Parameters:
Name Type Description
ctn string | jQuery

Optional container to split (default is #work)

{string

action start|stop

{string

pos Optional position dialog|left|right|top|bottom (default bottom)

displayMentions(ctn, options)

Description:
  • Display a mentions resource

Parameters:
Name Type Description
ctn string | jQuery

Optional container (dialog if unset)

options Object

Options

Properties
Name Type Description
name string

HTML content name (default 'MENTIONS')

title string

Optional dialog title (default name translation)

width string

Optional dialog width (default 70%)

displayMerge(ctn, obj, options, cbk)

Description:
  • Merge object

Parameters:
Name Type Description
ctn string | jQuery

Container

obj Simplicite.UI.BusinessObject

Object with merge access

options Object

Options { ids }

Properties
Name Type Description
ids Array

Optional list of ids to merge (use selected rows if unset)

cbk function

Optional callback

displayModeler(ctn, modelId, options)

Description:
  • Load and display the modeler

Parameters:
Name Type Description
ctn string | jQuery

Container

modelId string

Model row ID

options Object

Options { svg, docked, popup }

displayModuleApp(action, obj)

Description:
  • Display the application module screen

Parameters:
Name Type Description
action string

import or export

obj Object

application (root module)

displayModuleDelete(ctn, moduleId)

Description:
  • Display the delete module screen

Parameters:
Name Type Description
ctn string | jQuery

Container

moduleId string

module row Id

displayMonitoring(params, cbk)

Description:
  • UI Monitoring

Parameters:
Name Type Description
params Object

Options

Properties
Name Type Description
docked boolean

Dock monitoring on bottom

tabIndex number

Tab to focus

cbk function

Optional callback

displayPlaceMap(ctn, params, cbk)

Description:
  • Placemap service

Parameters:
Name Type Description
ctn string | jQuery

Container to append the map

params Object

Static image { lat, lng, width, height } or dynamic placemap { object, inst, name, nav }

cbk function

Optional callback when the map is loaded

displayPreferences(ctn, obj)

Description:
  • Object preferences

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Name or Business Object

displayPrint(ctn, name, obj, rowId, cbk)

Description:
  • Display a print/publication

Parameters:
Name Type Description
ctn string | jQuery

Optional container (_blank if null)

name string

Print name

obj Simplicite.UI.BusinessObject

Object

rowId string

Optional row ID

cbk function

Optional callback

displayReferenceList(ctn, obj, params)

Description:
  • Display referenced object as panel list, inlined form or pillbox

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Referenced object or name

params Simplicite.UI.Globals.list

List options + parent object + link metadata

Properties
Name Type Description
parent Object

Parent object { name, inst, field, rowId, object }

link Object

Optional link metadata with { child, childfk, rendering }

embedded boolean

unset or true to apply rendering of link, false to ignore the rendering and display a list

displayReferencePillbox(ctn, o, params)

Description:
  • Display references in a pillbox control

Parameters:
Name Type Description
ctn string | jQuery

Container

o Simplicite.UI.BusinessObject

N,N object

params Simplicite.UI.Globals.list

Reference data

Properties
Name Type Description
parent Object

Parent object { name, inst, field, rowId, object }

link Object

Link metadata with child name and child foreign-key

read boolean

Read only?

title string

Optional link title (empty = no title)

displayRow(ctn, elt, obj, rowId, options, cbk)

Description:
  • Build a record of list

Parameters:
Name Type Description
ctn string | jQuery

Nav container

elt string | jQuery

row container (tr or div)

obj Simplicite.UI.BusinessObject

Object

rowId string

Object row Id

options Simplicite.UI.Globals.list

List options to override global row options

cbk function

Optional callback to chain something

displaySearch(ctn, obj, options, cbk)

Description:
  • Search form

Parameters:
Name Type Description
ctn string | jQuery

Parent container

obj string | Simplicite.UI.BusinessObject

Name or Business Object

options Simplicite.UI.Globals.search

Options to override Globals

cbk function

Optional callback

displaySocial(ctn, options, cbk)

Description:
  • Displays social posts

Parameters:
Name Type Description
ctn string | jQuery

Container

options Object

Social options

Properties
Name Type Description
object string

Optional object to limit search

rowId string

Optional object ID to limit search

activity boolean

True to display object activities

onpost function

Social service(item) to upsert post

ondel function

Social service(id) to delete post

onlist function

Social service(page,act) to search posts

onlike function

Social service(id,like) to (un)like a post

onfollow function

Follow service

follow boolean

Follow?

embedded function

Default false = modal dialog

cbk function

Optional callback

displayStatusMetrics(ctn, obj, params, cbk)

Description:
  • Status metrics

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Name or Business object

params Object

Options

Properties
Name Type Description
fromDate string

From date search YYYY-MM-DD, default 1 week ago or obj.locals.ui.metrics.fromDate

toDate string

To date search YYYY-MM-DD, default today or obj.locals.ui.metrics.toDate

period string

Group by period: 1=hour, 2=day, 3=week, 4=month, 5=quarter, 6=semester, 7=year / default 2=day or obj.locals.ui.metrics.period

palette string

Palette name, default sysparam CHART_PALETTE or obj.locals.ui.metrics.palette

show Object

Options to show/hide elements (all visible by default)

Properties
Name Type Description
count boolean

Show the count per status?

duration boolean

Show the duration per status?

history boolean

Show the status history?

terminal boolean

Show the terminal status per duration?

palette boolean

Show palette picker?

statusColors boolean

Use the status colors in PIE?

period boolean | string

true|false or 'read'

fromDate boolean | string

true|false or 'read'

toDate boolean | string

true|false or 'read'

cbk function

Optional callback

displaySummary(ctn, obj, rowId, options, cbk)

Description:
  • Object summary

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Object

rowId string

Object row ID

options Object

Optional parameters

Properties
Name Type Description
inst string

Optional instance name

parent Object

Optional parent context

icon boolean

Display the object icon or image thumbnail, default true

image boolean

Display the object image if any, default true

label string

Optional label, default: object label

userKey string

Optional user key, default: object user key

fields Array.<Simplicite.Ajax.ObjectField>

Optional array of fields to display

onopen function

Optional handler on open, default: engine.openObject

actions Array.<Object>

Optional array of actions, default row actions

item Object

Optional object values

maxFields number

Optional max fields to display

cbk function

Callback to chain

displaySysInfos(ctn, options)

Description:
  • System informations

Parameters:
Name Type Description
ctn string | jQuery

Container

options Object

Options { action, objdt, cache }

displayTemplate(ctn, target, rowId, cbk)

Description:
  • Template editor

Parameters:
Name Type Description
ctn string | jQuery

Container

target string

ObjectInternal or View or ObjectInternalRow

rowId string

Object/view ID

cbk function

Optiona callback when rendered

displayTheme(rowId, options)

Description:
  • Theme editor

Parameters:
Name Type Description
rowId String

Theme row Id

options Object

Options

displayTimesheet(ctn, obj, rowId, ts, options, cbk)

Description:
  • Timesheet of object

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Resource object 1 or 2, or panel instance of assign object

rowId String

Optional resource row ID

ts String

Timesheet name

options Object

Options

cbk function

Optional callback

displayTray(ctn, obj, field, options, cbk)

Description:
  • Trays based on a state model

Parameters:
Name Type Description
ctn string | jQuery

Container

obj string | Simplicite.UI.BusinessObject

Name or Business object

field string

Optional enum name (default is the status field)

options Object

Optional parameters

cbk function

Optional callback

displayTreeView(ctn, obj, rowId, name, options, cbk)

Description:
  • Display a tree view

Parameters:
Name Type Description
ctn string | jQuery

Optional container

obj Simplicite.UI.BusinessObject

Root object

rowId string

Row ID of the record

name string

Treeview name

options Object

Optional parameters { inst, depth, display, menu, docked, onOpen, addMenu, delMenu, onPage }

Properties
Name Type Description
inst string

optional instance name (default tree_ajax_[tvname]_[object])

depth number

Max deep search (default 2)

menu boolean

Add the tree in main menu (default open in container)

docked boolean

Open tree in left dock (default open in container)

display function

Optional to override default menu.treeview renderer

onOpen function

Optional open node handler function(n,cbk)

addMenu function

Optional add to menu handler

delMenu function

Optional remove from menu handler

onPage function

Optional add page handler

cbk function

Optional callback

displayUpdateForm(ctn, obj, options, cbk)

Description:
  • Build a form for bulk update

Parameters:
Name Type Description
ctn string | jQuery

Target container

obj string | Simplicite.UI.BusinessObject

Name or BusinessObject

options Object

See Globals.form

cbk function

Optional callback

displayUserFilters(ctn, options)

Description:
  • Display the user filters: date range and fields

Parameters:
Name Type Description
ctn string | jQuery

Optional container (dialog if null)

options Object

Options { bar }

displayView(ctn, view, options, cbk)

Description:
  • Display a view

Parameters:
Name Type Description
ctn string | jQuery

Container

view string | Object

View definition or name

options Object

View options

Properties
Name Type Description
home boolean

True on main/domain home view (to get home instance of objects)

parent Object

When view has a parent object

nav string

'new' or 'add'

showNav boolean

True to display the nav

useCopyLink boolean

false to hide the permalink button

beforeload function

Optional before load callback

onload function

Optional onload callback

onunload function

Optional unload callback

cbk function

Optional callback

displayWebNews(ctn, options)

Description:
  • Display the web news (user needs read access to WebNews)

Parameters:
Name Type Description
ctn string | jQuery

Container (in a dialog if undefined)

options Object

Optional parameters

Properties
Name Type Description
filters Object

Optional filters on WebNews

template string

Optional template (default Simplicite.UI.Globals.news.template)

popup boolean

true to get only news to display (on logon) in a modal dialog

ticker boolean

true to get only news to display on a footer ticker

displayWorkflow(ctn, wkf, action, options, cbk)

Description:
  • Workflow wrapper

Parameters:
Name Type Description
ctn string | jQuery

Container

wkf string | Simplicite.Ajax.BusinessProcess

Business process or name

action string

Action start|abort|lock|unlock|validate|cancel|back|list

options Object

Optional activity { step }

cbk function

Optional callback

error(msg)

Description:
  • Error dialog box

Parameters:
Name Type Description
msg string

Content

fkCompletion(ctn, obj, field, index, sel, disp)

Description:
  • Foreign-key completion

Parameters:
Name Type Description
ctn jQuery

Container

obj Simplicite.UI.BusinessObject

Object

field string | Simplicite.Ajax.ObjectField

Referenced field

index string

Optional row index (edit list)

sel function

Optional select item callback(item)

disp function

Optional display item callback(item, ref)

info(msg)

Description:
  • Information dialog box

Parameters:
Name Type Description
msg string

Content

openForm(ctn, obj, rowId)

Description:
  • Open object form: default displayForm with nav add

Parameters:
Name Type Description
ctn string | jQuery

Target container

obj string | Simplicite.UI.BusinessObject

Name or Business Object

rowId string

Referenced row ID

prompt(params)

Description:
  • Prompt dialog box

Parameters:
Name Type Description
params string | Object

Message or object with:

Properties
Name Type Description
name string

Optional name

title string

Dialog title

required boolean

Required value

content string | jQuery

Optional alert body

okLabel string

Optional "OK" button label, default: 'OK'

cancelLabel string

Optional "CANCEL" button label, default: 'CANCEL'

help string | jQuery

Optional help

onOk function

Optional callback(value) on OK button

onCancel function

Optional callback on Cancel button

moveable boolean

True to allow drag&drop

resetDatamap(ctn, obj, field, index, cbk)

Description:
  • Reset datamap fields

Parameters:
Name Type Description
ctn string | jQuery

Parent container of referenced fields to set

obj Simplicite.UI.BusinessObject

Object

field Simplicite.Ajax.ObjectField

Mapped field

index string

Optional row index (edit list)

cbk function

Optional callback to override fields change

selectDatamap(ctn, obj, field, index, cbk, reset)

Description:
  • Object datamap picker: default open a popup to select data

Parameters:
Name Type Description
ctn string | jQuery

Parent container of referenced fields to set

obj Simplicite.UI.BusinessObject

Object

field Simplicite.Ajax.ObjectField

Mapped field

index string

Optional row index (edit list)

cbk function

Optional callback to override fields change

reset boolean

True to only reset all datamap fields

selectMetaObject(ctn, obj, field, index)

Description:
  • Meta-object picker: default open a popup to select a reference

Parameters:
Name Type Description
ctn string | jQuery

Parent container of referenced fields to set

obj string | Simplicite.UI.BusinessObject

Object

field string | Simplicite.Ajax.ObjectField

Field of meta-object to select

index string

Optional row index (edit list)

selectObject(ctn, obj, options, cbk)

Description:
  • Object picker: default open a popup to select object(s) (used by pillbox, modeler, associate and merge)

Parameters:
Name Type Description
ctn string | jQuery

Parent container

obj string | Simplicite.UI.BusinessObject

Object name or business object

options Object

List additive options { context, filters, parent, minified, layout... }

Properties
Name Type Description
selectRows boolean

true to allows multiple selections

selectedIds Array

optional row Ids to pre-select

highlightIds Array | function

optional row Ids to hightlight (no pre-select) or function

cbk function

Callback(obj, id or array of ids) called on selection

selectReference(ctn, obj, ref, refField, index, cbk, userKeys)

Description:
  • Object reference picker: default open a popup to select a reference

Parameters:
Name Type Description
ctn string | jQuery

Parent container of referenced fields to set

obj Simplicite.UI.BusinessObject

Object

ref string | Simplicite.UI.BusinessObject

Referenced object name or business object (list popup)

refField string | Simplicite.Ajax.ObjectField

Foreign key (or meta object) field to select (name or field)

index string

Optional row index (edit list)

cbk function

Optional callback (will replace all change events on each field)

userKeys boolean

Optional to get foreign user-key

title(obj, userKey, plural)

Description:
  • Object title to display.

Parameters:
Name Type Description
obj Simplicite.UI.BusinessObject

Object with metadata (label, plurallabel, userkey)

userKey boolean

True to add the valued user-key

plural boolean

True to use the plural label if exists

toast(params)

Description:
  • Toast dialog box

Parameters:
Name Type Description
params string | Object

Message or object with:

Properties
Name Type Description
type string

Optional error|danger|warning|info

content string | jQuery

Toast body

position string

Position top|bottom

align string

Align left|right|center

undo boolean

Add an undo button?

moveable boolean

True to allow drag&drop

warning(msg)

Description:
  • Warning dialog box

Parameters:
Name Type Description
msg string

Content

yesNo(params)

Description:
  • Yes/No dialog box

Parameters:
Name Type Description
params string | Object

Message or object with:

Properties
Name Type Description
name string

Optional name

title string

Optional title, default "CONFIRM"

content string | jQuery

Optional alert body

yesLabel string

Optional "YES" button label, default: 'YES'

noLabel string

Optional "NO" button label, default: 'NO'

help string | jQuery

Optional help

onYes function

Optional callback on "YES" button

onNo function

Optional callback on "NO" button

dontAskAgain string

Use the 'dont't ask again' local storage (true=keep user's action or string=forced response), needs a name

moveable boolean

True to allow drag&drop

yesNoCancel(params)

Description:
  • Yes/No/Cancel dialog box

Parameters:
Name Type Description
params string | Object

Message or object with:

Properties
Name Type Description
name string

Optional name

title string

Optional title, default "CONFIRM"

content string | jQuery

Optional alert body

yesLabel string

Optional "YES" button label, default: 'YES'

noLabel string

Optional "NO" button label, default: 'NO'

cancelLabel string

Optional "CANCEL" button label, default: 'CANCEL'

help string | jQuery

Optional help

onYes function

Optional callback on "YES" button

onNo function

Optional callback on "NO" button

onCancel function

Optional callback on "CANCEL" button

dontAskAgain string

Use the 'dont't ask again' local storage (true=keep user's action or string=forced response), needs a name

moveable boolean

True to allow drag&drop

zipEditor(ctn, doc, params, cbk)

Description:
  • ZIP editor

Parameters:
Name Type Description
ctn Object

Parent container

doc Object

Document { object, rowId, field, docId, name }

params Object

Options { readonly:true|false }

cbk function

Optional callback to get the new ZIP as Base64