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 stringDefault #DADADA

Color of bullet background.

#borderAlpha

Type numberDefault 1

Opacity of bullet border.

#borderColor

Type stringDefault #888888

Bullet border color.

#color

Type stringDefault #000000

The color of the event text.

#date

Type DateDefault

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 StockGraphDefault

graph on which event will be displayed.

#rollOverColor

Type stringDefault #CC0000

Roll-over background color.

#showOnAxis

Type booleanDefault false

Specifies if the event should be displayed on category axis

#text

Type stringDefault

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 stringDefault

A URL to go to when user clicks the event.

#urlTarget

Type stringDefault

target of url, "_blank" for example.

Methods

StockEvent does not have any methods.

Events

StockEvent does not have any events.