StockEvent

Type class

StockEvent is object which holds information about event (bullet). Values from StockEventsSettings will be used if not set. Stock event bullet's size depends on it's graphs fontSize. When user rolls-over, clicks or rolls-out of the event bullet, AmStockChart dispatches events.

Sources

This information about StockEvent is provided for reference only and is not available through exported packages and thus should not be imported or used on its own.

Inheritance

StockEvent does not extend any other symbol.

StockEvent is not extended by any other symbol.

Properties

#backgroundAlpha

Type numberDefault 1

Opacity of bullet background.

#backgroundColor

Type colorDefault #DADADA

Color of bullet background.

#borderAlpha

Type numberDefault 1

Opacity of bullet border.

#borderColor

Type colorDefault #888888

Bullet border color.

#color

Type colorDefault #000000

The color of the event text.

#date

Type date

Date of an event. Can be a string of date (using chart.dataDateFormat format) or Date object.

#description

Type string

A description that will be shown in a balloon when user rolls over mouse cursor over event icon.

#fontSize

Type number

Specifies font size of a event bullet. Will use graph's or chart font size if not set.

#graph

Type StockGraph

graph on which event will be displayed. You can use a reference to the stock graph object or id of the graph.

#rollOverColor

Type stringDefault #CC0000

Roll-over background color.

#showAt

Type string

Allows placing event bullets at open/close/low/high values.

#showBullet

Type booleanDefault false

If you set it to true, the data point will display both event and regular (if set) bullet.

#showOnAxis

Type booleanDefault false

Specifies if the event should be displayed on category axis

#text

Type string

Letter which will be displayed on the event. Not all types can display letters. "text" type can display longer texts.

#type

Type stringDefault sign

Type of bullet. Possible values are: "flag", "sign", "pin", "triangleUp", "triangleDown", "triangleLeft", "triangleRight", "text", "arrowUp", "arrowDown".

#url

Type string

A URL to go to when user clicks the event.

#urlTarget

Type string

target of url, "_blank" for example.

#value

Type number

Allows placing event bullets at specified value.

Methods

StockEvent does not have any methods.

Events

StockEvent does not have any events.