Skip to main content
Version: 8.1

Perspective - Equipment Schedule

Component Palette Icon:

Description‚Äč

New in 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‚Äč

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 levelSets 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-min, hours, and minutes.
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.
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.

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
itemsThe cells, or equipment items, with schedules displayed on the chart. Each row on the equipment schedule corresponds to one item.
  • id: The ID for the item.
  • label: The label for the item displayed on the equipment schedule. Value is a string.
  • iconConfig:
    • path: Image path to the icon. Value is 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 is a 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.
  • 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.
  • 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.
  • array
    dateRange
  • startDate: The beginning of the time range to display. Value is DateTime.
  • endDate: The end of the time range to display. Value is DateTime.
  • object
    defaultZoomDefault zoom level for the chart. Valid values include month, day, 12-hr, 8-hr, 6-hr, 3-hr, 15-min, hours, and minutes. Note: The 15-min option is only available in version 8.1.17 and later.value: string
    rowHeightSets the height for all rows on the equipment schedule.value: numeric
    scheduledEventsThe scheduled events for all configured items.
  • itemId: The item identifier where this event is scheduled.
  • eventID: The event identifier of the scheduled event. The eventID must be unique.
  • startDate: The start date of the scheduled event. Value is DateTime.
  • endDate: The end date of the scheduled event. Value is DateTime.
  • label: The label for the event displayed on the equipment schedule. Value is string.
  • leadTime: The amount of lead time to display on the equipment schedule before the scheduled event's startDate. Value is 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.
  • percentDone: If progressBar is enabled, this value will be displayed in the event's progress bar. Value is 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
    downtimeEventsDowntime events correlated to a specific item.array
    breakEventsScheduled breaks, which will appear as downtime for all items.array
    selectedEvent
  • itemId: The ID of the selected item.
  • eventId: The ID of the selected event.
  • object
    progressBar
  • enabled: If enabled, scheduled events will display a progress bar. Value is boolean.
  • bar:
    • 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 is 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.
  • track:
    • 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 is 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.
  • valueDisplay:
    • enabled: If enabled, the progress bar will display percentDone as a numeric value. Value is boolean.
    • format: Sets a numeric format for the valueDisplay. Valid values include none, integer, percent, currency, and duration. Value is string.
    • justify: Sets alignment for the valueDisplay on the progress bar. Valid values include left, center, and right. Value is 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
    currentTimeIndicator
  • 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 is string.
  • opacity: The opacity level for the current time indicator. Value is numeric.
  • width: The width of the current time indicator. Value is numeric.
  • object
    headerStyles
  • 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.
  • 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.
  • 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
    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

    Scripting‚Äč

    See the Perspective - Equipment Schedule Scripting page for the full list of scripting functions available for this component.