API Reference
Namespaces
Classes
Events
Global
Externals

Class: Driver

CIQ.ChartEngine. Driver

new Driver(stx, quoteFeed [, behavior] [, filter])

Drives the chart's relationship with the quote feed object provided to the chart.

Parameters:
Name Type Argument Description
stx CIQ.ChartEngine

A chart engine instance.
quoteFeed object

A quote feed object.
behavior object <optional>

See CIQ.ChartEngine#attachQuoteFeed for object details.
filter function <optional>

See CIQ.ChartEngine#attachQuoteFeed for function details.
Properties:
Name Type Argument Default Description
behavior.loadingNewChart boolean <optional>
 false

READ ONLY boolean telling when a chart is loading
behavior.updatingChart boolean <optional>
 false

READ ONLY boolean telling when a chart is updating
Since:
  • 5.1.1 Added maximumTicks to behavior parameter.
  • 7.3.0 Moved intervalTimer property into behavior parameter. Added filter parameter.
  • 8.5.0 Moved intervalTimer property into quoteFeed.

Classes

Lookup

Methods

pause(symbol)

Pauses updates from the quoteDriver without killing or disattaching it. Takes a symbol that is stored to know when it can be resumed.

Parameters:
Name Type Description
symbol string

symbol to pause on
Since:

  • 8.4.0

resume()

Called by CIQ.ChartEngine#loadChart to resume updating when the symbol changes.

Since:

  • 8.4.0