Skip to end of metadata
Go to start of metadata

 

Description

 A component that displays scheduled entries for a selected month. This extends from the Month View Component that comes with Ignition to support adding, editing and deleting schedule entries. All schedule entries are automatically displayed from the "Schedule" and other database tables without the need for custom SQL statements or script.

Properties
NameScriptingCategoryProperty TypeDescription
Current DatecurrentDateDataDateTimeThe date to show the production schedule of.
Line PathlinePathDataStringThe path to the production line to show the schedule for.
YearyearDataintSet the calendar's year.
MonthmonthDataintSet the calendar's month.
DaydayDataintSet the calendar's day.
Calendar eventseventsDataDataSetContains the calendar events.
Selected DayselectedDayDataStringThe calendar's selected day.
Hovered DayhoveredDayDataStringThe calendar's hovered day.
Hovered TimehoveredTimeDataStringThe calendar's hovered time.
Selected EventselectedEventDataintThe calendar's selected event.
Hovered EventhoveredEventDataintThe calendar's hovered event.
Schedule IDscheduleIDDataintThe database ID for this scheduled event.
Week Day Foreground ColorweekDaysForegroundAppearanceColorThe color of the week day's text.
Week Day Background ColorweekDaysBackgroundAppearanceColorThe color of the week day's background.
Calendar Background ColorcalendarBackgroundAppearanceColorThe color of the calendar's background.
Day Outline ColorboxOutlineAppearanceColorThe color of the day's outline.
Today's Background ColortodayBackgroundAppearanceColorThe color of the today's background.
Selected Background ColorselectedBackgroundAppearanceColorThe color of the selected day's background.
Hover Background ColorhoverBackgroundAppearanceColorThe background color of the hovered day and time.
StylesstylesAppearanceDatasetContains the component's styles.
Event Display FormateventDisplayFormatAppearanceStringFormat string. {wo} is Work Order, {co} is Change Over Start, {st} is Production Start, {fn} is Finish, {pc} is Product Code, {pcd} is Product Code description, {qty} is Quantity, {nt} is Note, {eb} is Entered By, | is line feed.
Scripting
Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions

This component does not have extension functions associated with it. 

Event Handlers
 mouse
 mouseClicked

This event signifies a mouse click on the source component. A mouse click the combination of a mouse press and a mouse release, both of which must have occurred over the source component. Note that this event fires after the pressed and released events have fired.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseEntered

This event fires when the mouse enters the space over the source component.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseExited

This event fires when the mouse leaves the space over the source component.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mousePressed

This event fires when a mouse button is pressed down on the source component.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseReleased

This event fires when a mouse button is released, if that mouse button's press happened over this component.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMotion
 mouseDragged

Fires when the mouse moves over a component after a button has been pushed.

 

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 mouseMoved

Fires when the mouse moves over a component, but no buttons are pushed.

PropertyDescription
sourceThe component that fired this event.
buttonThe code for the button that caused this event to fire.
clickCountThe number of mouse clicks associated with this event.
xThe x-coordinate (with respect to the source component) of this mouse event.
yThe y-coordinate (with respect to the source component) of this mouse event.
popupTriggerReturns True (1) if this mouse event is a popup trigger. What constitutes a popup trigger is operating system dependent, which is why this abstraction exists.
altDownTrue (1) if the Alt key was held down during this event, false (0) otherwise.
controlDownTrue (1) if the Ctrl key was held down during this event, false (0) otherwise.
shiftDownTrue (1) if the Shift key was held down during this event, false (0) otherwise.
 propertyChange
 propertyChange

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.
 schedule
 newEvent

Is fired when the New Entry menu item is selected.

PropertyDescription
sourceThe component that fired this event.
scheduleEventIDThe identifier of the event scheduled.
 editEvent

Is fired when the Edit Entry menu item is selected.

PropertyDescription
sourceThe component that fired this event.
scheduleEventIDThe identifier of the event scheduled.
 deleteEvent

Is fired when the Delete Entry menu item is selected.

PropertyDescription
sourceThe component that fired this event.
scheduleEventIDThe identifier of the event scheduled.
Customizers

This component does not have a customizer however this component relies on custom styles. The example below has the styles defined here:

 

Examples

When the user right clicks on a time, a popup menu will appear with options to add, edit or delete a schedule entry.

Component Schedule Month View

Schedule Month View

  • No labels