Timeselector Options
The following options can be used when creating a time control.
Required parameters are startDate, endDate and onrangechange.
By default, this will allow the user to select a range of time in the past. You can use the mode and liveOption options to modify this behaviour.
anchor
The relative position of the drop-down panel - either 'right' or 'left'. Note that this has no effect if inline is true.
delimiter
The text that splits the 'from' and the 'to' text when selecting a range. Defaults to “ to ”.
endDate
The default ending date to display, in YYYY-MM-DD hh:mm:ss format.
maxScale
The largest amount of time to offer in the list of suggested time-ranges, in minutes. For example, '1440' is a full day.
minScale
The smallest amount of time to offer in the list of suggested time-ranges, in minutes. Defaults to '10'.
inline
If true, this control appears already open. If false, this appears as a drop-down list.
liveOption
Give the user the option to select 'live' as a time-range.
mode
If the control should let the user select a range of time ('range' mode), or a single moment of time ('moment' mode). Defaults to 'range' if not specified.
onrangechange
A function that is called whenever the user selects a new range. This function has four parameters…
| Order | Name | Meaning |
|---|---|---|
| 1 | Local Start | Selected start time in the local time zone |
| 2 | Local End | Selected end time in the local time zone |
| 3 | UTC Start | Selected start time in the UTC time zone |
| 4 | UTC End | Selected end time in the UTC time zone |
protocol
'http' to use insecure HTTP protocol, or 'https' if you want to force secure connection. If not provided, this is automatically selected based on the current web URL.
redirectDate
When the user selects a new time, write the result to this jquery object.
server
A relative or absolute URL to the ARDI server. This is used when requesting events and loading other interactive pages.
startDate
The default starting date to display, in YYYY-MM-DD hh:mm:ss format.