Equipment Schedule

charts_EquipmentScheduleView

Description

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

Properties

Appearance

Event Border

The normal border for a scheduled event

Scripting name	eventBorder
Data type	Border

Selected Event Border

The border for a selected scheduled event

Scripting name	selectedEventBorder
Data type	Border

Row Height

The height of each event's schedule row

Scripting name	lineHeight
Data type	int

Event Margin

The margin to leave visible above and below a scheduled event.

Scripting name	scheduledEventMargin
Data type	int

Schedule Background

The background color of the schedule area

Scripting name	scheduleBackground
Data type	Color

Current Time Color

The color of the current time indicator

Scripting name	nowColor
Data type	Color

Line Color

The color of separating lines in the schedule.

Scripting name	lineColor
Data type	Color

Header Font

The font of the text in the header timeline.

Scripting name	headerFont
Data type	Font

Header Text Color

The color of the text in the header timeline.

Scripting name	headerTextColor
Data type	Color

Header Background

The color of the background for the header timeline.

Scripting name	headerBackground
Data type	Color

Progress Bar Background

The background color for the event progress bars

Scripting name	progressBackground
Data type	Color

Progress Bar Fill

The color for 'done' portion the event progress bars

Scripting name	progressFill
Data type	Color

Progress Bar Border

The border color for the event progress bars

Scripting name	progressBorder
Data type	Color

Header Item Font

The font to use for the header items' labels.

Scripting name	itemFont
Data type	Font

Event Font

The font to use for the event labels.

Scripting name	eventFont
Data type	Font

Antialias

Draw with antialias on? Makes text smoother

Scripting name	antialias
Data type	boolean
Flags	expert

Behavior

Drag Enabled

Controls whether or not scheduled events can be dragged for rescheduling.

Scripting name	dragEnabled
Data type	boolean

Resize Enabled

Controls whether or not scheduled events resized for duration changes.

Scripting name	resizeEnabled
Data type	boolean

Common

Name

The name of this component.

Scripting name	name
Data type	String
Flags	bindable

Enabled

If disabled, a component cannot be used.

Scripting name	componentEnabled
Data type	boolean

Visible

If disabled, the component will be hidden.

Scripting name	visible
Data type	boolean
Flags	bindable

Border

The border surrounding this component. NOTE that the border is unaffected by rotation.

Scripting name	border
Data type	Border

Data

Items

The cells, or equipment items, to have their schedules displayed.

Scripting name	items
Data type	Dataset
Flags	bindable

Scheduled Events

The scheduled events for all configured items

Scripting name	scheduledEvents
Data type	Dataset
Flags	bindable

Downtime Events

Downtime events correlated to a specific item

Scripting name	downtimeEvents
Data type	Dataset
Flags	bindable

Break Events

Scheduled breaks, which will appear as downtime for all items.

Scripting name	breakEvents
Data type	Dataset
Flags	bindable

Start Date

The beginning of the time range to display.

Scripting name	startDate
Data type	Date
Flags	bindable

End Date

The end of the time range to display.

Scripting name	endDate
Data type	Date
Flags	bindable

Selected Event ID

The ID of the selected event.

Scripting name	selectedEvent
Data type	String
Flags	bindable

Scripting

Events

The following event sets are fired by this component. See Component Event Handlers to learn more.

•

mouse

•	scheduleDrop

•	mouseMotion

•	propertyChange

Scripting Functions

This component has no special scripting functions.

Extension Functions

The equipment schedule has the following extension functions. See each function's doc string for usage details.

•	onBackgroundDragged()

•	onEventClicked()

•	onEventDropped()

•	onEventPopupTrigger()

•	onEventResized()

•	onPopupTrigger()