MiscellaneousOptions class (Schedule)

MiscellaneousOptions()

new MiscellaneousOptions()

The MiscellaneousOptions object defines the control's default miscellaneous options, hold by misc option of the Schedule.Options

For instance, the "requireTimeScaleHeight" option:

misc: { requireTimeScaleHeight: 0 }
hides entirely the view's time-scale.
MiscellaneousOptions

Members

(static) allowEmptyEvents :number|string

The allowEmptyEvents field specifies whether the user can create empty events by drag and drop. The allowEmptyEvents field can be one of the following:
  • {number}
    • 0 {number}, permits empty events or events with duration 0 (start and end are equals)
    • positive {number}, specifies how many minorTimeRuler defines the minimum duration
    • negative {number}, that indicates the number of miliseconds (absolute value)
  • {string}, indicates the hours and minutes in "hh:mm" format
.
Type:
  • number | string
allowEmptyEvents

(static) arrangeEventsOnDrag :boolean

The arrangeEventsOnDrag field indicates whether the control re-arranges the events during the drag and drop.
Type:
  • boolean
Example
false {boolean}, no event gets arranged during the drag and drop
  true {boolean}, the events get arranged during the drag and drop
arrangeEventsOnDrag

(static) arrowSizeMultiDatesEvent :number|Array.<number>

The arrowSizeMultiDatesEvent field specifies the size of the up/down arrow(s) to show within the multi-dates events. The arrowSizeMultiDatesEvent field can be a number which indicates a fixed width, or an array of [min, max] type that specifies the minimum and maximum size of the arrow. The size of the up/down arrow depends on the size of the event/date.
Type:
  • number | Array.<number>
arrowSizeMultiDatesEvent

(static) createEventMargin :number

The createEventMargin field specifies the size of the right-margin/down-margin of each date to allow users to create new events by drag and drop.
Type:
  • number
createEventMargin

(static) displayTimeScaleHeight :number

The displayTimeScaleHeight field specifies the minimum-height for the day's time-scale so it is visible. The displayTimeScaleHeight field is relative to the control's font size while positive or fixed if negative.
Type:
  • number
displayTimeScaleHeight

(static) dragAlpha :number

The dragAlpha field specifies the transparency to display the source-event being dragged.
Type:
  • number
dragAlpha

(static) dragAlphaNegate :boolean

The dragAlphaNegate field indicates that the dragAlpha transparency is applied to any other than source-event.
Type:
  • boolean
dragAlphaNegate

(static) dragDummyAlpha :number

The dragDummyAlpha field specifies the transparency to display the dummy-event being dragged. The dummy-event is moved during drag and drop.
Type:
  • number
dragDummyAlpha

(static) dragStartOnMove :number

The dragStartOnMove field specifies the drag-operations (create, resize or move) that start once the pointer is moved. The dragStartOnMove field can be a combination of zero, one or more of the following values:
  • 1 {number}, create a new event by drag and drop
  • 2 {number}, resize one or more events by drag and drop
  • 4 {number}, move one or more events by drag and drop
.
Type:
  • number
Example
0 {number}, any drag-operation (create, resize or move) begins once the user clicks the view, without initially dragging the pointer
  -1 {number}, any  drag-operation (create, resize or move) begins once the user clicks and drags the pointer
  1 {number}, a new event is created once the user clicks and drags the pointer (prevents creating a new event once the user clicks the control without dragging/moving the mouse/pointer)
  6 {number}, the move or resize drag-operation begins once the user clicks and drags the pointer
dragStartOnMove

(static) ensureVisibleOnDrag :number

The ensureVisibleOnDrag field specifies the drag-operations (create, resize or move) that calls the EnsureVisibleClient() method once the drag-operation ends. The EnsureVisibleClient() method scrolls the control's content to ensure that the event fits the view's client-area. The ensureVisibleOnDrag field can be a combination of zero, one or more of the following values:
  • 1 {number}, create a new event by drag and drop
  • 2 {number}, resize one or more events by drag and drop
  • 4 {number}, move one or more events by drag and drop
.
Type:
  • number
