API Reference
Namespaces
Classes
Events
Global
Externals

Class: Estimize

Estimize ()

new Estimize()

This class contains functions which control the Estimize API.

Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

Members

ciq :CIQ.ChartEngine

Chart engine

Type:

enabled :boolean

Indicator as to whether Estimize is currently enabled

Type:
  • boolean
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

<static, constant> DATA :number

Data enumerated type

Type:
  • number
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

Default Value:
  • 3

<static, constant> EPS :number

Earnings Per Share enumerated type

Type:
  • number
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

Default Value:
  • 0

<static, constant> QONQ :number

Quarter-on-quarter enumerated type

Type:
  • number
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

Default Value:
  • 2

<static, constant> REVENUE :number

Revenue enumerated type

Type:
  • number
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

Default Value:
  • 1

Methods

appendMasterData(stx, appendQuotes)

Add new data to master data

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
appendQuotes Array.<object>

new quote records to process
Since:
  • 9.6.0 removed parameter chart.
  • 10.1.0 Estimize plugin scheduled for end of life.
Deprecated:

  • As of 10.1.0

calculateEPSPercent(current, prior)

Calculate EPS percent change.

Parameters:
Name Type Description
current number

Current EPS value
prior number

Prior EPS value
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

Returns:

Percent change

Type
number | null

disable()

Turn off Estimize functionality

Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

drawDataPanel(stx)

Draw the data panel

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart Engine
Since:
  • 9.6.0 removed parameter chart.
  • 10.1.0 Estimize plugin scheduled for end of life.
Deprecated:

  • As of 10.1.0

drawOver(stx)

Draw watermarks on chart.

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
Since:
  • 9.6.0 removed parameter chart.
  • 10.1.0 Estimize plugin scheduled for end of life.
Deprecated:

  • As of 10.1.0

drawPriceHorizon(stx, quote, x, configuration)

Draw price horizon on the chart.

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
quote object

quote record
x number

x coordinate on chart in pixels
configuration object

Object containing Estimize key names from API
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

drawUnder(stx)

Split into earnings, revenue and check for existing panel

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
Since:
  • 9.6.0 removed parameter chart.
  • 10.1.0 Estimize plugin scheduled for end of life.
Deprecated:

  • As of 10.1.0

drawUnderDoIt(stx, configuration)

Actually draw the EPS and Revenue panels

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
configuration object

Object containing Estimize key names from API
Since:
  • 9.6.0 removed parameter chart.
  • 10.1.0 Estimize plugin scheduled for end of life.
Deprecated:

  • As of 10.1.0

enable()

Turn on Estimize functionality

Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

getDataSet(stx)

Fetch Estimize data from remote source and process.

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
Since:
  • 9.6.0 removed parameter chart
  • 10.1.0 Estimize plugin scheduled for end of life.
Deprecated:

  • As of 10.1.0

go(action)

Execute requested command

Parameters:
Name Type Description
action string

Requested command, e.g. "earnings", "revenue", "data", "ph_rev", "ph_eps", "ph_historical"
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

horizonLabel(x, y, width, txt, label, stx)

Draw Price Horizon label on chart.

Parameters:
Name Type Description
x number

x-coordinate in pixels
y number

y-coordinate in pixels
width number

Pixel width of text
txt string

Price to draw
label string

Label to draw
stx CIQ.ChartEngine

Chart engine
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

isActivated()

Return whether Estimize is showing on the chart

Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

Returns:

True if showing

Type
boolean

isExactQuarter(dt)

Estimize older data (< 2012) doesn't have exact release dates

Parameters:
Name Type Description
dt Date

Date
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

Returns:

True if date is first day of last month of quarter

Type
boolean

main(ciq)

Assign Estimize object to Chart Engine

Parameters:
Name Type Description
ciq CIQ.ChartEngine
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

priceHorizons(stx, configuration)

Draws all price horizons

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
configuration object

Object containing Estimize key names from API
Since:
  • 9.6.0 removed parameter chart.
  • 10.1.0 Estimize plugin scheduled for end of life.
Deprecated:

  • As of 10.1.0

processMasterData(data, chart)

Process incoming Estimize data and put into masterData.

Parameters:
Name Type Description
data object

Master data
chart CIQ.ChartEngine.Chart

Chart object
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

setMasterData(stx)

Put new Estimize data into masterData.

Parameters:
Name Type Description
stx CIQ.ChartEngine

Chart engine
Since:
  • 9.6.0 removed parameter chart.
  • 10.1.0 Estimize plugin scheduled for end of life.
Deprecated:

  • As of 10.1.0

showPanelTitles()

Display panel titles for Estimize panels

Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0

watermark(stx, txt [, panel])

Set a message to later draw on the panel.

Parameters:
Name Type Argument Description
stx CIQ.ChartEngine

Chart engine
txt string

Text message to draw as watermark
panel string <optional>

Panel to draw upon, default to main chart panel
Since:

  • 10.1.0 Estimize plugin scheduled for end of life.

Deprecated:

  • As of 10.1.0