Page History

New_in

Version	8.1.12

The Equipment Schedule view is a mix between the status chart, gantt chart, and a calendar view. It conveys equipment scheduling information in a concise and easily digestible format.

Interface Elements

Icon	Element	Description
	Current Time Indicator	Marker that indicates the current time, according to the session's timestamp. Style can be configured via currentTimeIndicator.
	State Bands	Bands indicating downtime and break events. Styles can be configured via downtimeEventStyle and breakEventStyle.
	Standard Card	A card on the equipment schedule corresponds to a scheduled event. During a Perspective Session, cards can be moved and resized by clicking and dragging.
	Overlapping Card	When more than one event is scheduled during the same time period for one item, an overlapping card will represent all events scheduled during that time period. Users can click the black drop down bar to select and edit individual events within the overlapping card.
	Zoom level	Sets the zoom level for the chart. Levels can be selected from the drop down menu or by clicking the magnifying glasses to zoom in or out. Valid values include month, day, 12-hr, 8-hr, 6-hr, 3-hr,15-minutes, hours, and minutes.
	Primary Header	Header that represents the full range of time displayed on the chart. Styles can be configured via headerStyles.primaryHeaderStyle.
	Secondary Header	Header that represents subsets of time displayed in the Primary Header. Styles can be configured via headerStyles.secondaryHeaderStyle.
	Tertiary Header	Header that represents subsets of time displayed in the Secondary Header. Styles can be configured via headerStyles.tertiaryHeaderStyle.
	Add New Event	Clicking within any empty square on the equipment schedule will allow the user to add a new event onto the chart. Note that Component Events must be configured and the addEnabled property must be true.

Properties

Name

Description

Data Type

addEnabled

If enabled, users can add events to an item's schedule. Note that Component Events must be configured to implement the desired functionality when the events are fired.

boolean

resizeEnabled

If enabled, users can resize events. Note that Component Events must be configured to implement the desired functionality when the events are fired.

boolean

moveEnabled

If enabled, users can move events. Note that Component Events must be configured to implement the desired functionality when the events are fired.

boolean

deleteEnabled

If enabled, users can delete events. Note that Component Events must be configured to implement the desired functionality when the events are fired.

boolean

items

The cells, or equipment items, with schedules displayed on the chart. Each row on the equipment schedule corresponds to one item.

Name

Description

Data Type

id

The ID for the item.

value: any

label

The label for the item displayed on the equipment schedule.

value: string

iconConfig

Name	Description	Data Type
path	Image path to the icon.	value: string
color	The color of the icon. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.	value: string
style	Sets a style for the icon. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .	object

object

headerStyle

Sets a style for the header. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .

object

rowStyle

Sets a style for the row. Will override default styles set by the component's rowStyle property. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .

object

array

dateRange

Name	Description	Data Type
startDate	The beginning of the time range to display.	value: DateTime
endDate	The end of the time range to display.	value: DateTime

object

defaultZoom

Default zoom level for the chart. Valid values include month, day, 12-hr, 8-hr, 6-hr, 3-hr, 15-minutes, hours, and minutes.

value: string

rowHeight

Sets the height for all rows on the equipment schedule.

value: numeric

scheduledEvents

The scheduled events for all configured items.

Name	Description	Data Type
itemId	The item identifier where this event is scheduled.	value: any
eventID	The event identifier of the scheduled event.	value: any
startDate	The start date of the scheduled event.	value: DateTime
endDate	The end date of the scheduled event.	value: DateTime
label	The label for the event displayed on the equipment schedule.	value: string
leadTime	The amount of lead time to display on the equipment schedule before the scheduled event's startDate.	value: numeric
leadStyle	Sets a style for the leadTime. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .	object
percentDone	If progressBar is enabled, this value will be displayed in the event's progress bar.	value: numeric
style	Sets a style for the event. Will override styles set by scheduledEventStyle. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .	object

array

downtimeEvents

Downtime events correlated to a specific item.

array

breakEvents

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

array

selectedEvent