Example
0 {number}, no EnsureVisibleClient() method is called once any drag-operation (create, resize or move) ends
  -1 {number}, the EnsureVisibleClient() method is called for any drag and drop operation (create, resize or move)
  1 {number}, the EnsureVisibleClient() method is called only if the user creates new events by drag and drop
  6 {number}, the EnsureVisibleClient() method is called only if the user moves or resizes events by drag and drop
ensureVisibleOnDrag

(static) eventDisplayMarginsSep :string

The eventDisplayMarginsSep field indicates the separator character(s) between start and end date-times.
Type:
  • string
eventDisplayMarginsSep

(static) eventMargin :number|Array.<number>

The eventMargin field specifies the distance (horizontal or/and vertical) between events and date's borders.
Type:
  • number | Array.<number>
eventMargin

(static) formatCreateEventLabel :exontrol.DrawTextFormatEnum

The formatCreateEventLabel field specifies the format and alignment to display the event's label while user creates it by drag and drop. A combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the event's label event's label while user creates it by drag and drop.
The exontrol.DrawTextFormatEnum type support the following flags:
  • exTextAlignTop (0x00), justifies the text to the top of the rectangle
  • exTextAlignLeft (0x00), aligns text to the left
  • exTextAlignCenter (0x01), centers text horizontally in the rectangle
  • exTextAlignRight (0x02), aligns text to the right
  • exTextAlignVCenter (0x04), centers text vertically
  • exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
  • exTextAlignMask (0x0F), specifies the mask for text's alignment.
  • exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
  • exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
  • exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
  • exPlainText (0x80), treats the text as plain text.
  • exTextNoClip (0x0100), draws without clipping.
  • exHTMLTextNoColors (0x0200), ignores the and tags.
  • exTextCalcRect (0x0400), determines the width and height of the text.
  • exHTMLTextNoTags (0x0800), ignores all HTML tags.
  • exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
  • exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
  • exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
.
Type:
  • exontrol.DrawTextFormatEnum
Example
null {null}, centers the caption
  32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
  0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned
formatCreateEventLabel

(static) formatEventExtraLabel :exontrol.DrawTextFormatEnum

The formatEventExtraLabel field specifies the format and alignment to display the event's short-label. A combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the event's short-label.
The exontrol.DrawTextFormatEnum type support the following flags:
  • exTextAlignTop (0x00), justifies the text to the top of the rectangle
  • exTextAlignLeft (0x00), aligns text to the left
  • exTextAlignCenter (0x01), centers text horizontally in the rectangle
  • exTextAlignRight (0x02), aligns text to the right
  • exTextAlignVCenter (0x04), centers text vertically
  • exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
  • exTextAlignMask (0x0F), specifies the mask for text's alignment.
  • exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
  • exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
  • exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
  • exPlainText (0x80), treats the text as plain text.
  • exTextNoClip (0x0100), draws without clipping.
  • exHTMLTextNoColors (0x0200), ignores the and tags.
  • exTextCalcRect (0x0400), determines the width and height of the text.
  • exHTMLTextNoTags (0x0800), ignores all HTML tags.
  • exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
  • exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
  • exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
.
Type:
  • exontrol.DrawTextFormatEnum
Example
null {null}, centers the caption
  32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
  0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned
formatEventExtraLabel

(static) formatEventLongLabel :exontrol.DrawTextFormatEnum

The formatEventLongLabel field specifies the format and alignment to display the event's long-label. A combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the event's long-label.
The exontrol.DrawTextFormatEnum type support the following flags:
  • exTextAlignTop (0x00), justifies the text to the top of the rectangle
  • exTextAlignLeft (0x00), aligns text to the left
  • exTextAlignCenter (0x01), centers text horizontally in the rectangle
  • exTextAlignRight (0x02), aligns text to the right
  • exTextAlignVCenter (0x04), centers text vertically
  • exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
  • exTextAlignMask (0x0F), specifies the mask for text's alignment.
  • exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
  • exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
  • exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
  • exPlainText (0x80), treats the text as plain text.
  • exTextNoClip (0x0100), draws without clipping.
  • exHTMLTextNoColors (0x0200), ignores the and tags.
  • exTextCalcRect (0x0400), determines the width and height of the text.
  • exHTMLTextNoTags (0x0800), ignores all HTML tags.
  • exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
  • exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
  • exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
