Class: Driver

CIQ.ChartEngine. Driver


new Driver(stx, quoteFeed, behavior)

Drives the Chart's relationship with the quotefeed object provided to the chart

Parameters:
Name Type Description
stx CIQ.ChartEngine

A chart engine instance

quoteFeed object
behavior object
Properties
Name Type Argument Default Description
refreshInterval number <optional>

Defines how frequently in seconds the chart looks for an update

buffer number <optional>

A value of ticks that acts as a buffer before pagination

maximumTicks number <optional>
20000

Limiter on maximum number of ticks to request from a quoteFeed. Setting a value in the quoteDriver's behavior will override an individual quoteFeed's maximumTicks value.

Properties:
Name Type Argument Default Description
loadingNewChart boolean false

READ ONLY boolean telling when a new chart is loading

updatingChart boolean false

READ ONLY boolean telling when a chart is updating

intervalTimer number <nullable>
null

intervalTimer a set interval which can be cleared to stop the update loop

Since:
  • 5.1.1 added maximumTicks to behavior

Classes

Lookup

Methods


loadAll( [chart], cb)

Loads all available data

Parameters:
Name Type Argument Description
chart CIQ.ChartEngine.Chart <optional>

The chart to adjust. If left undefined, adjust the main symbol chart.

cb function

The callback function. Will be called with the error returned by the quotefeed, if any.

Since:
  • 07/01/2015

resetRefreshInterval(newInterval)

Convenience function to change the refresh interval that was set during attachQuoteFeed.

Parameters:
Name Type Description
newInterval number

The new refresh interval in seconds

Since:
  • 07/01/2015