Live Table Macro

LiveTable Macro

The most common use case of the livetable macro is displaying a table of documents that contains an XWiki Object of a certain class. This is a powerful way for in-wiki applications developers to offer a mining interface on their application data (for example Contacts in a CRM/Contact manager, Bills in a Billing application, etc.).

Usage

The signature of the macro is the following :

#livetable($id $columns $columnsProperties $options)

Each parameter allows to control the output generated by the macro. Namely:

• $id is a string identifier that allows to distinguish this table from others. This permits to have several tables on the same page. This id is used in the generated HTML as prefix for some elements' ids.
• $columns is an array that holds the ordered list of columns to display in the table.
• $columnsProperties is a hash of properties (options) to customize the behavior of each of the columns
• $options is a hash with general options (as opposed to columns options) for the table.

Parameter $options

Example

#set($myTableOptions = { 
   "className":"XWiki.XWikiUsers",
   "translationPrefix" : "xe.index.users.",
   "tagCloud" : true,
   "rowCount": 10
})

All accepted values

Parameter $columns

This parameter allows to define the columns of the Live Table. There are 3 major types of columns a table can declare: document columns, which will be displaying (and filtering on) metadata on the document (such as its author, date of last modification, etc.) object properties columns, for the case the table is bound to an XWiki Class, and special columns, for columns which are not handled by the first two types, such as the list of attachments of a document, the actions that can be performed. The table below in the example summarizes all the possible values that can be passed to the $columns array.

Example

#set($myColumns = ["_avatar", "first_name", "last_name", "email", "doc.creationDate", "_actions"])

All accepted values

Parameter $columnsProperties

Example

#set($columnsProperties = {
   "_avatar" : { "type" : "none", "link" : "none", "html" : "true", "sortable":false },
   "first_name" : { "type" : "text" , "size" : 20, "link" : "view"},
   "last_name" : { "type" : "text", "link" : "view"},
   "email" : { "type" : "text" }
})

All accepted values

• Document and object fields options:

Examples

The user directory

#set($columns = ["_avatar", "first_name", "last_name", "email", "doc.creationDate", "_actions"])
#set($columnsProperties = {
    "_avatar" : { "type" : "none", "link" : "none", "html" : "true", "sortable":false },
    "first_name" : { "type" : "text" , "size" : 20, "link" : "view"},
    "last_name" : { "type" : "text", "link" : "view"},
    "email" : { "type" : "text" }
})
#set($options = { 
   "className":"XWiki.XWikiUsers",
   "translationPrefix" : "xe.index.users.",
   "tagCloud" : true,
   "rowCount": 10
})
#livetable("userdirectory" $columns $columnsProperties $options)

Demo (Video)

Filter organizations by domain

The organization class in the example below has two properties: an org_name of type String and an org_domain of type StaticList. The organization domain can have values like Software or Hardware , which will be used in the live table as filter options.

#set($columns = ["org_name", "org_domain"])
#set($columnsProperties = {
    "org_name" : { "type" : "text" , "size" : 20, "link" : "view"},
    "org_domain" : { "type" : "list", "class": "MySpace.OrganizationClass"}
})

#set($options = { 
   "resultPage":"MySpace.ListOrganizationJSON",
   "translationPrefix" : "",
   "rowCount": 10
})
#livetable("organization_directory" $columns $columnsProperties $options)

The content of MySpace.ListOrganizationJSON (using syntax 2.0):

{{include document="XWiki.LiveTableResultsMacros" /}}
{{velocity}}
#gridresultwithfilter("MySpace.OrganizationClass" $request.collist.split(",") "" " and doc.name<>'OrganizationSheet' and doc.name<>'OrganizationTemplate'")
{{/velocity}}

Advanced

For more details on how LiveTable works, check the Live Table section in the Dev Guide.