Optional
displayProtected
lowerProtected
maxProtected
maxProtected
minProtected
minProtected
resolutionProtected
timeOptional
timeoutProtected
upperDeserialize an element and set the current element state to the deserialized one
The element serialization as returned by the serialize method
When the component is disconnected from the DOM all the callbacks will be unregistered
Protected
dispatchDispatches a custom event to notify the parent about the changed time.
Set the time restriction to undefined.
Protected
getOptional
limit: TimeRangeLimitGet the current time restriction as a formatted query string.
The formatted time restriction as string or undefined if the time restriction is empty.
Retrieves the value associated with the input element of the specified limit.
Optional
limit: TimeRangeLimitOptional parameter specifying the input Element ('upper' or 'lower') for which value is to be fetched.
The raw value retrieved from the input element.
Hide the component (display: none).
Convert the string in parameter with uHtml and return it. This allows to convert a string with html in a right html object. For example, htmlUnsafe('
') will return an html div object.Initializes the widget and sets properties of the input elements. Must be called before using the widget.
Configuration options for the time widget.
NOTE REG: We cannot just use truthy here, because javascript comparaison table is really problematic. For example: 0 == false [] == false "" == false And there are cases where we want to check null or undefined, because 0 can be a right value. More here : https://dorey.github.io/JavaScript-Equality-Table/
Re-Render the component. The method should be called when the component has already been rendered and needs to be updated.
Render the component's template.
Renders a hidden span with the name of the component. Useful to render a placeholder for not visible component.
Resets the input elements to their default states. This either will be empty strings
or the optionally defined minDefaultValue
and maxDefaultValue
.
The method will trigger a TimeChangeEvent
that bubbles up to the parent component.
Returns the serialization of the current element. This method should be overwritten by child classes
An object describing the current element serialized
Sets the value of the specified input element.
The date string to be set as the value.
Optional
limit: TimeRangeLimit = 'lower'The time range limit for which the value is to be set ('lower' or 'upper').
Show the component (display: block).
In the templates, sometimes for accessibility reasons, we have to support the KeyDown Event In those case, we often juste want to do the same as the click event when Enter or Space is pressed Then this method can be used : it just calls the click event on the same element
Optional
eventNames: GgUserInteractionEvent | GgUserInteractionEvent[]
A component consisting of two
<input>
elements of type date picker for temporal layer filtering. It supports specifying single-dates or date ranges. The widget validates input dates based on the specifiedtimeOptions
. Inrange
mode, it validates lower and upper range limits so that they do not cross each other.