Name	Description	Data Type
itemId	The ID of the selected item.	value: any
eventId	The ID of the selected event.	value: any

object

progressBar

Name

Description

Data Type

enabled

If enabled, scheduled events will display a progress bar.

boolean

bar

Name	Description	Data Type
color	The color of the progress bar. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.	value: string
style	Sets a style for the progress bar. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .	object

object

track

Name	Description	Data Type
color	The color of the progress bar track. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.	value: string
style	Sets a style for the progress bar track. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .	object

object

valueDisplay

Name	Description	Data Type
enabled	If enabled, the progress bar will display percentDone as a numeric value.	boolean
format	Sets a numeric format for the valueDisplay. Valid values include none, integer, percent, currency, and duration.	value: string
justify	Sets alignment for the valueDisplay on the progress bar. Valid values include left, center, and right.	value: string
style	Sets a style for the value display. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .	object

object

currentTimeIndicator

Name	Description	Data Type
color	The color of the current time indicator. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.	value: string
opacity	The opacity level for the current time indicator.	value: numeric
width	The width of the current time indicator.	value: numeric

object

headerStyles

Name	Description	Data Type
primaryHeaderStyle	Sets a style for the primary header. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .	object
secondaryHeaderStyle	Sets a style for the secondary header. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .	object
tertiaryHeaderStyle	Sets a style for the tertiary header. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .	object

object

rowStyle

Sets a style for all rows. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .

object

selectedEventStyle

Sets a style for the selected event. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .

object

scheduledEventStyle

Sets a style for scheduled events. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .

object

downtimeEventStyle

Sets a style for downtime events. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .

object

breakEventStyle

Sets a style for break events. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .

object

bodyStyle

Sets a style for the body. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .

object

style

Sets a style for the component. Full menu of style options is available for text, background, margin and padding, border, shape and miscellaneous. You can also specify a style class .

object

Component Events

Perspective_component_events

The Perspective Event Types Reference page describes all the possible component event types for Perspective components. Not all component events support each Perspective component. The Component Events and Actions page shows how to configure events and actions on a Perspective component. Component scripting is handled separately and can be accessed from the Component menubar or by right clicking on the component.

Expand

title	onAddEvent

Event is fired after a user adds an event to the schedule.

Note_friendly
This component event is designed to be used in tandem with a script runAction. Within the script action, special properties and methods are available on the event object, which is passed to the script action as a parameter.

Expand

title	event.end

Object Path

event.end

Type

Integer or float

Description

The end date of the new event.

Expand

title	event.itemId

Object Path

event.itemId

Type

String, integer, or float

Description

The item identifier where this event was created.

Expand

title	event.start

Object Path

event.start

Type

Integer or float

Description

The start date of the new event.

Code Block

title	Example

from random import random, randint
	
format = "yyyy-MM-dd HH:mm:ss z"
locale = "en-us"
scheduled = self.props.scheduledEvents
r = random() * 255
g = random() * 255
b = random() * 255
color = "rgb(" + str(r) + "," + str(g) + "," + str(b) + ")"
percentDone = randint(0, 100)
leadTime = randint(300, 6000)

item = {
	"endDate": system.date.parse(event.end, format, locale),
	"itemId": event.itemId,
	"startDate": system.date.parse(event.start, format, locale),
	"eventId": "event_" + str(randint(1000, 10000)),
	"backgroundColor": color,
	"percentDone": percentDone,
	"leadTime": leadTime
}
scheduled.append(item)

Expand

title	onMoveEvent

Event is fired after a user moves an event.

Note_friendly
This component event is designed to be used in tandem with a script runAction. Within the script action, special properties and methods are available on the event object, which is passed to the script action as a parameter.

Expand

title	event.end

Object Path

event.end

Type

Integer or float

Description

The new end date of the moved event.

Expand

title	event.eventId

Object Path

event.eventId

Type

String, integer, or float

Description

The event identifier of the moved event.

Expand

title	event.itemId

Object Path

event.itemId

Type

String, integer, or float

Description

The item identifier where this event was moved.

Expand

title	event.start

