Namespace: list

Simplicite.UI.Globals.list

Global object list options

Source:
  • globals.js, line 237

Members

<static> actions

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

<static> addList

Properties:
Name Type Description
addList boolean Allows to add row on list ? (if defined override metadata)
Source:
  • globals.js, line 579

<static> areas

Properties:
Name Type Description
areas object[] Array of field areas to display in table header. undefined = generate the visible areas on list
Source:
  • globals.js, line 314

<static> beforeload

Properties:
Name Type Description
beforeload function(ctn,obj,params) optional handler before loading the list data
Source:
  • globals.js, line 255

<static> bulkDelete

Properties:
Name Type Description
bulkDelete boolean Bulk delete on list (if defined override metadata)
Source:
  • globals.js, line 593

<static> bulkUpdate

Properties:
Name Type Description
bulkUpdate boolean Bulk update on list (if defined override metadata)
Source:
  • globals.js, line 600

<static> columns

Properties:
Name Type Description
columns object[] Array of ObjectField to display in table header. undefined = generate the visible fields on list
Source:
  • globals.js, line 321

<static> container

Properties:
Name Type Description
container string Target UI container (default #work if unset)
Source:
  • globals.js, line 248

<static> context

Properties:
Name Type Description
context number Object context, default = Simplicite.CONTEXT_LIST
Source:
  • globals.js, line 537

<static> display

Properties:
Name Type Description
display function(ctn,obj,params,cbk) optional to override default rendering
Source:
  • globals.js, line 279

<static> edit

Properties:
Name Type Description
edit string Edit list current mode = 'newline' | 'rows'
Source:
  • globals.js, line 565

<static> filters

Properties:
Name Type Description
filters object optional object filters (updatable by user)
Source:
  • globals.js, line 361

<static> fixedFilters

Properties:
Name Type Description
fixedFilters object optional fixed filters (override filters and not updatable by user)
Source:
  • globals.js, line 368
Properties:
Name Type Description
followLinks boolean Allow global references navigation (upon the ref.followLink metadata)
Source:
  • globals.js, line 474

<static> forceSearch

Properties:
Name Type Description
forceSearch boolean Show the search on list: 'list', 'dock', 'dialog', or true = 'list', false or null = no search forced
Source:
  • globals.js, line 375

<static> groupBy

Properties:
Name Type Description
searchBy boolean Display the list with group by fields (if exists)
Source:
  • globals.js, line 354

<static> help

Properties:
Name Type Description
help string Contextual list help
Source:
  • globals.js, line 509

<static> indexRequest

Properties:
Name Type Description
indexRequest string Current index search request
Source:
  • globals.js, line 403

<static> inst

Properties:
Name Type Description
inst string Optional instance name
Source:
  • globals.js, line 544

<static> isExtended

Properties:
Name Type Description
isExtended boolean true to extend fields on list ? (default false)
Source:
  • globals.js, line 488

<static> layout

Properties:
Name Type Description
layout string Minified obj-grid layout "article", "masonry" (default), "inline" or "float"
Source:
  • globals.js, line 307

<static> listEdit

Properties:
Name Type Description
listEdit boolean Are rows editable on list ? (if defined override metadata)
Source:
  • globals.js, line 572

<static> listUpsert

Properties:
Name Type Description
listUpsert boolean Allows edit and add rows ? (if defined override metadata)
Source:
  • globals.js, line 586

<static> minifiable

Properties:
Name Type Description
minifiable boolean Allows to switch rows|summaries
Source:
  • globals.js, line 300

<static> minified

Properties:
Name Type Description
minified boolean Display rows as table records or summaries (default false)
Source:
  • globals.js, line 293

<static> msg

Properties:
Name Type Description
msg (string | object)[] Array of (backend) messages to display on list
Source:
  • globals.js, line 495

<static> msgRow

Properties:
Name Type Description
msgRow object Array of row messages {rowId: array of messages on row}
Source:
  • globals.js, line 502
Properties:
Name Type Description
nav string Optional navigation 'new' or 'add'
Source:
  • globals.js, line 516

<static> oncreate

Properties:
Name Type Description
oncreate function create handler: null = no creation, undefined = bind the default 'create' action if granted
Source:
  • globals.js, line 410

<static> onhelp

Properties:
Name Type Description
onhelp function(ctn,obj) handler to display the long help, default engine.displayHelp
Source:
  • globals.js, line 439

<static> onload

Properties:
Name Type Description
onload function(ctn,obj,params) optional handler after loading the list
Source:
  • globals.js, line 267

<static> onopen

Properties:
Name Type Description
onopen function(ctn,obj,rowId) Specific handler when record is opened/clicked, default binded to engine.openObject
Source:
  • globals.js, line 432

<static> onSelectRow

Properties:
Name Type Description
onSelectRow function select row handler (default notify server)
Source:
  • globals.js, line 614

<static> onunload

Properties:
Name Type Description
onunload function(ctn,obj,params) optional handler before unloading the list
Source:
  • globals.js, line 273

<static> parent

Properties:
Name Type Description
parent object Optional parent object { name, inst, field, rowId }
Source:
  • globals.js, line 551

<static> preload

Properties:
Name Type Description
preload function(ctn,obj,params) optional handler before rendering the list (data loaded)
Source:
  • globals.js, line 261

<static> renderTitle

Properties:
Name Type Description
renderTitle function(obj,field,label) Optional, returns the value to display on column
Source:
  • globals.js, line 453

<static> renderValue

Properties:
Name Type Description
renderValue function(obj,field,val) Optional, returns the value to display on cell
Source:
  • globals.js, line 460

<static> rowActionsRight

Properties:
Name Type Description
rowActionsRight boolean Display actions on right side ? (default false)
Source:
  • globals.js, line 467

<static> rowOpenDocs

Properties:
Name Type Description
rowOpenDocs boolean Add links to open documents and images ? (default true)
Source:
  • globals.js, line 481

<static> rows

Properties:
Name Type Description
rows object[] Array of items to display in table rows. undefined = call the Ajax.search service
Source:
  • globals.js, line 328
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
Source:
  • globals.js, line 347

<static> selectRows

Properties:
Name Type Description
selectRows boolean Can select rows for bulk actions ?
Source:
  • globals.js, line 607

<static> showAreaTitles

Properties:
Name Type Description
showAreaTitles boolean Show area titles ? (default true)
Source:
  • globals.js, line 446

<static> showFilters

Properties:
Name Type Description
showFilters object display each user filter on list (default based on PANEL_FILTER)
Source:
  • globals.js, line 389

<static> showIndex

Properties:
Name Type Description
showIndex boolean Show the fulltext search (default metadata.indexable)
Source:
  • globals.js, line 396

<static> showNav

Properties:
Name Type Description
showNav boolean Display the navigation ? (default true)
Source:
  • globals.js, line 523

<static> showSearchInlined

Properties:
Name Type Description
showSearchInlined boolean Show/Hide the inlined search by columns (when search is 'column')
Source:
  • globals.js, line 382

<static> showTotals

Properties:
Name Type Description
showTotals boolean Display the column totals if any ? (default true if not historic object)
Source:
  • globals.js, line 530

<static> sort

Properties:
Name Type Description
sort boolean Allows to sort the columns (default true)
Source:
  • globals.js, line 335

<static> template

Properties:
Name Type Description
template string List template to map title, action bar, body and footer
Source:
  • globals.js, line 621

<static> title

Properties:
Name Type Description
title string List title, default call obj.ui.title = object label
Source:
  • globals.js, line 286

<static> view

Properties:
Name Type Description
view object Optional container view { name:viewname, item:position, home:true|false }
Source:
  • globals.js, line 558