.
Type:
  • exontrol.DrawTextFormatEnum
Example
null {null}, centers the caption
  32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
  0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned
formatEventLongLabel

(static) formatEventShortLabel :exontrol.DrawTextFormatEnum

The formatEventShortLabel field specifies the format and alignment to display the event's short-label. A combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the event's short-label.
The exontrol.DrawTextFormatEnum type support the following flags:
  • exTextAlignTop (0x00), justifies the text to the top of the rectangle
  • exTextAlignLeft (0x00), aligns text to the left
  • exTextAlignCenter (0x01), centers text horizontally in the rectangle
  • exTextAlignRight (0x02), aligns text to the right
  • exTextAlignVCenter (0x04), centers text vertically
  • exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
  • exTextAlignMask (0x0F), specifies the mask for text's alignment.
  • exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
  • exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
  • exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
  • exPlainText (0x80), treats the text as plain text.
  • exTextNoClip (0x0100), draws without clipping.
  • exHTMLTextNoColors (0x0200), ignores the and tags.
  • exTextCalcRect (0x0400), determines the width and height of the text.
  • exHTMLTextNoTags (0x0800), ignores all HTML tags.
  • exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
  • exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
  • exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
.
Type:
  • exontrol.DrawTextFormatEnum
Example
null {null}, centers the caption
  32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
  0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned
formatEventShortLabel

(static) formatGroupCaption :exontrol.DrawTextFormatEnum

The formatGroupCaption field specifies the format and alignment to display the group's caption. A combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the group's caption.
The exontrol.DrawTextFormatEnum type supports the following flags:
  • exTextAlignTop (0x00), justifies the text to the top of the rectangle
  • exTextAlignLeft (0x00), aligns text to the left
  • exTextAlignCenter (0x01), centers text horizontally in the rectangle
  • exTextAlignRight (0x02), aligns text to the right
  • exTextAlignVCenter (0x04), centers text vertically
  • exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
  • exTextAlignMask (0x0F), specifies the mask for text's alignment.
  • exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
  • exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
  • exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
  • exPlainText (0x80), treats the text as plain text.
  • exTextNoClip (0x0100), draws without clipping.
  • exHTMLTextNoColors (0x0200), ignores the and tags.
  • exTextCalcRect (0x0400), determines the width and height of the text.
  • exHTMLTextNoTags (0x0800), ignores all HTML tags.
  • exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
  • exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
  • exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
.
Type:
  • exontrol.DrawTextFormatEnum
Example
null {null}, centers the caption
  32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
  0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned
formatGroupCaption

(static) formatMarkZoneCaption :exontrol.DrawTextFormatEnum

The formatMarkZoneCaption field specifies the format and alignment to display the mark-zone's caption. A combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the mark-zone's caption.
The exontrol.DrawTextFormatEnum type support the following flags:
  • exTextAlignTop (0x00), justifies the text to the top of the rectangle
  • exTextAlignLeft (0x00), aligns text to the left
  • exTextAlignCenter (0x01), centers text horizontally in the rectangle
  • exTextAlignRight (0x02), aligns text to the right
  • exTextAlignVCenter (0x04), centers text vertically
  • exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
  • exTextAlignMask (0x0F), specifies the mask for text's alignment.
  • exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
  • exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
  • exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
  • exPlainText (0x80), treats the text as plain text.
  • exTextNoClip (0x0100), draws without clipping.
  • exHTMLTextNoColors (0x0200), ignores the and tags.
  • exTextCalcRect (0x0400), determines the width and height of the text.
  • exHTMLTextNoTags (0x0800), ignores all HTML tags.
  • exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
  • exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
  • exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
