Class: TimeScaleOptions

TimeScaleOptions()

new TimeScaleOptions()

The TimeScaleOptions type holds all options the TimeScale can display or own

Every option of the TimeScaleOptions type has associated a property of the TimeScale object. For instance, the option:

cursor {string}, defines the mouse-cursor for the time-scale header
is associated with the property:
Cursor {string}, defines the mouse-cursor for individual time-scale header
which means that the following statements are equivalent:
oTimeScale.Options = {cursor: "pointer"}
oTimeScale.SetOptions({cursor: "pointer"})
oTimeScale.Cursor = "pointer"
oTimeScale.SetCursor("pointer")
where oTimeScale is an object of TimeScale type

Members

(static) allowResize :boolean

The allowResize field specifies whether the user can resize the time-scale header
Type:
  • boolean
Example
false {boolean}, the user can not resize the time-scale header by drag and drop
 true {boolean}, the user can resize the time-scale header by drag and drop

(static) caption :string

The caption field specifies the HTML caption to be displayed on the top side of the time scale.
Type:
  • string
Example
null {null}, no caption is displayed
 "<b>time" {string}, displays the "time" caption in bold

(static) cursor :string

The cursor field defines the mouse-cursor for individual time-scale header.
Type:
  • string
Example
"pointer" {string}, The cursor is a pointer that indicates a link (typically an image of a pointing hand)

(static) majorTimeLabel :string

The majorTimeLabel field defines the label of the time-scale's major ruler The majorTimeLabel field supports ex-HTLM tags such as (<b>, <i>, <fgcolor>, ...) and <%DATE%> tags as follows:

  • ><%h%> - Hour in one or two digits, as needed (0 to 23)
  • <%hh%> - Hour in two digits (00 to 23)
  • <%h12%> - Hour in 12-hour time format, in one or two digits - [0(12),11]
  • <%hh12%> - Hour in 12-hour time format, in two digits - [00(12),11]
  • <%n%> - Minute in one or two digits, as needed (0 to 59)
  • <%nn%> - Minute in two digits (00 to 59)
  • <%s%> - Second in one or two digits, as needed (0 to 59)
  • <%ss%> - Second in two digits (00 to 59)
  • <%AM/PM%> - Twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • <%loc_AM/PM%> - Indicates the time marker such as AM or PM using the current user regional and language settings
  • <%loc_A/P%> - Indicates the one character time marker such as A or P using the current user regional and language settings
Type:
  • string
Example
null {null}, the default label of the major ruler is "<%hh%>:<%nn%> <%AM/PM%>"
 "<%hh%>:<%nn%>" {string}, displays the major ruler without AM/PM indicators (24-hours)

(static) majorTimeRuler :string

The majorTimeRuler field indicates the increment for the time-scale's major ruler. The format of majorTimeRuler field is "HH[:MM[:NN]]" format, where HH indicates hours, MM indicates minutes, and NN indicates seconds
Type:
  • string
Example
null {null}, displays major rulers from hour to hour, equivalent of "01:00"
 "02:00" {string}, displays the major rulers every 2 hours

(static) maxWidth :number

The maxWidth field defines the maximal size of the time-scale header.
Type:
  • number
Example
null {null}, The maxWidth field is ignored
 96 {number}, The time-scale header maximal-size is set to 96

(static) minorTimeLabel :string

The minorTimeLabel field defines the label of the time-scale's minor ruler The minorTimeLabel field supports ex-HTLM tags such as (<b>, <i>, <fgcolor>, ...) and <%DATE%> tags as follows:

  • ><%h%> - Hour in one or two digits, as needed (0 to 23)
  • <%hh%> - Hour in two digits (00 to 23)
  • <%h12%> - Hour in 12-hour time format, in one or two digits - [0(12),11]
  • <%hh12%> - Hour in 12-hour time format, in two digits - [00(12),11]
  • <%n%> - Minute in one or two digits, as needed (0 to 59)
  • <%nn%> - Minute in two digits (00 to 59)
  • <%s%> - Second in one or two digits, as needed (0 to 59)
  • <%ss%> - Second in two digits (00 to 59)
  • <%AM/PM%> - Twelve-hour clock with the uppercase letters "AM" or "PM", as appropriate
  • <%loc_AM/PM%> - Indicates the time marker such as AM or PM using the current user regional and language settings
  • <%loc_A/P%> - Indicates the one character time marker such as A or P using the current user regional and language settings
Type:
  • string
Example
null {null}, the default label of the minor ruler is ":<%nn%>"
 "<%hh%>:<%nn%>" {string}, displays the minor ruler without AM/PM indicators (24-hours)

(static) minorTimeRuler :string

The minorTimeRuler field indicates the increment for the time-scale's minor ruler. The format of minorTimeRuler field is "HH[:MM[:NN]]" format, where HH indicates hours, MM indicates minutes, and NN indicates seconds
Type:
  • string
Example
null {null}, displays minor rulers from 15 to 15 minutes, equivalent of "00:15"
 "00:30" {string}, displays the minor rulers every half an hour

(static) minWidth :number

The minWidth field defines the minimal size of the time-scale header.
Type:
  • number
Example
null {null}, The minWidth field is ignored
 32 {number}, The time-scale header minimal-size is set to 32

(static) shape :any

The shape field defines the shape for individual time-scale header. The shape field can be any of the following:
  • the shape's name within the exontrol.Shape.Schedule or exontrol.Shape namespace
  • a CSS color
  • a JSON string-representation of an object of exontrol.Def.Shape type, for the time-scale header itself
  • an object of {normal,hover,click,disabled} type. The normal, hover, click and disabled are objects of exontrol.Def.Shape type
Type:
  • any
Example
null {null}, no custom shape is applied (default object's shape may be applied)
 "" {string}, no custom shape is applied (no default object's shape is be applied)
 "red" {string}, fills the object's background in red (CSS color)
 '{"fillColor": "red"}' or '{"normal":{"fillColor": "red"}}' {string}, fills the object's background in red (JSON-representation of an object of exontrol.Def.Shape type)
 "xxx" {string}, indicates that exontrol.Shapes.Schedule.xxx or exontrol.Shapes.xxx is applied on the object's background. If the xxx field is missing, no custom shape is applied (no default object's shape is be applied)
 exontrol.Shapes.Button {object}, applies the "Button" shape on the object as defined into exontrol.Shapes namespace

(static) timeZone :string

The timeZone field indicates the time zone for the time scale. The format of minorTimeRuler field is "[-]HH[:MM[:NN]]" format, where HH indicates hours, MM indicates minutes, and NN indicates seconds
Type:
  • string
Example
null {null}, no time delay is applied
 "-02:00" {string}, delays the time scale with 2 hours earlier
 "+03:00" {string}, adds a three hours to the current time

(static) visible :boolean

The visible field indicates whether the time-scale header is visible or hidden.
Type:
  • boolean
Example
false {boolean}, hides the time-scale header
 true {boolean}, shows the time-scale header

(static) width :number

The width field defines the size of the time-scale header.
Type:
  • number
Example
null {null}, Sets the time-scale's width to 9
 64 {number}, Sets the size of the time-scale header to 64