API Reference
Namespaces
Classes
Events
Global
Externals

Class: cq-historical-comparison-dialog

WebComponents. cq-historical-comparison-dialog

new cq-historical-comparison-dialog()

The historical comparison dialog box web component, <cq-historical-comparison-dialog>, is used to add secondary curves to a cross section chart. The secondary curves plot the instruments of the main curve using data from past dates.

The dialog box enables users to select past dates; it includes the following elements:

  • Options group — Creates a group of radio buttons, each of which specifies a specific past date
  • Date picker — Enables selection of custom dates
  • Color swatch — Accesses a color picker used to select a color for the secondary curve

See the example below.

Since:

  • 7.5.0

Example

<cq-dialog>
     <cq-historical-comparison-dialog>
         <h4 class="title">Add Historical Comparison</h4>
         <cq-close></cq-close>
         <div class="ciq-dialog-color-option">
             <div class="ciq-heading">Color</div>
             <cq-swatch></cq-swatch>
         </div>
         <hr>
         <div class="ciq-options-group" style="margin-top:10px;">
             <cq-item stxtap="select()" class="ciq-active">1 Day Ago<span class="ciq-radio"><span></span></span></cq-item>
             <cq-item stxtap="select()">1 Week Ago<span class="ciq-radio"><span></span></span></cq-item>
             <cq-item stxtap="select()">1 Month Ago<span class="ciq-radio"><span></span></span></cq-item>
             <cq-item stxtap="select()">1 Year Ago<span class="ciq-radio"><span></span></span></cq-item>
             <cq-item stxtap="select()">3 Years Ago<span class="ciq-radio"><span></span></span></cq-item>
             <cq-item stxtap="select('custom')">Custom...</cq-item>
         </div>
         <cq-datepicker>
             <div class="datepicker comparison-datepicker"></div>
         </cq-datepicker>
         <div stxtap="done()" style="display:flex;justify-content:center;"><div class="ciq-btn">Done</div></div>
     </cq-historical-comparison-dialog>
</cq-dialog>

Extends

Members

datepicker :Element

Datepicker element

Type:
  • Element

firstOption :Element

First option in comparisons

Type:
  • Element

radioOptions :Element

Radio option group for comparisons

Type:
  • Element

swatch :Element

Color swatch element

Type:
  • Element

swatchColors :string|Array.<string>

CSS-friendly representation of swatch color(s)

Type:
  • string | Array.<string>

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:

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:

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:

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:
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:
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:

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:

close()

Closes the dialog.

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:

deactivateItem(item)

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

Parameters:
Name Type Description
item HTMLElement
Since:

  • 8.4.0

Inherited From:

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:

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:
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:
Returns:

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

Type
Array

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:

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:
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:
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:
Returns:

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

Type
HTMLElement | undefined

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:

naturalTabElements(element)

Returns all elements that are navigable by a browser's default tabbing algorithm

Parameters:
Name Type Description
element HTMLElement

Element to query selectors from.
Since:

  • 8.8.0

Inherited From:
Returns:

Array containing all tab navigable elements.

Type
Array.<HTMLElement>

open( [params])

Opens the parent dialog, the nearest cq-dialog element. Sets the chart context if a context is provided in params.

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.

Parameters:
Name Type Argument Description
params Object <optional>

Contains the chart context.

Properties
Name Type Argument Description
caller HTMLElement <optional>

The HTML element that triggered this dialog to open
context CIQ.UI.Context <optional>

A context to set. See setContext.
Inherited From:

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:
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:
Returns:

An array of selected DOM element.

Type
Array.<HTMLElement>

removeClaim()

Remove a claim on keystrokes.

Inherited From:

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:

setContext(context)

Dynamically sets the context for a dialog so that it knows which chart to change when there are multiple charts on the screen.

Parameters:
Name Type Description
context CIQ.UI.Context

The context to set.
Inherited From:

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:
Returns:

Trimmed innerHTML

Type
String

calcDate()

Calculates the date specified by a radio button. Typically called when the dialog box closes and a radio button has been selected.

Since:

  • 7.5.0

done()

Closes the dialog box and adds a curve to the chart for the selected date.

Since:

  • 7.5.0

open( [params])

Opens the dialog box.

Parameters:
Name Type Argument Description
params object <optional>

Optional parameters.

Properties
Name Type Argument Description
context CIQ.UI.Context <optional>

UI Context
caller HTMLElement <optional>

Element which opened the dialog
Since:

  • 7.5.0

select(node [, type])

Processes the cq-item options group member selected by the user. Sets the selected radio button as active or, if the custom date option has been selected, opens a date picker.

Parameters:
Name Type Argument Description
node Object

The selected cq-item options group member. Passed to the function by default.
type String <optional>

Indicates the type of option selected. If equal to "custom", indicates that the custom date option has been selected.
Since:

  • 7.5.0