.
Type:
  • exontrol.DrawTextFormatEnum
Example
null {null}, centers the caption
  32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
  0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned
formatMarkZoneCaption

(static) formatUpdateEventLabel :exontrol.DrawTextFormatEnum

The formatUpdateEventLabel field specifies the format and alignment to display the event's label while user moves or resizes it by drag and drop. A combination of one or more exontrol.DrawTextFormatEnum flags that defines the format to show the event's label event's label while user creates it by drag and drop.
The exontrol.DrawTextFormatEnum type support the following flags:
  • exTextAlignTop (0x00), justifies the text to the top of the rectangle
  • exTextAlignLeft (0x00), aligns text to the left
  • exTextAlignCenter (0x01), centers text horizontally in the rectangle
  • exTextAlignRight (0x02), aligns text to the right
  • exTextAlignVCenter (0x04), centers text vertically
  • exTextAlignBottom (0x08), justifies the text to the bottom of the rectangle.
  • exTextAlignMask (0x0F), specifies the mask for text's alignment.
  • exTextWordBreak (0x10), breaks words. Lines are automatically broken between words if a word would extend past the edge of the rectangle specified by the lpRect parameter. A carriage return-line feed sequence also breaks the line. If this is not specified, output is on one line.
  • exTextSingleLine (0x20), displays text on a single line only. Carriage returns and line feeds do not break the line.
  • exTextExpandTabs (0x40), expands tab characters. The default number of characters per tab is eight.
  • exPlainText (0x80), treats the text as plain text.
  • exTextNoClip (0x0100), draws without clipping.
  • exHTMLTextNoColors (0x0200), ignores the and tags.
  • exTextCalcRect (0x0400), determines the width and height of the text.
  • exHTMLTextNoTags (0x0800), ignores all HTML tags.
  • exTextPathEllipsis (0x4000), for displayed text, replaces characters in the middle of the string with ellipses so that the result fits in the specified rectangle. If the string contains backslash (\) characters, exTextPathEllipsis preserves as much as possible of the text after the last backslash.
  • exTextEndEllipsis (0x8000), for displayed text, if the end of a string does not fit in the rectangle, it is truncated and ellipses are added. If a word that is not at the end of the string goes beyond the limits of the rectangle, it is truncated without ellipses.
  • exTextWordEllipsis (0x040000), truncates any word that does not fit in the rectangle and adds ellipses.
.
Type:
  • exontrol.DrawTextFormatEnum
Example
null {null}, centers the caption
  32 or exontrol.DrawTextFormatEnum.exTextSingleLine {number}, defines a single-line caption
  0x2A or exontrol.DrawTextFormatEnum.exTextSingleLine | exontrol.DrawTextFormatEnum.exTextAlignRight | exontrol.DrawTextFormatEnum.exTextAlignBottom {number}, defines a single-line caption right/bottom-aligned
formatUpdateEventLabel

(static) groupingButtonPrompt :string

The groupingButtonPrompt field defines the message to show within the prompt, once the user clicks the header's grouping-button (if no exontrol.menu library is not included).
Type:
  • string
groupingButtonPrompt

(static) minHeight :number

The minHeight field specifies the minimum-height for the day's view. The minHeight field is relative to the control's font size while positive or fixed if negative.
Type:
  • number
minHeight

(static) padSelectEvent :number|string|array

The padSelectEvent field specifies the distance between event and its selected-border. The padSelectEvent field has effect only if the selectEventStyle option is 1 (the event's shape and color is not altered so the "select" shape is displayed on the event's background).
Type:
  • number | string | array
padSelectEvent

(static) requireRulerDistance :number

The requireRulerDistance field specifies the minimum-distance between two consecutive rulers. The requireRulerDistance field is relative to the control's font size while positive or fixed if negative.
Type:
  • number
requireRulerDistance

(static) requireTimeScaleHeight :number

The requireTimeScaleHeight field specifies the minimum-height for the view's time-scale header to be visible. The requireTimeScaleHeight field is relative to the control's font size while positive or fixed if negative.
Type:
  • number
requireTimeScaleHeight