Information on this website refers to a deprecated product, and is provided only for historical reference. Please use the Version Switcher above to select an appropriate documentation website for the product you are using.

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.

Inheritance

StockEvent does not extend any other symbol.

StockEvent is not extended by any other symbol.

Properties

backgroundAlpha
#

Type number

Default 1

Opacity of bullet background.

backgroundColor
#

Type string

Default #DADADA

Color of bullet background.

borderAlpha
#

Type number

Default 1

Opacity of bullet border.

borderColor
#

Type string

Default #888888

Bullet border color.

color
#

Type string

Default #000000

The color of the event text.

date
#

Type Date

Default

Date of an event. Must be Date object, not a string.

description
#

Type string

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

graph
#

Type StockGraph

Default

graph on which event will be displayed.

rollOverColor
#

Type string

Default #CC0000

Roll-over background color.

showOnAxis
#

Type boolean

Default false

Specifies if the event should be displayed on category axis

text
#

Type string

Default

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

type
#

Type string

Default sign

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

url
#

Type string

Default

A URL to go to when user clicks the event.

urlTarget
#

Type string

Default

target of url, "_blank" for example.

Methods

StockEvent does not have any methods.

Events

StockEvent does not have any events.

Adapters

StockEvent does not have any adapters.