Equipment Schedule
Component Palette Icon:
The equipment schedule view is a mix between the status chart, gantt chart, and a calendar view. It conveys a lot of information about equipment, including current status, production schedule, production status, scheduled and unexpected downtime.
The equipment schedule is powered by four datasets. Information is retrieved from the datasets by column name, case-insensitive. The order of the columns is not important. Optional columns may be omitted.
The "Items" Dataset
Describes the "items" or "cells" to display schedules for. Each entry in this dataset will become a row of the chart.
|
Name |
Type |
Optional |
Description |
|
ID |
Any |
N |
The identifier for this item. May be any type, will referenced by each entry in the Scheduled Events dataset. |
|
Label |
String |
N |
The text to display in the header |
|
Foreground |
Color |
Y |
Text color |
|
Background |
Color |
Y |
Background color |
|
StatusImagePath |
String |
Y |
A path to an image to display to the right of the header label |
The "Scheduled Items" Dataset
Lists the scheduled events for each item described in the "Items" dataset. Each scheduled event can have a colored lead, or change-over time, a label, a background color, and a progress.
|
Name |
Type |
Optional |
Description |
|
EventId |
String |
Y |
An identifier for the event, used for event selection. |
|
ItemId |
Any |
N |
The ID of the item to correlate this event with. If no such item is found, the event won't be shown. |
|
Label |
String |
N |
The text ot display in the event's box |
|
StartDate |
Date |
N |
The start-time for the event |
|
EndDate |
Date |
N |
The end-time for the event |
|
Foreground |
Color |
Y |
The text color of the event |
|
Background |
Color |
Y |
The background color of the event |
|
LeadTime |
Integer |
Y |
Time, in seconds, to display as lead time. |
|
LeadColor |
Color |
Y |
The color for the lead time, if any. |
|
PctDone |
Number |
Y |
A value from 0 to 100 to be displayed as a progress bar, use -1 to hide progress bar. |
The "Downtime" Dataset
Entries in this dataset will be displayed as simple colored overlays on top of the events, correlated against an item defined in the "Items" dataset.
|
Name |
Type |
Optional |
Description |
|
ItemId |
Any |
N |
The ID of the item to correlate this downtime event with. If no such item is found, the downtime event won't be shown. |
|
StartDate |
Date |
N |
The start-time for the downtime event |
|
EndDate |
Date |
N |
The start-time for the downtime event |
|
Color |
Color |
Y |
The color to use, typically transparent. |
|
Layer |
Integer |
Y |
0 or 1, with 0 meaning that the rectangle gets painted below the events, and 1 means it will be painted above the events. |
The "Breaks" Dataset
Entries in this dataset will be displayed as colored underlays beneath all events.
|
Name |
Type |
Optional |
Description |
|
StartDate |
Date |
N |
The start-time for the break event |
|
EndDate |
Date |
N |
The start-time for the break event |
|
Color |
Color |
Y |
The color to use |
|
Name |
Description |
Property Type |
Scripting |
Category |
|
Antialias |
Draw with antialias on? Makes text smoother |
boolean |
.antialias |
Appearance |
|
Border |
The border surrounding this component. NOTE that the border is unaffected by rotation. |
Border |
.border |
Common |
|
Break Events |
Scheduled breaks, which will appear as downtime for all items. |
Dataset |
.breakEvents |
Data |
|
Current Time Color |
The color of the current time indicator |
Color |
.nowColor |
Appearance |
|
Downtime Events |
Downtime events correlated to a specific item |
Dataset |
.downtimeEvents |
Data |
|
Drag Enabled |
Controls whether or not scheduled events can be dragged for rescheduling. |
boolean |
.dragEnabled |
Behavior |
|
Enabled |
If disabled, a component cannot be used. |
boolean |
.componentEnabled |
Common |
|
End Date |
The end of the time range to display. |
Date |
.endDate |
Data |
|
Event Border |
The normal border for a scheduled event |
Border |
.eventBorder |
Appearance |
|
Event Font |
The font to use for the event labels. |
Font |
.eventFont |
Appearance |
|
Event Margin |
The margin to leave visible above and below a scheduled event. |
int |
.scheduledEventMargin |
Appearance |
|
Header Background |
The color of the background for the header timeline. |
Color |
.headerBackground |
Appearance |
|
Header Font |
The font of the text in the header timeline. |
Font |
.headerFont |
Appearance |
|
Header Item Font |
The font to use for the header items' labels. |
Font |
.itemFont |
Appearance |
|
Header Text Color |
The color of the text in the header timeline. |
Color |
.headerTextColor |
Appearance |
|
Items |
The cells, or equipment items, to have their schedules displayed. |
Dataset |
.items |
Data |
|
Line Color |
The color of separating lines in the schedule. |
Color |
.lineColor |
Appearance |
|
Name |
The name of this component. |
String |
.name |
Common |
|
Progress Bar Background |
The background color for the event progress bars |
Color |
.progressBackground |
Appearance |
|
Progress Bar Border |
The border color for the event progress bars |
Color |
.progressBorder |
Appearance |
|
Progress Bar Fill |
The color for 'done' portion the event progress bars |
Color |
.progressFill |
Appearance |
|
Resize Enabled |
Controls whether or not scheduled events resized for duration changes. |
boolean |
.resizeEnabled |
Behavior |
|
Row Height |
The height of each event's schedule row |
int |
.lineHeight |
Appearance |
|
Schedule Background |
The background color of the schedule area |
Color |
.scheduleBackground |
Appearance |
|
Scheduled Events |
The scheduled events for all configured items |
Dataset |
.scheduledEvents |
Data |
|
Selected Event Border |
The border for a selected scheduled event |
Border |
.selectedEventBorder |
Appearance |
|
Selected Event ID |
The ID of the selected event. |
String |
.selectedEvent |
Data |
|
Start Date |
The beginning of the time range to display. |
Date |
.startDate |
Data |
|
Visible |
If disabled, the component will be hidden. |
boolean |
.visible |
Common |
This component does not have scripting functions associated with it.
onBackgroundDragged
-
Description
Called when the user drags a segment on the schedule background.
-
Parameters
Component self - A reference to the component that is invoking this function.
int itemID - The ID of the equipment item of the row where the user dragged.
Date startDate - The datetime corresponding to where the user started dragging.
Date endDate - The datetime corresponding to where the user ended dragging.
Event Object event - The mouse event.
-
Return
Nothing
-
Scope
Client
onEventClicked
-
Description
Called when the user clicks on a scheduled event. Use event.clickCount to detect double clicks.
-
Parameters
Component self - A reference to the component that is invoking this function.
int itemID - The ID of the equipment item of the event that was clicked on.
int eventId - The ID of the event that was clicked on.
Event Object event - The mouse event.
-
Return
Nothing
-
Scope
Client
onEventDropped
-
Description
Called when the user drags and drops a scheduled event. It is up to this script to actually alter the underlying data to reflect the schedule change.
-
Parameters
Component self - A reference to the component that is invoking this function.
int eventId - The ID of the scheduled event that was moved.
int oldItemId - The ID of the item this event was originally correlated against.
int newItemId - The ID of the item whose schedule the event was dropped on.
Date oldStartDate - The original starting datetime of the event.
Date newStartDate - The new starting datetime of the event.
Date newEndDate - The new ending datetime of the event.
-
Return
Nothing
-
Scope
Client
onEventPopupTrigger
-
Description
Called when the user right-clicks on a scheduled event. This would be the appropriate time to create and display a popup menu.
-
Parameters
Component self - A reference to the component that is invoking this function.
int itemId - The ID of the equipment item of the event that was right-clicked on.
int eventId - The ID of the event that was right-clicked on.
Event Object event - The mouse event that caused the popup trigger.
-
Return
Nothing
-
Scope
Client
onEventResized
-
Description
Called when the user drags the edge of an event to resize its time span. It is up to this script to actually alter the underlying data to reflect the schedule change.
-
Parameters
Component self - A reference to the component that is invoking this function.
int eventId - The ID of the scheduled event that was resized.
int itemId - The ID of the item this event is correlated against.
Date oldStartDate - The original starting datetime of the event.
Date oldEndData - The original ending datetime of the event.
Date newStartDate - The new starting datetime of the event.
Date newEndDate - The new ending datetime of the event.
-
Return
Nothing
-
Scope
Client
onPopupTrigger
-
Description
Called when the user right-clicks outside of an event. This would be the appropriate time to create and display a popup menu.
-
Parameters
Component self - A reference to the component that is invoking this function.
int itemId - The item ID of the equipment line that was clicked on (if any).
Event Object event - The mouse event that caused the popup trigger.
-
Return
Nothing
-
Scope
Client
mouse
mouseClicked
This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (1) if the Shift key was held down during this event, false (0) otherwise. |
mouseEntered
This event fires when the mouse enters the space over the source component.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (1) if the Shift key was held down during this event, false (0) otherwise. |
mouseExited
This event fires when the mouse leaves the space over the source component.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (1) if the Shift key was held down during this event, false (0) otherwise. |
mousePressed
This event fires when a mouse button is pressed down on the source component.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (1) if the Shift key was held down during this event, false (0) otherwise. |
mouseReleased
This event fires when a mouse button is released, if that mouse button's press happened over this component.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (1) if the Shift key was held down during this event, false (0) otherwise. |
mouseMotion
mouseDragged
Fires when the mouse moves over a component after a button has been pushed.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (1) if the Shift key was held down during this event, false (0) otherwise. |
mouseMoved
Fires when the mouse moves over a component, but no buttons are pushed.
|
.source |
The component that fired this event |
|
.button |
The code for the button that caused this event to fire. |
|
.clickCount |
The number of mouse clicks associated with this event. |
|
.x |
The x-coordinate (with respect to the source component) of this mouse event. |
|
.y |
The y-coordinate (with respect to the source component) of this mouse event. |
|
.popupTrigger |
Returns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists. |
|
.altDown |
True (1) if the Alt key was held down during this event, false (0) otherwise. |
|
.controlDown |
True (1) if the Control key was held down during this event, false (0) otherwise. |
|
.shiftDown |
True (1) if the Shift key was held down during this event, false (0) otherwise. |
propertyChange
propertyChange
Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.
|
.source |
The component that fired this event |
|
.newValue |
The new value that this property changed to. |
|
.oldValue |
The value that this property was before it changed. Note that not all components include an accurate oldValue in their events. |
|
.propertyName |
The name of the property that changed. NOTE: remember to always filter out these events for the property that you are looking for! Components often have many properties that change. |
scheduleDrop
scheduledEventDropped
This event is deprecated. Please use the onEventDropped extension function.
There are no examples associated with this component.