Class: GroupOptions

GroupOptions()

new GroupOptions()

The GroupOptions type holds all options an Group can display or own

Every option of the GroupOptions type has associated a property of the Group object. For instance, the option:

caption {string}, defines the caption of the group
is associated with the property:
Caption {string}, defines the caption of the group (the group's header displays its caption)
which means that the following statements are equivalent:
oGroup.Options = {caption: "group"}
oGroup.SetOptions({caption: "group"})
oGroup.Caption = "group"
oGroup.SetCaption("group")
where oGroup is an object of Group type

Members

(static) caption :any

The caption field defines the caption of the group (the group's header displays its caption).
Type:
  • any
Example
null {null}, resets the caption of the group
 "caption" {string}, defines the plain-caption for the group

(static) eventShape :any

The eventShape field defines the shape to apply on events of the same group. The eventShape 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 group 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) headerShape :any

The headerShape field defines the shape for the group's header. The headerShape 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 group 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) id :any

The id field specifies the group's unique identifier.
Type:
  • any
Example
"G1" {number}, defines the group with the identifier (G1). You can use the oSchedule.Group("G1") method to request the group giving its identifier.

(static) position :number

The position field specifies the group's position.
Type:
  • number
Example
null {null}, the null value has no effect
 0 {number}, moves the group on the first position

(static) title :any

The title field defines the title of the group (the group's title defines the caption of the group within the groups list, visible once the user clicks the drop down grouping button).
Type:
  • any
Example
null {null}, indicates that that group's caption is also the group's title
 "" {string}, shows no title for the group
 "title" {string}, defines the plain-title for the group

(static) visible :boolean

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

(static) width :number

The width field specifies the group's width.
Type:
  • number
Example
-1 {number} or null {null}, all groups with width on null are shown equaly
 128 {number}, defines the width of 128px