Global object list options
- Source:
- globals.js, line 237
Members
-
<static> actions
-
- Source:
- globals.js, line 418
Properties:
Name Type Description actions
object[] optional arrays { list, listPlus, row, rowPlus } of actions {name, label, confirm, callback, showLabel, ...}
null = no action, undefined = generate from metadata.actions -
<static> addList
-
- Source:
- globals.js, line 579
Properties:
Name Type Description addList
boolean Allows to add row on list ? (if defined override metadata) -
<static> areas
-
- Source:
- globals.js, line 314
Properties:
Name Type Description areas
object[] Array of field areas to display in table header. undefined = generate the visible areas on list -
<static> beforeload
-
- Source:
- globals.js, line 255
Properties:
Name Type Description beforeload
function(ctn,obj,params) optional handler before loading the list data -
<static> bulkDelete
-
- Source:
- globals.js, line 593
Properties:
Name Type Description bulkDelete
boolean Bulk delete on list (if defined override metadata) -
<static> bulkUpdate
-
- Source:
- globals.js, line 600
Properties:
Name Type Description bulkUpdate
boolean Bulk update on list (if defined override metadata) -
<static> columns
-
- Source:
- globals.js, line 321
Properties:
Name Type Description columns
object[] Array of ObjectField to display in table header. undefined = generate the visible fields on list -
<static> container
-
- Source:
- globals.js, line 248
Properties:
Name Type Description container
string Target UI container (default #work if unset) -
<static> context
-
- Source:
- globals.js, line 537
Properties:
Name Type Description context
number Object context, default = Simplicite.CONTEXT_LIST -
<static> display
-
- Source:
- globals.js, line 279
Properties:
Name Type Description display
function(ctn,obj,params,cbk) optional to override default rendering -
<static> edit
-
- Source:
- globals.js, line 565
Properties:
Name Type Description edit
string Edit list current mode = 'newline' | 'rows' -
<static> filters
-
- Source:
- globals.js, line 361
Properties:
Name Type Description filters
object optional object filters (updatable by user) -
<static> fixedFilters
-
- Source:
- globals.js, line 368
Properties:
Name Type Description fixedFilters
object optional fixed filters (override filters and not updatable by user) -
<static> followLinks
-
- Source:
- globals.js, line 474
Properties:
Name Type Description followLinks
boolean Allow global references navigation (upon the ref.followLink metadata) -
<static> forceSearch
-
- Source:
- globals.js, line 375
Properties:
Name Type Description forceSearch
boolean Show the search on list: 'list', 'dock', 'dialog', or true = 'list', false or null = no search forced -
<static> groupBy
-
- Source:
- globals.js, line 354
Properties:
Name Type Description searchBy
boolean Display the list with group by fields (if exists) -
<static> help
-
- Source:
- globals.js, line 509
Properties:
Name Type Description help
string Contextual list help -
<static> indexRequest
-
- Source:
- globals.js, line 403
Properties:
Name Type Description indexRequest
string Current index search request -
<static> inst
-
- Source:
- globals.js, line 544
Properties:
Name Type Description inst
string Optional instance name -
<static> isExtended
-
- Source:
- globals.js, line 488
Properties:
Name Type Description isExtended
boolean true to extend fields on list ? (default false) -
<static> layout
-
- Source:
- globals.js, line 307
Properties:
Name Type Description layout
string Minified obj-grid layout "article", "masonry" (default), "inline" or "float" -
<static> listEdit
-
- Source:
- globals.js, line 572
Properties:
Name Type Description listEdit
boolean Are rows editable on list ? (if defined override metadata) -
<static> listUpsert
-
- Source:
- globals.js, line 586
Properties:
Name Type Description listUpsert
boolean Allows edit and add rows ? (if defined override metadata) -
<static> minifiable
-
- Source:
- globals.js, line 300
Properties:
Name Type Description minifiable
boolean Allows to switch rows|summaries -
<static> minified
-
- Source:
- globals.js, line 293
Properties:
Name Type Description minified
boolean Display rows as table records or summaries (default false) -
<static> msg
-
- Source:
- globals.js, line 495
Properties:
Name Type Description msg
(string | object)[] Array of (backend) messages to display on list -
<static> msgRow
-
- Source:
- globals.js, line 502
Properties:
Name Type Description msgRow
object Array of row messages {rowId: array of messages on row} -
<static> nav
-
- Source:
- globals.js, line 516
Properties:
Name Type Description nav
string Optional navigation 'new' or 'add' -
<static> oncreate
-
- Source:
- globals.js, line 410
Properties:
Name Type Description oncreate
function create handler: null = no creation, undefined = bind the default 'create' action if granted -
<static> onhelp
-
- Source:
- globals.js, line 439
Properties:
Name Type Description onhelp
function(ctn,obj) handler to display the long help, default engine.displayHelp -
<static> onload
-
- Source:
- globals.js, line 267
Properties:
Name Type Description onload
function(ctn,obj,params) optional handler after loading the list -
<static> onopen
-
- Source:
- globals.js, line 432
Properties:
Name Type Description onopen
function(ctn,obj,rowId) Specific handler when record is opened/clicked, default binded to engine.openObject -
<static> onSelectRow
-
- Source:
- globals.js, line 614
Properties:
Name Type Description onSelectRow
function select row handler (default notify server) -
<static> onunload
-
- Source:
- globals.js, line 273
Properties:
Name Type Description onunload
function(ctn,obj,params) optional handler before unloading the list -
<static> parent
-
- Source:
- globals.js, line 551
Properties:
Name Type Description parent
object Optional parent object { name, inst, field, rowId } -
<static> preload
-
- Source:
- globals.js, line 261
Properties:
Name Type Description preload
function(ctn,obj,params) optional handler before rendering the list (data loaded) -
<static> renderTitle
-
- Source:
- globals.js, line 453
Properties:
Name Type Description renderTitle
function(obj,field,label) Optional, returns the value to display on column -
<static> renderValue
-
- Source:
- globals.js, line 460
Properties:
Name Type Description renderValue
function(obj,field,val) Optional, returns the value to display on cell -
<static> rowActionsRight
-
- Source:
- globals.js, line 467
Properties:
Name Type Description rowActionsRight
boolean Display actions on right side ? (default false) -
<static> rowOpenDocs
-
- Source:
- globals.js, line 481
Properties:
Name Type Description rowOpenDocs
boolean Add links to open documents and images ? (default true) -
<static> rows
-
- Source:
- globals.js, line 328
Properties:
Name Type Description rows
object[] Array of items to display in table rows. undefined = call the Ajax.search service -
<static> search
-
- Source:
- globals.js, line 347
Properties:
Name Type Description search
string Display the search feature
- 'column' = search by columns on list (not possible on small device)
- 'popup' = open a dialog upon list (forced on small device)
- 'docked' = left side of list (for large desktop only)
- undefined or false = hidden by default but accessible
- null = hidden and no search access -
<static> selectRows
-
- Source:
- globals.js, line 607
Properties:
Name Type Description selectRows
boolean Can select rows for bulk actions ? -
<static> showAreaTitles
-
- Source:
- globals.js, line 446
Properties:
Name Type Description showAreaTitles
boolean Show area titles ? (default true) -
<static> showFilters
-
- Source:
- globals.js, line 389
Properties:
Name Type Description showFilters
object display each user filter on list (default based on PANEL_FILTER) -
<static> showIndex
-
- Source:
- globals.js, line 396
Properties:
Name Type Description showIndex
boolean Show the fulltext search (default metadata.indexable) -
<static> showNav
-
- Source:
- globals.js, line 523
Properties:
Name Type Description showNav
boolean Display the navigation ? (default true) -
<static> showSearchInlined
-
- Source:
- globals.js, line 382
Properties:
Name Type Description showSearchInlined
boolean Show/Hide the inlined search by columns (when search is 'column') -
<static> showTotals
-
- Source:
- globals.js, line 530
Properties:
Name Type Description showTotals
boolean Display the column totals if any ? (default true if not historic object) -
<static> sort
-
- Source:
- globals.js, line 335
Properties:
Name Type Description sort
boolean Allows to sort the columns (default true) -
<static> template
-
- Source:
- globals.js, line 621
Properties:
Name Type Description template
string List template to map title, action bar, body and footer -
<static> title
-
- Source:
- globals.js, line 286
Properties:
Name Type Description title
string List title, default call obj.ui.title = object label -
<static> view
-
- Source:
- globals.js, line 558
Properties:
Name Type Description view
object Optional container view { name:viewname, item:position, home:true|false }