Timegrid/Configuration Options

From SIMILE Widgets
Jump to: navigation, search
Configuration Options

Timegrid is configured through attributes of its containing DOM element.

role
(required)
Description: This attribute marks elements as containers for Timegrid.
Value: grid
views
(required)
Description: A comma-separated list of one or more layout names
Values: week, month, n-day, n-month, or property
src
(either src or eventSource required)
Description: A URL pointing to a event source file, in either XML or JSON format. This must be on the same domain, since the data is fetched with an AJAX call.
Value: Any valid URL on the same domain, e.g. data/data.xml
eventSource
(either src or eventSource required)
Description: This attribute is used to provide an EventSource as an already configured Javascript object.
Value: A valid Javascript expression, evaluated with eval
height
(optional)
Description: This attribute configures the height of the Timegrid, in pixels.
Value: An integer, e.g. 700, without units
Default: If not specified, Timegrid will try its best to calculate an acceptable value, falling back on 500px if it cannot.
gridwidth
(optional)
Description: This attribute configures the width of the internal grid, in pixels. If both a gridwidth and a width are given, the grid will scroll within the Timegrid.
Value: An integer, e.g. 700, without units
Default: If not specified, the grid will fill its containing element.
gridheight
(optional)
Description: This attribute configures the height of the internal grid, in pixels. If both a gridheight and a height are given, the grid will scroll within the Timegrid.
Value: An integer, e.g. 700, without units
Default: If not specified, the grid will fill its containing element.
width
(optional)
Description: This attribute configures the width of the Timegrid, in pixels.
Value: An integer, e.g. 700, without units
Default: If not specified, Timegrid will fill its containing element.
xCell or columnWidth
(optional)
Description: This attribute configures the width of a column, in pixels.
Value: An integer, e.g. 50, without units
Default: If not specified, Timegrid will fit columns to the size of its grid.
yCell or rowHeight
Description: This attribute configures the height of a row, in pixels.
Value: An integer, e.g. 50, without units
Default: If not specified, Timegrid will fit rows to the size of its grid.
n
(optional)
Description: This attribute configures the n-day and n-month layouts, specifying how manys days or months to display at a time.
Value: An integer, e.g. 4
Default: 3
property
(optional)
Description: This attribute is used by the property layout to determine which property of the events it should use.
Value: A string corresponding to an event property name, e.g. room
Default: title
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox