User Manual

GETTING STARTED


OTHER EDITIONS


LAUNCHERS


MODULES


PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support

ALL USER MANUAL VERSIONS

Ignition 8.1. Offline Version (04/2021)
Ignition 8 Online Version
Ignition 7.9 Online Version
Ignition 7.8 Online Version

Deprecated Pages

SDK Documentation

Employees

Sign In

Skip to end of metadata
Go to start of metadata

Component Palette Icon:

On this page ...


The following feature is new in Ignition version 8.1.12
Click here to check out the other new features
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

IconElementDescription

Current Time IndicatorMarker that indicates the current time, according to the session's timestamp. Style can be configured via currentTimeIndicator.

State BandsBands indicating downtime and break events. Styles can be configured via downtimeEventStyle and breakEventStyle.

Standard CardA 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 CardWhen 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 HeaderHeader that represents the full range of time displayed on the chart. Styles can be configured via headerStyles.primaryHeaderStyle.

Secondary HeaderHeader that represents subsets of time displayed in the Primary Header. Styles can be configured via headerStyles.secondaryHeaderStyle.

Tertiary HeaderHeader that represents subsets of time displayed in the Secondary Header. Styles can be configured via headerStyles.tertiaryHeaderStyle.

Add New EventClicking 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

NameDescriptionData Type
addEnabledIf 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
resizeEnabledIf enabled, users can resize events. Note that Component Events must be configured to implement the desired functionality when the events are fired.boolean
moveEnabledIf enabled, users can move events. Note that Component Events must be configured to implement the desired functionality when the events are fired.boolean
deleteEnabledIf 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.

NameDescriptionData Type
idThe ID for the item.value: any
labelThe label for the item displayed on the equipment schedule.value: string
iconConfig
NameDescriptionData Type
pathImage path to the icon.value: string
colorThe 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
styleSets 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
headerStyleSets 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
rowStyleSets 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
NameDescriptionData Type
startDateThe beginning of the time range to display.value: DateTime
endDateThe 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
rowHeightSets the height for all rows on the equipment schedule.value: numeric
scheduledEvents

The scheduled events for all configured items.

NameDescriptionData Type
itemIdThe item identifier where this event is scheduled.value: any
eventIDThe event identifier of the scheduled event.value: any
startDateThe start date of the scheduled event.value: DateTime
endDateThe end date of the scheduled event.value: DateTime
labelThe label for the event displayed on the equipment schedule.value: string
leadTimeThe amount of lead time to display on the equipment schedule before the scheduled event's startDate.value: numeric
leadStyleSets 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
percentDoneIf progressBar is enabled, this value will be displayed in the event's progress bar.value: numeric
styleSets 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
downtimeEventsDowntime events correlated to a specific item.array
breakEventsScheduled breaks, which will appear as downtime for all items.array
selectedEvent
NameDescriptionData Type
itemIdThe ID of the selected item.value: any
eventIdThe ID of the selected event.value: any
object
progressBar
NameDescriptionData Type
enabledIf enabled, scheduled events will display a progress bar.boolean
bar
NameDescriptionData Type
colorThe 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
styleSets 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
NameDescriptionData Type
colorThe 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
styleSets 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
NameDescriptionData Type
enabledIf enabled, the progress bar will display percentDone as a numeric value.boolean
formatSets a numeric format for the valueDisplay. Valid values include none, integer, percent, currency, and duration.value: string
justifySets alignment for the valueDisplay on the progress bar. Valid values include left, center, and right.value: string
styleSets 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
object
currentTimeIndicator
NameDescriptionData Type
colorThe 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
opacityThe opacity level for the current time indicator.value: numeric
widthThe width of the current time indicator.value: numeric
object
headerStyles
NameDescriptionData Type
primaryHeaderStyleSets 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
secondaryHeaderStyleSets 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
tertiaryHeaderStyleSets 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
rowStyleSets 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
selectedEventStyleSets 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
scheduledEventStyleSets 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
downtimeEventStyleSets 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
breakEventStyleSets 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
bodyStyleSets 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
styleSets 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.

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

Note: 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.

  • Object Path

event.end

  • Type

Integer or float

  • Description

The end date of the new event.

  • Object Path

event.itemId

  • Type

String, integer, or float

  • Description

The item identifier where this event was created.

  • Object Path

event.start

  • Type

Integer or float

  • Description

The start date of the new event.

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)

Event is fired after a user moves an event.

Note: 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.

  • Object Path

event.end

  • Type

Integer or float

  • Description

The new end date of the moved event.

  • Object Path

event.eventId

  • Type

String, integer, or float

  • Description

The event identifier of the moved event.

  • Object Path

event.itemId

  • Type

String, integer, or float

  • Description

The item identifier where this event was moved.

  • Object Path

event.start

  • Type

Integer or float

  • Description

The new start date of the moved event.

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)

Event is fired after a user resizes an event.

Note: 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.

  • Object Path

event.end

  • Type

Integer or float

  • Description

The new end date of the resized event.

  • Object Path

event.eventId

  • Type

String, integer, or float

  • Description

The event identifier of the resized event.

  • Object Path

event.itemId

  • Type

String, integer, or float

  • Description

The item identifier where this event was resized.

  • Object Path

event.start

  • Type

Integer or float

  • Description

The new start date of the resized event.

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)

Event is fired after a user deletes an event.

Note: 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.

  • Object Path

event.end

  • Type

Integer or float

  • Description

The end date of the deleted event.

  • Object Path

event.eventId

  • Type

String, integer, or float

  • Description

The event identifier of the deleted event.

  • Object Path

event.itemId

  • Type

String, integer, or float

  • Description

The item identifier where this event was deleted.

  • Object Path

event.start

  • Type

Integer or float

  • Description

The start date of the deleted event.

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


  • No labels