core/common/interval-based-reload.abstract.ts
Abstract class representing an interval reload functionality. This class provides methods and properties for managing an interval-based reload mechanism.
Properties |
|
Methods |
|
Abstract countdownIntervalComponent |
Type : CountdownIntervalComponent
|
Protected Abstract hideCountdown |
Type : boolean
|
Controls the visibility of the countdown timer component in the current component's UI. |
isAutoRefreshEnabled |
Type : boolean
|
Indicates whether auto-refresh is enabled for the datapoints reload component that is set in widget config. |
Abstract isIntervalRefreshToggleOn |
Type : boolean
|
Indicates the current state of an interval refresh toggle button. |
Abstract isLoading |
Type : Signal<boolean>
|
Current isLoading state. Based on it next countdown cycle is being started. |
Abstract isScrolling |
Type : boolean
|
Indicates whether the alarm list is being scrolled or not. |
Protected Abstract manuallyDisabledCountdown |
Type : boolean
|
Indicates whether the countdown has been manually disabled by the user. |
Abstract onCountdownEnded |
Type : EventEmitter<void>
|
Indicates that a countdown cycle has ended. |
Abstract refreshInterval |
Type : number
|
Current refresh interval set in a widget config. |
Abstract toggleCountdownButtonTooltipText |
Type : string
|
autoRefreshList |
autoRefreshList()
|
Stops the countdown and triggers a refresh action.
This function is responsible for halting the countdown interval component's operation.
After stopping the countdown, it emits an
Returns :
void
|
Abstract countdownEnded |
countdownEnded()
|
Wrapper method where it's name better describes a context where it was called.
Returns :
void
|
disableCountdown |
disableCountdown()
|
Disables and hides the countdown timer. This method stops the ongoing countdown process by
stopping the
Returns :
void
|
Abstract enableCountdown |
enableCountdown()
|
Enables and starts the countdown timer. This method makes the countdown visible (
Returns :
void
|
handleScrolling |
handleScrolling()
|
Manages the countdown timer's visibility and state in response to user scrolling. This method toggles the countdown timer based on the user's scrolling behavior. It uses
the
Returns :
void
|
onToggleCountdownButtonState | ||||||||
onToggleCountdownButtonState($event: MouseEvent)
|
||||||||
Handles the toggle state of the countdown on button click. This method is triggered by a mouse event, typically a click on the countdown toggle button.
It toggles
Parameters :
Returns :
void
|
Abstract reload |
reload()
|
Returns :
void
|
startCountdown | ||||||||
startCountdown(injector: Injector)
|
||||||||
This function listens for changes in the IMPORTANT: If the widget's configuration (refreshInterval, check template) is not set prior to executing countdownIntervalComponent?.start, the countdown interval will not start! Example :
Parameters :
Returns :
void
|
Protected Abstract updateCountdownButtonTooltipText |
updateCountdownButtonTooltipText()
|
Updates the countdown button tooltip text based on the state of the interval refresh toggle state.
Returns :
void
|