Object Path

event.start

Type

Integer or float

Description

The new start date of the moved event.

Code Block

title	Example

format = "yyyy-MM-dd HH:mm:ss z"
locale = "en-us"
scheduled = self.props.scheduledEvents
for count, toFind in enumerate(scheduled):
	if toFind.eventId == event.eventId and event.itemId == toFind.itemId:
		toFind.startDate = system.date.parse(event.start, format, locale)
		toFind.endDate = system.date.parse(event.end, format, locale)

Expand

title	onResizeEvent

Event is fired after a user resizes an event.

Note_friendly
This component event is designed to be used in tandem with a script runAction. Within the script action, special properties and methods are available on the event object, which is passed to the script action as a parameter.

Expand

title	event.end

Object Path

event.end

Type

Integer or float

Description

The new end date of the resized event.

Expand

title	event.eventId

Object Path

event.eventId

Type

String, integer, or float

Description

The event identifier of the resized event.

Expand

title	event.itemId

Object Path

event.itemId

Type

String, integer, or float

Description

The item identifier where this event was resized.

Expand

title	event.start

Object Path

event.start

Type

Integer or float

Description

The new start date of the resized event.

Code Block

title	Example

format = "yyyy-MM-dd HH:mm:ss z"
locale = "en-us"
scheduled = self.props.scheduledEvents
for count, toFind in enumerate(scheduled):
	if toFind.eventId == event.eventId and event.itemId == toFind.itemId:
		toFind.startDate = system.date.parse(event.start, format, locale)
		toFind.endDate = system.date.parse(event.end, format, locale)

Expand

title	onDeleteEvent

Event is fired after a user deletes an event.

Note_friendly
This component event is designed to be used in tandem with a script runAction. Within the script action, special properties and methods are available on the event object, which is passed to the script action as a parameter.

Expand

title	event.end

Object Path

event.end

Type

Integer or float

Description

The end date of the deleted event.

Expand

title	event.eventId

Object Path

event.eventId

Type

String, integer, or float

Description

The event identifier of the deleted event.

Expand

title	event.itemId

Object Path

event.itemId

Type

String, integer, or float

Description

The item identifier where this event was deleted.

Expand

title	event.start

Object Path

event.start

Type

Integer or float

Description

The start date of the deleted event.

Code Block

title	Example

scheduled = self.props.scheduledEvents
format = "yyyy-MM-dd HH:mm:ss z"
locale = "en-us"
for count, toFind in enumerate(scheduled):
	if toFind.eventId == event.eventId and toFind.itemId == event.itemId:
		del scheduled[count]
		break

New_in

Version	8.1.22

Expand

title	onClickEvent

Event is fired after a user clicks on an event.

Note_friendly
This component event is designed to be used in tandem with a script runAction. Within the script action, special properties and methods are available on the event object, which is passed to the script action as a parameter.

Expand

title	event.end

Object Path

event.end

Type

Integer or float

Description

The end date of the clicked event.

Expand

title	event.eventId

Object Path

event.eventId

Type

String, integer, or float

Description

The event identifier of the clicked event.

Expand

title	event.itemId

Object Path

event.itemId

Type

String, integer, or float

Description

The item identifier where this event was clicked.

Expand

title	event.start

Object Path

event.start

Type

Integer or float

Description

The start date of the clicked event.

Code Block

title	Example

scheduled = self.props.scheduledEvents
format = "yyyy-MM-dd HH:mm:ss z"
locale = "en-us"
for count, toFind in enumerate(scheduled):
	if toFind.eventId == event.eventId and toFind.itemId == event.itemId:
		print scheduled[count]
		break

OTHER USER MANUAL VERSIONS

GETTING STARTED

OTHER EDITIONS

LAUNCHERS

MODULES

PLATFORM

APPENDIX

TUTORIALS & HELPFUL TRICKS

PARTNER LINKS

RESOURCES

OTHER USER MANUALS

Offline Ignition Manual

Employees

Versions Compared

Old Version 14

New Version Current

Key

Interface Elements

Properties

Component Events