HHMM Range Inject

Description

This inject control is commonly used to pass a value in document structure to other Ambience components as a child element of $elx-etl-inject. This has two input fields that allows time range selection, which includes both start and end times. A time picker is provided for each field of the control. There is also an option to enable and disable the start (“From”) and end (“To”) time selectors. This is suitable passing string values that follow the 24-hour hh:mm format (e.g. 18:00). The time picker displayed on the Viewer is using a 12-hour hh:mm time format.

Selected values are passed in this format:


{ <Inject Field> : { from : "<hh:mm of selected "From" time>", to : "<hh:mm of selected "To" time>" } }

Sample:

{
times : 
    {
        from : "06:00", 
        to : "18:00"
    }
}

If the “From”, “To” or both are disabled or has empty values (i.e. –:– –), the fields are excluded.

Sample:

{
times : 
    {
        to : "18:00"
    }
}

Sample:

{
times : 
    {
    }
}

Viewer Usage

There are two input fields available. The “From” time picker allows selection of the lower boundary or start time while the “To” time picker allows selection of the upper boundary or end time. The values are inclusive.

To use the time picker, key in hours, minutes and period (i.e. AM, PM) to display the desired time value.

Field/Icon Description
Hours Field for hours in 12-hour format. Only whole numbers from 01 to 12 are allowed.
Minutes Field for minutes. Only whole numbers from 00 to 59 are allowed.
Period Field for period. Only “AM” and “PM” are allowed.
Clear Icon Clears the entered value.

The range of both time pickers are independent of the other. Note that hour, minute and period fields on a time picker must be populated to make the value valid.

By default, the both fields are disabled. The time pickers can be used even when their corresponding checkboxes are unselected.

Either or both of the fields can be enabled. To enable a field, select the checkbox corresponding it. To disable a field, deselect the checkbox corresponding it.

Specific Properties

Below are the fields that are specific to this control:

Field Description Mandatory Input Type Constraints Default Value
Initial Values Determines the initial set or selected values upon loading in the Dashboard Viewer. Y Time range (“From” and “To”) The actual values set would be displayed on the Viewer. Hour, minute and period must be populated to make the entire value valid. “–:– –” for both “From” and “To”