Documentation for versions prior to m-2016-12-01 can be found here.


We use the traditional Javascript terminology defined in Introduction to Object-Oriented Javascript and JSDoc. For example, a namespace here is a container bundling and encapsulating a set of library functionality under a unique name. Class is a template definition of an object's properties and methods -- the new operator is invoked on classes to create library objects.


Core

  • CIQ Static methods and base namespace. (formerly STX)
  • quotefeed interface: Describes how to implement a quotefeed. See also DataIntegrationOverview.
  • CIQ.ChartEngine: The basic chart class -- a ChartEngine object must be created before any chart operations can be performed. ( previously STXChart ).
  • CIQ.Drawing: Base class for drawing tools.
  • CIQ.I18N Namespace for internationalization API.
  • CIQ.Marker: DOM object to be managed by a chart, whose display is placed by date, tick, or bar.
  • CIQ.Market: Class used by chart to manage market hours for different exchanges.
  • CIQ.Studies: Namespace for technical-market studies/indicators applied to market data.

Web components

Trade From Chart - Classes associated with Trade From The Chart module

  • STX.TFC A trade-from-chart object used for querying and placing orders.
  • STX.Account Object that supports placing, modifying, and canceling trade orders.

Add Ons - Classes that interact with the chart to provide new functionality

  • CIQ.ExtendedHours An add-on for customers wishing to display extended hours data (pre and post market sessions).
  • CIQ.Tooltip: An add-on that adds a floating "tooltip" as the user mouses over the chart with their crosshairs. (This is a "lite" alternative to the floating "head's up" provided in template-advanced.html).
  • CIQ.InactivityTimer: An add-on that puts the chart into sleep mode when there is no user activity. This reduces the polling rate in the quotefeed.
  • CIQ.Animation: An add-on that makes the chart appear to smoothly transition from one price to the next.
  • CIQ.RangeSlider: An add-on that allows selection of a range of data within the dataSet using an interactive "slider".
  • CIQ.Share: An add-on that provides methods to convert the chart into an image for sharing.

Helpers - Tools for building core charting functionality

  • CIQ.EaseMachine: Device to simplify creation of animations.
  • CIQ.Plotter: Device for managing and optimizing complex drawing operations on the canvas.
  • CIQ.Renderer: Reusable base class used to draw complex visualizations for one or more series of data.
  • CIQ.NameValueStore: Base class for interacting with data storage, including remote storage of chart settings.

Third Party Classes

  • Xignite: Supports commercial feed to Xignite data.

Globals

  • $$: Functional equivalent for getElementById().
  • $$$: Functional equivalent for querySelector().

Advanced Capabilities