new BackgroundOptions()
The BackgroundOptions object defines options to show different parts of the control, and it is stored by background field of the Schedule.Options object. The BackgroundOptions type defines all kind of options related to the control's background, such as the color and style of the major and minor rulers, the caption of the header's grouping-button, the color of the event's arrows when an event continues on a previously or next day (multi-dates event), etc.
The sample is equivalent to the following code, which sets the majorTimeRulerColor field of the BackgroundOptions object:
For instance, the "majorTimeRulerColor" option:
background: { majorTimeRulerColor: "red" }shows the major-rulers of the schedule view in red.
oSchedule.Background = {majorTimeRulerColor: "red"}where oSchedule is the Schedule object.
Members
(static) eventContinueDay :string
The eventContinueDay field specifies the up/down/keft/right arrow's color when event continues on previously or next day (multi-dates event), single-date event starts before time-scale's start time, ends after time-scale's end time. By default, the eventContinueDay field is set to "black", which shows the arrows in black. The MiscellaneousOptions.arrowSizeMultiDatesEvent field specifies the size of the up/down arrow(s) to show within the multi-dates events.
Type:
- string
Example
null {null} or "transparent" {string} hides the event's up/down arrow(s)
"red" {string} shows the event's up/down arrow(s) in red(static) groupingButtonCaption :string
The groupingButtonCaption field specifies the ex-HTML caption of the header's grouping-button. The grouping button allows the user to toggle the visibility of grouped events within the schedule view. When the user clicks the grouping button, the schedule view shows or hides the groups of events. The displayGroupingButton field gets or sets a value that indicates whether the grouping button is displayed in the date header. The showGroupingEvents field specifies whether the schedule view shows grouped events. By default, the groupingButtonCaption field is set to "…" (horizontal ellipsis), which shows the horizontal ellipsis (three horizontal dots) as the caption for the grouping button. This indicates to users that there are additional options or grouped events available when they click the button.
Type:
- string
Example
null {null}, show the horizontal ellipsis (three horizontal dots)
"" {string}, hides the caption for all grouping-buttons
"+" {string}, displays '+' character for all grouping-buttons(static) majorTimeRulerColor :string
The majorTimeRulerColor field specifies the color of the major ruler line, within the schedule panel. The majorTimeRulerStyle field specifies the style of the major ruler line, within the schedule panel. The majorTimeLabel field defines the label of the time-scale's major ruler. The majorTimeRuler field indicates the increment for the time-scale's major ruler. Together, the majorTimeLabel and majorTimeRuler fields control the display of the major rulers on the time-scale.
Type:
- string
Example
"transparent" or "rgba(0,0,0,0)" {string}, hides the lines
"red" {string} shows the ruler in red(static) majorTimeRulerStyle :any
The majorTimeRulerStyle field specifies the style of the major ruler line, within the schedule panel. The majorTimeRulerColor field specifies the color of the major ruler line, within the schedule panel. The majorTimeLabel field defines the label of the time-scale's major ruler. The majorTimeRuler field indicates the increment for the time-scale's major ruler. Together, the majorTimeLabel and majorTimeRuler fields control the display of the major rulers on the time-scale.
Type:
- any
Example
null {null}, defines a solid line
[] {array}, indicates a solid line
2 {number}, will become [2, 2, ...]
[5, 15, 25] {array}, will become [5, 15, 25, 5, 15, 25, ...](static) timeScaleMajorTimeRulerColor :string
The timeScaleMajorTimeRulerColor field specifies the color of the timeScaleMajor ruler line, within the time-scale panel. The timeScaleMajorTimeRulerStyle field specifies the style of the timeScaleMajor ruler line, within the time-scale panel. The majorTimeLabel field defines the label of the time-scale's major ruler. The majorTimeRuler field indicates the increment for the time-scale's major ruler. Together, the majorTimeLabel and majorTimeRuler fields control the display of the major rulers on the time-scale.
Type:
- string
Example
"transparent" or "rgba(0,0,0,0)" {string}, hides the lines
"red" {string} shows the ruler in red(static) timeScaleMajorTimeRulerStyle :any
The timeScaleMajorTimeRulerStyle field specifies the style of the timeScaleMajor ruler line, within the time-scale panel. The timeScaleMajorTimeRulerColor field specifies the color of the timeScaleMajor ruler line, within the time-scale panel. The majorTimeRuler field indicates the increment for the time-scale's major ruler. Together, the majorTimeLabel and majorTimeRuler fields control the display of the major rulers on the time-scale.
Type:
- any
Example
null {null}, defines a solid line
[] {array}, indicates a solid line
2 {number}, will become [2, 2, ...]
[5, 15, 25] {array}, will become [5, 15, 25, 5, 15, 25, ...](static) timeScaleMinorTimeRulerColor :string
The timeScaleMinorTimeRulerColor field specifies the color of the timeScaleMinor ruler line, within the time-scale panel. The timeScaleMinorTimeRulerStyle field specifies the style of the timeScaleMinor ruler line, within the time-scale panel. The minorTimeLabel field defines the label of the time-scale's minor ruler. The minorTimeRuler field indicates the increment for the time-scale's minor ruler. Together, the minorTimeLabel and minorTimeRuler fields control the display of the minor rulers on the time-scale.
Type:
- string
Example
"transparent" or "rgba(0,0,0,0)" {string}, hides the lines
"red" {string} shows the ruler in red(static) timeScaleMinorTimeRulerStyle :any
The timeScaleMinorTimeRulerStyle field specifies the style of the timeScaleMinor ruler line, within the time-scale panel. The timeScaleMinorTimeRulerColor field specifies the color of the timeScaleMinor ruler line, within the time-scale panel. The minorTimeLabel field defines the label of the time-scale's minor ruler. The minorTimeRuler field indicates the increment for the time-scale's minor ruler. Together, the minorTimeLabel and minorTimeRuler fields control the display of the minor rulers on the time-scale.
Type:
- any
Example
null {null}, defines a solid line
[] {array}, indicates a solid line
2 {number}, will become [2, 2, ...]
[5, 15, 25] {array}, will become [5, 15, 25, 5, 15, 25, ...]