API Reference
Namespaces
Classes
Events
Global
Externals

Namespace: cq-help

WebComponents. cq-help

Help web component <cq-help>.

cq-help web component will display help if available. Long-press time is set in stxx.longHoldTime

Example

<cq-help help-id="rectangle"></cq-help>

Methods


ensureMessagingAvailable(stx)

Ensures that an instance of the cq-floating-window web component is available to handle event messaging and create the shortcuts legend floating window.

This function is called when the add-on is instantiated.

Parameters:
Name Type Description
stx CIQ.ChartEngine

The chart engine that provides the UI context, which contains the cq-floating-window web component.

Since:
  • TBD 12464


press()

Since:
  • TBD 12464


verifyHelpContent()

Adds class help-available if a property matching this elements help-id attribute can be found in CIQ.Help.Content object. The help indicator (glowing dot) will not appear unless this class is present.

Since:
  • TBD 12464