(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

Clock

The Dynamic Clock Component is a countdown timer that provides visual feedback as time progresses. It allows users to start, stop, and monitor countdown periods with visual warnings when approaching time limits. This component is ideal for time-sensitive operations, timing processes, or activity monitoring.

Properties

Visual Properties

• displayName - Sets the display name of the component shown in the structure panel. For example, "Operation Timer" allows for easy identification of the clock's purpose in the component structure.

• countDownBarInSeconds - Sets the total duration of the countdown timer in seconds. For example, setting this to "300" creates a five-minute countdown timer that provides visual progress indication as time elapses.

• warningRangeInPercent - Determines at what percentage of elapsed time the timer should display a visual warning. For example, setting this to "80" will cause the timer to display a warning when 80% of the countdown time has elapsed, helping users prepare for the end of the time period.

Event Actions Properties

• events - Configures the events that the component can trigger and respond to:
  • ON_CLOCK_COUNTDOWN_START: Triggered when the countdown timer is started. Can be used to synchronize other components or log the start of a timed process.
  • ON_CLOCK_COUNTDOWN_STOP: Triggered when the countdown is manually stopped. Useful for capturing interrupted processes or user interventions.
  • ON_CLOCK_COUNTDOWN_WARNING_REACHED: Triggered when the timer reaches the warning threshold defined by warningRangeInPercent. Can be used to display alerts or trigger preparatory actions.
  • ON_CLOCK_COUNTDOWN_EXCEEDED: Triggered when the countdown timer reaches zero. Can be used to execute follow-up actions or notify users that time has expired.
  • ON_GLOBAL_PARAMETERS_CHANGE: Triggered when global parameters affecting the component change. Allows the component to respond to system-wide settings changes.
  • ON_INIT: Triggered when the component is initialized. Can be used to perform setup operations.
  • ON_DESTROY: Triggered when the component is removed from the DOM. Useful for cleanup operations.

Testing Hooks Properties

• enableAsHotspot - Enables the clock component as a guided tour hotspot. When enabled, the clock can be highlighted during guided tours to draw user attention to important timing features.

• guidedTourHotSpotTitle - Sets the title for the guided tour hotspot with support for multiple languages. For example, {"en-US": "Monitor Operation Time", "de-DE": "Betriebszeit überwachen"} provides localized titles when the clock is highlighted during a guided tour.

• guidedTourHotSpotDescription - Sets the description text for the guided tour hotspot with language support. For example, {"en-US": "Click the play button to start timing your operation. The timer will warn you when time is running out.", "de-DE": "Klicken Sie auf die Wiedergabetaste, um die Zeitmessung Ihres Vorgangs zu starten. Der Timer warnt Sie, wenn die Zeit knapp wird."} provides detailed instructions during guided tours.