Skip to end of metadata
Go to start of metadata

Description

A component that displays the line and cell downtime events of a run in a visual time chart.


If the Run Look Back Count property is set to anything other than "0", the Start Date and End Date properties will be ignored and just the number of runs specified will be displayed.


Component Palette



Component Properties

Properties are provided that can be set to affect the operation and look of the component. They can be set through the Property Editor in the Designer or through scripting.

Example
event.source.parent.getComponent('OEE Time Chart').showIgnitionSchedule = True

N/A

NameScriptingProperty TypeDescription
Line PathlinePathStringProduction line path to show schedules.
Start DatestartDateDateStart date to get schedules for the production line.
End DateendDateDateEnd date to get schedules for the production line.
Update IntervalupdateIntervalintInterval in seconds to update the time chart.
Run Look Back CountrunLookBackCountint
Number of runs to show schedules, equipment modes and equipment states. 

Set to 0 to see all runs within the date range. Set to 1 to see only the current run. Greater numbers are additive: 2 will show you events from the last 2 runs, 3 from the last 3 runs, etcetera.

If set to 1 or greater, the date range will not be used.

Show Date Range HeadershowDateRangeHeaderbooleanIf true, show the date range header.
Show Ignition ScheduleshowIgnitionSchedulebooleanIf true, show Ignition schedules.
Show Production ScheduleshowProductionSchedulebooleanIf true, show production schedules.
Show Equipment ModeshowEquipmentModebooleanIf true, show equipment modes.
Show Equipment StateshowEquipmentStatebooleanIf true, show equipment states.
Unknown State as Unplanned DowntimeunknownStateAsUnplannedDowntimebooleanTreat unknown states as unplanned downtime states.
NameScriptingProperty TypeDescription
Ignition Schedule ColorignitionScheduleColorColorForeground color of the ignition schedule.
Production Schedule ColorproductionScheduleColorColorForeground color of the production schedule.
Row HeightrowHeightintRow height of the time chart.


Event Handlers

Event handlers provide the ability to add custom script when a user interacts with a component.

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

PropertyDescription
.sourceThe component that fired this event.
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyNameThe 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.




Extension Functions

  • Description

Called to get a custom field.

  • Parameters

self - A reference to the component that is invoking this function. 

equipmentPath - The equipment path as a string.

customField - The custom field object to set property values and return. 

  • Return

The custom field object.

  • Scope

Client

Example
from java.awt import Color
	

	if equipmentPath == '[global]\\My Enterprise\\My Site\\My Area\\My Line':
		customField.setMessage(prodCode)
		customField.setForeground(Color.RED)
		customField.setBackground(Color.YELLOW)
		customField.setIconPath('Sepasoft/Icons/product code icon 16.png')
	return customField
	else:
		return None
  • Description

Provides a chance to change an icon. Based on the icon name parameter, return the image path to the icon to use in place of the default icon.

  • Parameters

self - A reference to the component that is invoking this function.

iconName - The name of the icon.

  • Returns

Nothing

  • Scope

Client

Example
# This example will return a path to a different image to replace the default delete image:
if iconName == 'remove':
	return 'Builtin/icons/24/delete2.png'
  • Description

Called to get colors for equipment modes.

  • Parameters

self - A reference to the component that is invoking this function.

modeColor - The mode color object to set property values and return.

  • Returns

Nothing

  • Scope

Client

Example
# This example will return colors for equipment modes:
from java.awt import Color
	modeColor.setUnknownColor(Color.WHITE)
	modeColor.setProductionColor(Color.GREEN)
	modeColor.setIdleColor(Color.LIGHT_GRAY)
	modeColor.setChangeoverColor(Color.YELLOW)
	modeColor.setMaintenanceColor(Color.MAGENTA)
	modeColor.setOtherColor(Color.PINK)
	modeColor.setDisabledColor(Color.DARK_GRAY)
	return modeColor
  • Description

Called to get colors for equipment states.

  • Parameters

self - A reference to the component that is invoking this function.

stateColor - The state color object to set property values and return.

  • Returns

Nothing

  • Scope

Client

Example
# This example will return colors for equipment states:
from java.awt import Color
	stateColor.setUnknownColor(Color.WHITE)
	stateColor.setUnplannedDowntimeColor(Color.RED)
	stateColor.setPlannedDowntimeColor(Color.BLUE)
	stateColor.setBlockedColor(Color.ORANGE)
	stateColor.setStarvedColor(Color.CYAN)
	stateColor.setRunningColor(Color.GREEN)
	stateColor.setIdleColor(Color.LIGHT_GRAY)
	stateColor.setDisabledColor(Color.DARK_GRAY)
	stateColor.setChangeoverColor(Color.YELLOW)
	stateColor.setMaintenanceColor(Color.MAGENTA)
	return stateColor
  • Description

Called to get tool tip text for a mode. The default tool tip text is provided, but can be changed by returning new text to show. The tool tip should be a html formatted string.

  • Parameters

self - A reference to the component that is invoking this function.

itemType - The type of object passed in the item parameter. "Mode" for EquipmentModeItem or "State" for EquipmentStateItem.

item - The EquipmentMode or EquipmentState object associated with entry on the timing chart.

causeEquipment - The name that caused the downtime event. Only valid if itemType equals State.

beginDateTime - The beginning date and time of the event.

endDateTime - The ending date and time of the event.

duration - The duration of the event.

toolTipText - The default tool tip text.

  • Return

Nothing

  • Scope

Client




Custom Methods

Custom methods allow you to add your own component functions to a component that can be called through scripting. This is a useful and clean method of re-using script that is specific to the component (say you want to update a visual aspect of the component in the same way whether a user clicks on the component or a window property value changes). See Component Custom Methods in the Ignition Help Manual for more information.




Customizers

This component does not have any custom properties.



Component Functions

This component does not have functions associated with it.

  • No labels