API Reference
Namespaces
Classes
Events
Global
Externals

Namespace: cq-signaliq-dialog

WebComponents. cq-signaliq-dialog

SignalIQ Dialog web component <cq-signaliq-dialog>.

Displays a dialog so signal studies can be entered into the system through the UI.

Requires SignalIQ plugin.

Since:
  • 8.6.0

Example

<h4 class="title">New Signal</h4>
<cq-close></cq-close>
<div cq-study-edit-dialog-div>
	<form id="study-signal" class="study-signal">
		<h2 cq-add-only>Choose a Study:</h2>
		<div class="study-select-container"></div>
		<div cq-tooltip-activator class="ciq-edit-study" stxtap="editStudy()">
			&nbsp;
			<cq-tooltip>Edit Study</cq-tooltip>
		</div>
		<h2>Define Conditions:</h2>
		<div class="cq-study-signal-conditions"></div>
		<hr/>
		<div class="notification-type-container"></div>
		<div class="ciq-marker-container">
			<h2>Choose an appearance:</h2>
			<div class="ciq-marker-settings">
				<div class="ciq-marker-preview">
					<div class="stx-marker signal">
						<div class="stx-visual"></div>
						<div class="stx-marker-content"></div>
					</div>
				</div>
				<div class="ciq-signal-options"></div>
			</div>
		</div>
		<h2>Description</h2>
		<textarea name="signal-description" type="text" placeholder="Description will appear in an infobox when the signal is clicked."></textarea>
		<hr/>
		<div class="clearfix"></div>
		<div class="ciq-misc-settings">
			<input name="signal-name" type="text" value="" spellcheck="false" autocomplete="off" autocorrect="off" autocapitalize="none" placeholder="Enter a Name" />
			<div class="ciq-btn ciq-btn-save" stxtap="save()">Save</div>
			<h2 class="info-message"><h2>
		</div>
	</form>
	<template cq-study-menu>
		<cq-menu class="ciq-select">
			<cq-selected></cq-selected>
			<cq-menu-dropdown cq-lift>
				<cq-study-filter cq-filter-min="15"></cq-study-filter>
				<cq-study-items></cq-study-items>
			</cq-menu-dropdown>
		</cq-menu>
	</template>
	<template cq-menu>
		<cq-menu class="ciq-select">
			<cq-selected></cq-selected>
			<cq-menu-dropdown cq-lift></cq-menu-dropdown>
		</cq-menu>
	</template>
</div>

Methods


addStudy(obj, name)

Callback function for the study select menu. Adds the selected study to the chart.

Parameters:
Name Type Description
obj object | null

Object containing event or null

name string

Name of the study to add.

Since:
  • 8.6.0


collapse(node)

Closes any lifts or popups for the node.

Parameters:
Name Type Description
node HTMLElement

Element to collapse.

Since:
  • 8.6.0


editStudy(activator)

Invoke the Study Edit dialog for the currently active study

Parameters:
Name Type Description
activator Object
Since:
  • 8.6.0


hide()

Hides the dialog and resets local signal properties if not in the middle of an interactive add operation.

Since:
  • 8.6.0


init(params)

Adds local property containing dropdown menu options. Adds form element event handlers.

Parameters:
Name Type Description
params object

The parameter object.

Since:
  • 8.6.0


makeMenu(name, currentValue, fields, cb, index, label)

Create a cq-menu form element and return it. The created element is not attached to the DOM.

Parameters:
Name Type Description
name string

Name of the form element.

currentValue string

Value to select by default.

fields Array

A one-dimensional array of values or a two-dimensional array of name/value pairs.

cb string

Stringified callback function template, with $val to be replaced, and called when a value is selected.

index number

Numerical index of menu element. Used to differentiate multiple condition selections.

label string

Alternative label for menu when value is not selected. Default is "Select..."

Since:
  • 8.6.0 8.7.0 Add index and label parameters.

Returns:

cq-menu element

Type
HTMLElement

makeStudyMenu()

Create a cq-menu form element with all available studies and inject a search field in the menu header to filter options. The menu is automatically attached to a local element with class study-select-container.

Since:
  • 8.6.0


open(params)

Called when the dialog is invoked. Automatically sets up local properties for either adding or editing a study signal.

Parameters:
Name Type Description
params object

The parameter object.

Properties
Name Type Description
sd CIQ.Studies.StudyDescriptor

The study descriptor.

Since:
  • 8.6.0


removeActiveStudy()

Remove the active study from the chart.

Since:
  • 8.6.0


renderConditionOptions()

Update form controls related to marker condition options based on values in signalParams.conditions array.

Since:
  • 8.6.0


renderMarkerPreview()

Update marker preview based on values in signalParams.

Since:
  • 8.6.0


renderSignalOptions()

Update form controls related to marker options based on values in signalParams.

Since:
  • 8.7.0 Rename from renderMarkerOptions to renderSignalOptions to include other notification types.


reset()

Resets local study signal properties.

Since:
  • 8.6.0


save()

Apply the current study signal settings to the active study and close the dialog.

Since:
  • 8.6.0


translate()

Translates a dialog.

Since:
  • 8.6.0


updateConditionSignalVal(obj, conditionIdx, paramName, value)

Update a marker option value in signalParams.conditions at provided index.

Parameters:
Name Type Description
obj object | null

Object containing event or null.

conditionIdx number

Index of the condition.

paramName string

Name of the marker property.

value string | number

Value for the condition property.

Since:
  • 8.7.0


updateConditionVal(obj, conditionIdx, paramIdx, value)

Update a value in signalParams.conditions at provided index.

Parameters:
Name Type Description
obj object | null

Object containing event or null.

conditionIdx number

Index of the condition.

paramIdx number

Index of the property within the condition.

value string | number

Value for the condition property.

Since:
  • 8.6.0


updateFormValues(formToData)

Synchronizes dialog HTML elements in the local formElements property with values in the signalParams object. By default, this will update the element value with its corresponding signalParams value. Passing formToData parameter as true will update the corresponding signalParams value with the element value.

Parameters:
Name Type Description
formToData boolean

Update signalParams with form values.

Since:
  • 8.6.0


updateParamValue(obj, name, value)

Update the value of a signalParams property.

Parameters:
Name Type Description
obj object | null

Object containing event or null

name string

Name of the property.

value string | number

Value for the property.

Since:
  • 8.6.0


validateCondition(index)

Checks local signalParams.conditions array for all properties required by CIQ.SignalIQ#convertStudyToSignal.

Parameters:
Name Type Description
index number

Array index to check.

Since:
  • 8.6.0

Returns:

Return true if valid.

Type
boolean

validateSignalParams()

Checks local signalParams object for all properties required by CIQ.SignalIQ#convertStudyToSignal. Displays appropriate feedback messaging at bottom of dialog.

Since:
  • 8.6.0