Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


GLOSSARY


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL MANUAL VERSIONS

Ignition 8
Ignition 7.9
Ignition 7.8

Deprecated Pages

Skip to end of metadata
Go to start of metadata
General


Component Palette Icon:


 

IULocgo


User, Schedule and Roster Management

Description
This component allows for management of schedules. Schedules can be defined by specifying which days of the week and which times of day they are active on. The times of day are defined using a string of time ranges, where the times are specified in 24-hr format with dashes between the beginning and the end. Multiple ranges can be specified by separating them with commas. Examples: 

 

8:00-17:00

Valid from 8am to 5pm

6:00-12:00, 12:45-14:00

Valid from 6am to noon, and then again from 12:45pm to 2pm

0:00-24:00

Always valid.


See Color Selector.Schedules that alternate weekly or daily can be specified by using the 
repetition settings. All repeating schedules need a starting day. For example, you could have a schedule that repeats on a weekly basis, with 1-week on and 1-week off. This schedule would be  active for seven days starting on the starting day, and then inactive for the next seven days, then active for seven days, and so on. Note that the days of the week and time settings are evaluated in addition to the repetition settings. This means that both settings must be true for the schedule to be active. Also note that if you set "Repeat / Alternate" to a setting other than "Off" and you do not specify a starting day, the schedule will never be active.
Properties
NameDescriptionProperty TypeScriptingCategory
Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

The border is unaffected by rotation.

Border.borderCommon
EnabledIf disabled, a component cannot be used.boolean.componentEnabledCommon
NameThe name of this component.String.nameCommon
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Schedule Available ColorChanges the color of the available times in the schedule. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSLvalue. See Color Selector.Color.schedulePreviewAvailableColorAppearance
Schedule Available Text ColorChanges the text color of events on the schedule preview. See Color Selector.Color.eventForegroundAppearance
StylesContains the component's styles.Dataset.stylesAppearance
Table ColorChanges the background color of the tables, User Roles and Role Member lists. See Color Selector. Note: When a row is selected it will revert to highlighted.Color.tableBackgroundAppearance
Table Header ColorChanges the background color of the table headers. See Color Selector.Color.tableHeaderBackgroundAppearance
Table Header Text ColorChanges the text color of the table headers. See Color Selector.Color.tableHeaderTextColorAppearance
Table Text ColorChanges the text color of the tables. Note: When a row is selected, it will revert to black. See Color Selector.Color.tableForegroundAppearance
Touchscreen ModeControls when this input component responds if touchscreen mode is enabled.int.touchscreenModeBehavior
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Window ColorChanges the window background color. See Color Selector.Color.windowBackgroundAppearance
Window Header ColorChanges the window header background color. See Color Selector.Color.windowHeaderBackgroundAppearance
Window Header Save Button Background ColorChanges the window header save button background color. See Color Selector.Color.windowHeaderSaveButtonBackgroundAppearance
Window Header Save Button Text ColorChanges the window header save button text color. See Color Selector.Color.windowHeaderSaveButtonForegroundAppearance
Window Header Text ColorChanges the window header text color. See Color Selector.Color.windowHeaderForegroundAppearance
Window Text ColorChanges the text color of the window. See Color Selector.Color.windowForegroundAppearance
Deprecated Properties
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated
Scripting
Scripting Functions

This component does not have scripting functions associated with it.

Extension Functions
 filterSchedule
  • Description

Called for each schedule loaded into the management table. Return false to hide this schedule from the management table. This code is executed in a background thread.

  • Parameters

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

String schedule - The schedule name

  • Return

Boolean

  • Scope

Client

 filterHoliday
  • Description

Called for each holiday loaded into the management table. Return false to hide this holiday from the management table. This code is executed in a background thread.

  • Parameters

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

String holiday - The holiday name.

  • Return

Boolean

  • Scope

Client

 onCreateSchedule
  • Description

Called when the add button is pressed when adding a schedule. This code is executed in a background thread.

  • Parameters

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

Object saveContext - An object that can be used to reject the add by calling saveContect.rejectSave('reason').

  • Return

Nothing

  • Scope

Client

 onDeleteSchedule
  • Description

Called when the delete button is pressed for one or more schedules. This code is executed in a background thread, once for each schedule to be deleted.

  • Parameters

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

Object saveContext - An object that can be used to reject the deletion by calling saveContect.rejectSave('reason').

String name - The name of the schedule to be deleted.

  • Return

Nothing

  • Scope

Client

 onSaveSchedule
  • Description

Called when the save button is pressed when adding or editing a schedule. This code is executed in a background thread.

  • Parameters

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

Object saveContext - An object that can be used to reject the edit by calling saveContect.rejectSave('reason').

String oldName - The schedule name before editing. Will be None for a schedule being added.

String newName - The new name of the edited schedule.

  • Return

Nothing

  • Scope

Client

 onCreateHoliday
  • Description

Called when the add button is pressed when to add a holiday. This code is executed in a background thread.

  • Parameters

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

Object saveContext - An object that can be used to reject the add by calling saveContect.rejectSave('reason').

  • Return

Nothing

  • Scope

Client

 onDeleteHoliday
  • Description

Called when the delete button is pressed for one or more holidays. This code is executed in a background thread, once for each holiday to be deleted.

  • Parameters

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

Object saveContext - An object that can be used to reject the edit by calling saveContect.rejectSave('reason').

String name - The name of the holiday to be deleted.

  • Return

Nothing

  • Scope

Client

 onSaveHoliday
  • Description

Called when the save button is pressed when adding or editing a holiday. This code is executed in a background thread.

  • Parameters

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

Object saveContext - An object that can be used to reject the edit be calling saveContext.rejectSave('reason')

String oldName - The holiday name before editing. Will be None for a holiday being added.

String newName - The new name of the edited holiday.

  • Return

Nothing

  • Scope

Client

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.

This event fires after the pressed and released events have fired.

.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 Control 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.

.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 Control 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.

.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 Control 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.

.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 Control 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.

.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 Control 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.

.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 Control 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.

.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 Control 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.

.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.
.propertyName

The name of the property that changed.

Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

Examples

Here is an example of the schedule management component and its property table.

Property NameValue
NameSchedules
EnabledTrue
VisibleTrue
Touchscreen ModeSingle-Click
Table Header Color71,71,255
Table Header Text Color255,255,255
Window Header Color71,71,255

 

  • No labels