Class: DialogContentTag

Extends

• CIQ.UI.BaseComponent

Methods

---

addClaim(helper)

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

Parameters:

Name	Type	Description
helper	HTMLElement	The element that should claim a keystroke.

Inherited From:

• CIQ.UI.BaseComponent#addClaim

---

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:

• CIQ.UI.BaseComponent#addDefaultMarkup

---

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:

• CIQ.UI.BaseComponent#channelMergeObject

---

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:

• CIQ.UI.BaseComponent#channelRead

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:

• CIQ.UI.BaseComponent#channelSubscribe

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:

• CIQ.UI.BaseComponent#channelWrite

---

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:

• CIQ.UI.BaseComponent#clickFocusedItem

---

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.

---

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:

• CIQ.UI.BaseComponent#findFocused

Returns:

The elements in items that have a cq-focused 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:

• CIQ.UI.BaseComponent#focusItem

---

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:

• CIQ.UI.BaseComponent#focusNextItem

See:

• focusItem

Returns:

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

Type

HTMLElement | boolean

---

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:

• CIQ.UI.BaseComponent#getChartContainer

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:

• CIQ.UI.BaseComponent#getContextContainer

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:

• CIQ.UI.BaseComponent#inputEntry

---

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 context CIQ.UI.Context <optional> A context to set. See setContext.

---

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:

• CIQ.UI.BaseComponent#qs

Returns:

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

Type

HTMLElement | undefined

---

qsa(path, context)

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 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 whidh this function is called.

Since:

• 7.5.0

Inherited From:

• CIQ.UI.BaseComponent#qsa

Returns:

An array of selected DOM element or undefined if no elements are found.

Type

HTMLElement | undefined

---

removeClaim(helper)

Remove a claim on keystrokes.

Parameters:

Name	Type	Description
helper	CIQ.UI.Helper	Helper or ContextTag from which the claim on keystrokes is removed.

Inherited From:

• CIQ.UI.BaseComponent#removeClaim

---

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:

• CIQ.UI.BaseComponent#removeFocused

---

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.