DataTables Widget
How to insert a widget
You can easily insert a DataTable as a widget into any entry.
Click the Insert Widget icon in the toolbar and select "DataTables" in the widgets list.
After filling in the form, click "OK" to insert the widget.
The widget will appear when you save the entry.
The controls at the top of the table offer easy sorting and filtering.
Widget Option Examples
To filter the entries displayed in the table, you can specify one or more entry type names, and a search expression.
For example, to display just task entries, you could specify "task" for the entry type filter; or x(task) for the search expression.
To indicate what columns you'd like to display, you can type the names of the "entry fields" that you want to see. In this example, we're displaying the Traction ID, Title, Submission Date/
The following options are available:
- assigned
- author_last_update
- author_original
- color
- comment_target
- completed
- completion_status
- count_attachments
- count_comments
- count_events
- count_shares
- count_tasks
- count_xrefs_all
- count_xrefs_incoming
- count_xrefs_outgoing
- date_created
- date_lastmodified
- date_sorting
- due
- duration
- estimate
- event_allday
- event_date
- event_duration
- event_end
- event_start
- event_target
- goal
- invitees
- location
- members
- milestone
- moderation_status
- owners
- priority
- project
- share_target
- start
- subscribed
- tags
- task_start_to_completion
- task_start_to_due
- task_target
- tasks_root
- thread_root
- title
- tododone
- tractionid
For Developers: DataTables Library
Usage (1) - An example view
Load the "datatables_example" view by entering
/type datatables_example into TeamPage's search box, and pressing enter. Here you can experiment by changing the values of the parameters.Usage (2) - with a Section Title
This plug-in supports showing the results of a section in a DataTable, with HTML and styles similar to those of a section table widget.
To display this widget in an IFRAME, you can invoke the parent.
<com.traction.sdl.datatables.parent#datatable-section id="foo" proj="*" ... />
Usage (3) - without a Section Title
To display a similar widget but without a section title, instead use the "datatable-iframe-div" function, like this:
<com.traction.sdl.datatables.parent#datatable-iframe-div id="foo" proj="*" ... />
Parameters
These functions require the following variables:
- id = An ID to be used for the DataTable, as part of the DOM ID for the IFRAME, its container DIV, etc.
- proj = The names of the spaces for the <entries> tag used in the child page.
- entries_type = The value of type= parameter in <entries> tag in the child page displayed in the iframe.
- fields = Names of the entry fields, displayed as the columns of the DataTable.
The following variables are optional, or may be conditionally required depending upon the value specified by the "entries_type" variable.
- cat = The value of cat= parameter in <entries> tag in the child page displayed in the iframe.
- edate = The value of edate= parameter in <entries> tag in the child page displayed in the iframe.
- search = The value of search= parameter in <entries> tag in the child page displayed in the iframe.
- indextype = The value of indextype= parameter in <entries> tag in the child page displayed in the iframe.
- entrytypesfilter = The value of entrytypesfilter= parameter in <entries> tag in the child page displayed in the iframe.
- max = The value of max= parameter in <entries> tag in the child page displayed in the iframe.
- lang = Used in the child page's <html> tag, as lang="value".
- length_change = Indicates to display the numbers-per-page control in the top-left in the DataTable.
- show_search = Indicates to display the Search Box in the top-right in the DataTable.
- show_info = Indicates to display the Information in the bottom-left in the DataTable.
- paging = Indicates to display the page controls in the bottom-right in the DataTable.
- ordering = Indicates whether the ordering (sort by clicking the heading row) is allowed.
- orderdir = If ordering is allowed, this sets the direction of the ordering. (none/
asc/ desc) - orderidx = If ordering is allowed, this points the index of the base column of ordering. (Starts with 0 from left)
Attachments:
example_of_the_example_view.png
widget1.png
widget2.png
widget3.png
widget4.png
widgetoption_task.png
widgetoption_entries_type.png
Article: Forum6642 (permalink)
Categories: :Doc:plug-in
Date: June 5, 2016; 4:58:35 PM Eastern Daylight Time
Author Name: Takashi Okutsu
Author ID: takashi
Categories: :Doc:plug-in
Date: June 5, 2016; 4:58:35 PM Eastern Daylight Time
Author Name: Takashi Okutsu
Author ID: takashi