API Reference
Namespaces
Classes
Events
Global
Externals

Class: ShowRange

WebComponents. ShowRange

This is a custom HtmlElement (Web Component). The tag name is the following:

<cq-show-range>

This component is a container of options which allow selection of a chart's date range. These ranges end at the present time, and begin at various other times which can be programmed in the component's configuration (see example below). To bind the component's configuration, set its config attribute to an object in the CIQ.UI.Context.config.groups object.

Attributes

This component observes the following attributes and will change behavior if these attributes are modified:

attribute description
config Key pointing to a component configuration entry which specifies the content items.

If no markup is specified in this component, a default markup will be provided. In order to use the default markup, the selections in the menu must be configured in the context configuration file and specified by key in the config attribute. See example.

Emitters

A custom event will be emitted by the component when that action is triggered on an item. See CIQ.UI.BaseComponent#emitCustomEvent for details on how to listen for this event. The details of the event contain the following:

property value
emitter this component
cause "useraction"
effect "select"
action "click"
multiplier multiplier
base base
periodicity { inteval: interval, period: period, timeUnit: timeUnit }

This component comes with a default markup which is used when the component tag contains no other markup when it is added to the DOM. The default markup provided has accessibility features.

Configuration

Configuration is accomplished by setting up an object within the context configuration's groups object. Each configuration is assigned a unique name which is itself an object property of the groups object. This property name is used as the value of the config attribute of this component. Let's call the object containing the configuration items. items will contain a property called content whose value is an array. Each array element is an object which represents one item in the group. Let's call one of these array elements, item. Each item has several properties which describe the nature of the range to display. The following table of properties describes what they mean.

property description
type Describes what type of item to display. Valid values are described in the table below.
label Text to display.
className Optional class name to apply to item.
tap Name of helper function to execute when item is clicked.
iconCls Optional class name of an icon to display on the item.
value Array of arguments to pass to tap function.
feature Name of add-on to which this option belongs. If the add-on is not loaded, the option will not appear.
helpId A key to the correct help text in CIQ.Help.Content.
id DOM id for the item.

Valid types are described here:

type description
item Standard text which when clicked will execute tap action via a helper.
heading Unclickable text displayed in <h4> tag. May be configured to allow filtering of another element's items.
separator Unclickable vertical line, used to separate two menu sections.

<protected> new ShowRange()

Since:
  • 9.1.0 Observes attributes. Added emitter.
Examples

Show Range tag:

<cq-show-range config="example"></cq-show-range>

Sample configuration for the above tag:

stxx.uiContext.config.groups.example = {
		content: [
			{ type: "item", label: "1D", tap: "set", value: [1, "today"] },
			{ type: "item", label: "1M", tap: "set", value: [1, month", 30, 8, "minute"] }
		]
};

Extends

Methods

addClaim()

Claim any keystrokes that come in. Once claimed, any keystrokes that come in are passed to the element. The element can then choose to capture or propagate the keystrokes. This enables an element to capture keystrokes even if it doesn't have mouse focus.

Inherited From:
Overrides:

addDefaultMarkup(component [, markup])

Adds default markup to a web component if the component does not have any child nodes.

Parameters:
Name Type Argument Description
component HTMLElement

The component to which the markup is added.
markup String <optional>

The markup to add to the web component. Unused if the component has a static markup property that specifies the markup; for example, MyComponent.markup.
Since:

  • 7.5.0

Inherited From:
Overrides:

channelMergeObject(path, value, stx)

Merges an object in the chart engine communication channel.

Parameters:
Name Type Description
path String

The channel path.
value Object

The value merged to the channel.
stx CIQ.ChartEngine

A reference to the chart engine.
Since:

  • 7.5.0

Inherited From:
Overrides:

channelRead(path [, stx])

Reads the current value in the chart engine communication channel.

Parameters:
Name Type Argument Description
path String

The channel path.
stx CIQ.ChartEngine <optional>

Unused.
Since:

  • 7.5.0

Inherited From:
Overrides:
Returns:

The current value in channel.

Type
*

channelSubscribe(path, cb, stx)

Subscribes to the chart engine messaging channel.

Parameters:
Name Type Description
path *

The channel path.
cb *

A callback invoked upon subscribing and whenever a new message is posted in the channel.
stx CIQ.ChartEngine

A reference to the chart engine.
Since:

  • 7.5.0

Inherited From:
Overrides:
Returns:

A callback invoked when unsubscribing from the channel.

Type
function

channelWrite(path, value, stx)

Writes in the chart engine communication channel.

Parameters:
Name Type Description
path String

The channel path.
value *

The value written to the channel.
stx CIQ.ChartEngine

A reference to the chart engine.
Since:

  • 7.5.0

Inherited From:
Overrides:

clickFocusedItem(items, e)

Selects (clicks) the first element in items that has a cq-focused attribute.

Parameters:
Name Type Description
items NodeList

A list of elements that are selectable via keyboard navigation.
e Event

The keystroke event.
Since:

  • 8.3.0

Inherited From:
Overrides:

connectedCallback()

Convenience function that creates an array of injections for the component and sets a variable of node equal to self.

Designed to be used as a helper method for the included WebComponents. A full tutorial on how to work with and customize the WebComponents can be found here: Web Component Interface.

Inherited From:
Overrides:

deactivateItem(item)

Blurs and removes the cq-keyboard-active attribute from item.

Parameters:
Name Type Description
item HTMLElement
Since:

  • 8.4.0

Inherited From:
Overrides:

disconnectedCallback()

Removes all the the injections for a context tag and resets the tag to its default state.

Designed to be used as a helper method for the included WebComponents. A full tutorial on how to work with and customize the WebComponents can be found here: Web Component Interface.

Inherited From:
Overrides:

emitCustomEvent(params)

Emits a custom event from the webcomponent. The event type of the emitted event is determined by the particular user action taken. Up to two events are emitted when this function is executed. The first is an event with the type of action performed, if there is one. For example, events which are spawned without user action will not emit this first event. The second event will have a type derived from the component name. For example, the cq-study-legend component will emit a "StudyLegend" type event. The payload of the event will contain a detail section specifying the component which emitted the event as well as the effect - which more clearly defines the type of action causing the emittance. The detail section may also include custom fields further categorizing the event and providing additional information. These details are documented within the web component's documentation.

Parameters:
Name Type Description
params object
Properties
Name Type Argument Default Description
cause string <optional>

The cause of the event. e.g., useraction, timeout, alert. Defaults to "useraction" if not set and action parameter is set.
effect string <optional>

The effect of the user's action. Required if not provided in detail. e.g., open, help, toggle, select.
action string | null <optional>
 "click"

The action a user performed, if applicable. e.g. click, longpress, drag. Set to null if no user action was performed.
detail Object <optional>
 {}

Optional extra parameters to include in the detail of the Custom Event.
Since:
  • 8.9.0
  • 9.1.0 Changed params object's property names.
Inherited From:
Overrides:

findFocused(items)

Finds the elements in items that have a cq-focused attribute.

Parameters:
Name Type Description
items NodeList

A list of elements that are selectable via keyboard navigation.
Since:

  • 8.3.0

Inherited From:
Overrides:
Returns:

The elements in items that have a cq-focused attribute, or an empty array if no elements are found.

Type
array

findKeyboardActive(items)

Finds the elements in items that have a cq-keyboard-active attribute.

Parameters:
Name Type Description
items NodeList

A list of elements that are selectable via keyboard navigation
Since:

  • 8.4.0

Inherited From:
Overrides:
Returns:

The elements in items that have a cq-keyboard-active attribute, or an empty array if no elements are found.

Type
Array

fireConfigChange()

Forces config attribute to change, even if the value of the config attribute didn't change. This is useful if the underlying object representing the configuration did change.

Since:

  • 9.8.0 added force parameter

focusItem(item)

Adds a cq-focused attribute to item and highlights item.

Parameters:
Name Type Description
item HTMLElement

Element that receives keyboard focus and is highlighted.
Since:

  • 8.3.0

Inherited From:
Overrides:

focusNextItem(items [, reverse] [, loop])

Focuses the next item in the tab order.

Locates the first element in items that has a cq-focused attribute. If an element is found, the attribute is removed from all elements in items, and cq-focused is applied to the element that follows (in the tab order) the element that was found.

If no elements are found with the cq-focused attribute, the attribute is applied to the first element in items (last element if reverse is true). If the last element in items (first element if reverse is true) is found to have the cq-focused attribute, focus remains on that element. Unless loop is set to true, then focus is applied to first element.

Parameters:
Name Type Argument Description
items NodeList

A list of elements that are selectable via keyboard navigation.
reverse boolean <optional>

If true, the operation is performed in reverse order; that is, from the last element in items to the first.
loop boolean <optional>

Loops back to the first item if the last element in items is selected.
Since:

  • 8.4.0 Added loop parameter. Return element, instead of true, if focus is changed.

Inherited From:
Overrides:
See:
Returns:

The newly focused element if a cq-focused attribute has changed.

Type
HTMLElement | undefined

getChartContainer( [el])

Searches the DOM for the chart container element. Begins the search with el (or this) and proceeds parent-by-parent up the ancestry tree until an element is found.

Parameters:
Name Type Argument Description
el HTMLElement <optional>

The element on which to start the search. If not provided, this is used.
Since:

  • 7.5.0

Inherited From:
Overrides:
Returns:

The chart container element or undefined if an element is not found.

Type
HTMLElement | undefined

getContextContainer( [el])

Searches the DOM for the chart context element. Begins the search with el (or this if el is not provided) and proceeds up the ancestry tree until an element is found or the root of the tree has been reached.

Parameters:
Name Type Argument Description
el HTMLElement <optional>

The element on which to start the search. If not provided, this is used.
Since:

  • 7.5.0

Inherited From:
Overrides:
Returns:

The chart context element or undefined if an element is not found.

Type
HTMLElement | undefined

handlePropertyChange(name, oldValue, newValue, force)

Processes attribute changes. This is called whenever an observed attribute has changed.

Parameters:
Name Type Description
name string

Attribute name
oldValue string

Original attribute value
newValue string

new Attribute value
force boolean

Set to true to force handling even if old value is the same as new value
Since:

  • 9.8.0 added force parameter

inputEntry(node, cb)

Attaches a keyboard input entry event.

Parameters:
Name Type Description
node HTMLElement

The element to which the input entry event is attached.
cb function

The callback function invoked when input entry occurs.
Inherited From:
Overrides:

populate()

Creates the group items by parsing the configuration object and using the default markup to create each item.

qs(path, context)

Adapts the querySelector method.

Parameters:
Name Type Description
path String

The CSS selectors for which to search.
context HTMLElement | String

The chart context element, which is the starting point of the DOM query, or "thisChart" to indicate the chart context in which this function is called.
Since:

  • 7.5.0

Inherited From:
Overrides:
Returns:

The selected DOM element or undefined if an element is not found.

Type
HTMLElement | undefined

qsa(path, root, bustShadowRoots)

Adapts the querySelectorAll method. Returns an array instead of a node list to enable chaining of the array map, filter, forEach, and reduce functions.

Parameters:
Name Type Description
path String

The CSS selectors to find.
root HTMLElement | String

The root element, which is the starting point of the DOM query, or "thisChart" to indicate the chart context in which this function is called.
bustShadowRoots boolean

Set to true to penetrate shadow root boundaries.
Since:
  • 7.5.0
  • 8.9.0 Added bustShadowRoots parameter
Inherited From:
Overrides:
Returns:

An array of selected DOM element.

Type
Array.<HTMLElement>

removeClaim()

Remove a claim on keystrokes.

Inherited From:
Overrides:

removeFocused(items)

Removes the cq-focused attribute from all elements in items.

Parameters:
Name Type Description
items NodeList

A list of elements that are selectable via keyboard navigation.
Since:

  • 8.3.0

Inherited From:
Overrides:

set(activator, multiplier, base [, interval] [, period] [, timeUnit])

Proxies UI requests for span changes to the chart engine.

Usage Examples:

  • set(5,'day',30,2,'minute') means that you want to combine two 30-minute bars into a single candle.
    • So your quote feed must return one data object for every 30 minutes. A total of 2 data points per hour.
  • set(5,'day',2,30,'minute') means that you want to combine thirty 2-minute bars into a single candle.
    • So your quote feed must return one data object for every 2 minutes. A total of 30 data points per hour.
  • set(5,'day', 1, 60,'minute') means that you want to combine sixty 1-minute bars into a single candle.
    • So your quote feed must return one data object for every minute . A total of 60 data points per hour.
  • set(5,'day', 60, 1,'minute') means that you want to have a single 60 minute bar per period.
    • So your quote feed must return one data object for every 60 minutes . A total of 1 data point per hour.
Parameters:
Name Type Argument Description
activator Object

Activation information
multiplier Number

The period that will be passed to CIQ.ChartEngine#setSpan
base Number

The interval that will be passed to CIQ.ChartEngine#setSpan
interval Number <optional>

Chart interval to use (leave empty for autodetect)
period Number <optional>

Chart period to use (leave empty for autodetect)
timeUnit Number <optional>

Chart timeUnit to use (leave empty for autodetect)
Since:

  • 5.1.1 timeUnit added

setContext(context)

Called for a registered component when the context is constructed. Sets the context property of the component.

Parameters:
Name Type Description
context CIQ.UI.Context

The chart user interface context.
Overrides:

setContextHolder()

Stores the component in the context holder (an array associated with the cq-context element) so that when the context is started, it knows that this tag is contextual.

Designed to be used as a helper method for the included WebComponents. A full tutorial on how to work with and customize the WebComponents can be found here: Web Component Interface.

Inherited From:
Overrides:

trimInnerHTMLWhitespace()

Returns a copy of the innerHTML of an element, with leading and trailing characters stripped. The following characters are stripped: newline, carriage return, tab.

Since:

  • 9.1.0

Inherited From:
Overrides:
Returns:

Trimmed innerHTML

Type
String

<static> itemTemplate(params)

Default markup generator for an item's innerHTML. This function is called for each item in the dropdown. Based on the parameters passed in, the appropriate markup is generated. This function is called by WebComponents.ShowRange#populate.

Parameters:
Name Type Description
params Object
Properties
Name Type Argument Description
type String

Type of item, e.g. item, heading, separator.
className String <optional>

Class name of item
feature String <optional>

Name of add-on which when loaded, this item will become visible
helpId String <optional>

Name associated with help for this item
iconCls String <optional>

Class for the icon in the item
label String <optional>

Text for the item
tap String <optional>

Helper function for tapping
value Array | String <optional>

Parameter(s) to pass to the tap, function. If these aren't supplied, value will be stored in a data attribute. The value is always available in the data-value attribute.
id String <optional>

DOM id atribute for the item.
Returns:

Markup for a single item.

Type
String