StockChartX HTML5

StockChartX

StockChartX namespace

Classes

AbstractGeometricMarkerDrawing
Animation
ArrowDownDrawing
ArrowDrawingBase
ArrowLeftDrawing
ArrowRightDrawing
ArrowUpDrawing
AutoDateScaleCalibrator
AutoValueScaleCalibrator
BarPriceStyle
CandlePriceStyle
Chart
ChartComponent
ChartEventsExtender
ChartFrameControl
ChartPanel
ChartPanelObject
ChartPanelsContainer
ChartPanelSplitter
ChartPanelValueScale
ChartPoint
CircleDrawing
ClassRegistrar
ClickGesture
ColoredBarPriceStyle
Component
Control
CrossHair
CustomDateTimeFormat
CustomNumberFormat
DataManager
DataSeries
DateScale
DateScaleCalibrator
DateScalePanel
DateTimeFormat
DiamondDrawing
DotDrawing
DoubleClickGesture
Drawing
EllipseDrawing
EventsDispatcher
FibonacciArcsDrawing
FibonacciDrawingBase
FibonacciEllipsesDrawing
FibonacciExtensionsDrawing
FibonacciFanDrawing
FibonacciRetracementsDrawing
FibonacciTimeZonesDrawing
FixedDateScaleCalibrator
FixedValueScaleCalibrator
FrameControl
Gesture
GestureArray
HeikinAshiPriceStyle
HistogramPlot
HollowCandlePriceStyle
HorizontalLineDrawing
ImageDrawing
Indicator
IntervalValueScaleCalibrator
IntlNumberFormat
KagiPriceStyle
KumoPlot
LineBreakPriceStyle
LinePlot
LinePriceStyle
LineSegmentDrawing
MountainPriceStyle
MouseHoverGesture
MouseWheelGesture
NumberFormat
PanGesture
Plot
PointAndFigurePriceStyle
PointPlot
PriceStyle
Projection
Rect
RectangleDrawing
RenkoPriceStyle
SelectionMarker
SquareDrawing
TAIndicator
TextDrawing
TimeIntervalDateTimeFormat
TriangleDrawing
ValueMarker
ValueScale
ValueScaleCalibrator
ValueScalePanel
VerticalLineDrawing

Namespaces

Animations
DummyCanvasContext
Geometry

Members

<static, readonly> CrossHairType :string

Cross hair type enum values.
Type:
  • string
Properties:
Name Type Default Description
NONE string none Cross hair is not shown. Use regular cursor.
MARKERS string markers Show date and value markers. Cross hair lines are hidden.
CROSS string cross Show cross hair lines and markers.

<static, readonly> DataSeriesSuffix :string

The data series suffixes.
Type:
  • string
Properties:
Name Type Default Description
DATE string .date Date data series suffix.
OPEN string .open Open data series suffix.
HIGH string .high High data series suffix.
LOW string .low Low data series suffix.
CLOSE string .close Close data series suffix.
VOLUME string .volume Volume data series suffix.
HEIKIN_ASHI string .heikin_ashi Heikin ashi data series. It is used in combination with OPEN, HIGH, LOW and CLOSE suffix.
RENKO string .renko Renko data series. It is used in combination with DATE, OPEN, HIGH, LOW, CLOSE, VOLUME suffixes.
LINE_BREAK string .line_break Line break data series. It is used in combination with DATE, OPEN, HIGH, LOW, CLOSE, VOLUME suffixes.
POINT_AND_FIGURE string .point_and_figure Point & Figure data series. It is used in combination with DATE, OPEN, HIGH, LOW, CLOSE, VOLUME suffixes.
KAGI string kagi Kagi data series. It is used in combination with DATE, OPEN, HIGH, LOW, CLOSE, VOLUME suffixes.

<static, readonly> DateScaleScrollKind :string

Date scale scroll kind enum values.
Type:
  • string
Properties:
Name Type Default Description
NORMAL string normal Normal scroll.
AUTOSCALED string autoscaled Auto-scale value scales on scroll.

<static, readonly> DateScaleZoomKind :string

Date scale zoom kind enum values.
Type:
  • string
Properties:
Name Type Default Description
NORMAL string normal Normal zoom.
AUTOSCALED string autoscaled Auto-scale value scales on zoom.

<static, readonly> DateScaleZoomMode :string

Date scale zoom mode enum values.
Type:
  • string

<static, readonly> FillPriority :string

Fill priority enumeration values.
Type:
  • string
Properties:
Name Type Default Description
COLOR string color The solid color fill style.

<static> FontDefaults :object

Default font properties.
Type:
  • object
Properties:
Name Type Description
fontFamily string The font family (e.g. 'Arial', 'Calibri', ...).
fontSize number The font size.
fontStyle string The font style (e.g. 'normal', 'italic').
fontVariant string The font variant.
fontWeight string The font weight (e.g. 'normal', 'bold').

<static, readonly> GestureState :number

Gesture state enumeration.
Type:
  • number
Properties:
Name Type Default Description
NONE number 0 Gesture is not recognized.
STARTED number 1 Gesture started.
CONTINUED number 2 Gesture continued.
FINISHED number 3 Gesture finished.

<static, readonly> IndicatorParam :string

Indicator parameter name constants.
Type:
  • string
Properties:
Name Type Default Description
SOURCE string Source
SOURCE2 string Source 2
PERIODS string Periods
STANDARD_DEVIATIONS string Standard Deviations
MA_TYPE string Moving Average Type
SHIFT string Shift
MIN_TICK string Min Tick Value
LIMIT_MOVE string Limit Move Value
PCT_K_PERIODS string %K Periods
PCT_K_SMOOTHING string %K Smoothing
PCT_K_DOUBLE_SMOOTHING string %K Double Smoothing
PCT_D_PERIODS string %D Periods
PCT_D_MA_TYPE string %D Moving Average Type
BAR_HISTORY string Bar History
R2_SCALE string R2 Scale
CYCLE_1 string Cycle 1
CYCLE_2 string Cycle 2
CYCLE_3 string Cycle 3
SHORT_TERM string Short Term
LONG_TERM string Long Term
POINTS_OR_PERCENT string Points or Percent
RATE_OF_CHANGE string Rate of Change
SHORT_CYCLE string Short Cycle
LONG_CYCLE string Long Cycle
SIGNAL_PERIODS string Signal Periods
MIN_AF string Min AF
MAX_AF string Max AF
LEVELS string Levels
LINE_WIDTH string Line Width
LINE_STYLE string Line Style
LINE_COLOR string Line Color
LINE2_WIDTH string Line 2 Width
LINE2_STYLE string Line 2 Style
LINE2_COLOR string Line 2 Color
LINE3_WIDTH string Line 3 Width
LINE3_STYLE string Line 3 Style
LINE3_COLOR string Line 3 Color

<static, readonly> KagiReversalKind :string

Kagi reversal amount kind enum values.
Type:
  • string
Properties:
Name Type Default Description
ATR string atr The reversal amount is based on ATR value.
FIXED string fixed The reversal amount is based on fixed value.

<static, readonly> LineStyle :string

Line styles enumeration values.
Type:
  • string
Properties:
Name Type Default Description
SOLID string solid The solid line style.
DASH string dash The dashed line style.
DOT string dot The dotted line style.
DASH_DOT string dash-dot DASH_DOT The dashed-dotted line style.

<static, readonly> PanelMoveDirection :string

Chart panel move direction enum values.
Type:
  • string

<static, readonly> PanelMoveKind :string

Chart panel move kind enum values.
Type:
  • string

<static, readonly> PointAndFigureBoxSizeKind :string

Point & Figure box size kind enum values.
Type:
  • string
Properties:
Name Type Default Description
ATR string atr The box size is based on ATR value.
FIXED string fixed The box size is based on fixed value.

<static, readonly> RenkoBoxSizeKind :string

Renko box kind enum values.
Type:
  • string
Properties:
Name Type Default Description
FIXED string fixed The box size is based on fixed value.
ATR string atr The box size is based on ATR value.

<static, readonly> StrokePriority :string

Stroke priority enumeration values.
Type:
  • string
Properties:
Name Type Default Description
COLOR string color The solid color stroke style.

<static, readonly> TimeSpan :number

Time span values.
Type:
  • number
Properties:
Name Type Default Description
MILLISECONDS_IN_YEAR number 31556926000 Number of milliseconds in year.
MILLISECONDS_IN_MONTH number 2629743830 number of milliseconds in month.
MILLISECONDS_IN_WEEK number 604800000 Number of milliseconds in week.
MILLISECONDS_IN_DAY number 86400000 Number of milliseconds in day.
MILLISECONDS_IN_HOUR number 3600000 Number of milliseconds in hour.
MILLISECONDS_IN_MINUTE number 60000 Number of milliseconds in minute.
MILLISECONDS_IN_SECOND number 1000 Number of milliseconds in second.

<static> ViewsPath :string

Path to the folder which contains UI views (dialogs, menus, etc.).
Type:
  • string
Default Value:
  • 'view/'

<static, readonly> XPointBehavior :string

X point behavior enum values.
Type:
  • string
Properties:
Name Type Default Description
X string x Use x as X coordinate
RECORD string record Use record as X coordinate
DATE string date Use date as X coordinate

<static, readonly> YPointBehavior :string

Y point behavior enum values.
Type:
  • string
Properties:
Name Type Default Description
Y string y Use y as Y coordinate
VALUE string value Use value as Y coordinate

Type Definitions

Bar

The bar structure.
Type:
  • object
Properties:
Name Type Description
date Date The timestamp of the bar.
open number The open price.
high number The high price.
low number The low price.
close number The close price.
volume number The volume.

BarDataSeries

The bar data series object.
Type:
  • object
Properties:
Name Type Description
date StockChartX.DataSeries The date data series.
open StockChartX.DataSeries The open data series.
high StockChartX.DataSeries The high data series.
low StockChartX.DataSeries The low data series.
close StockChartX.DataSeries The close data series.
volume StockChartX.DataSeries The volume data series.

CanvasImageCallback(canvas)

The save image callback function.
Parameters:
Name Type Description
canvas HTMLCanvasElement The rendering canvas.

DateScaleMajorTick

The date scale major tick mark structure.
Type:
  • object
Properties:
Name Type Description
x number The x coordinate of the tick mark.
date Date The date value.
textX number The x coordinate of the tick mark text.
text string The text representation of the date.

DateScaleMinorTick

The date scale minor tick mark structure.
Type:
  • object
Properties:
Name Type Description
x number The x coordinate of the tick mark.

EventHandler(event)

The event handler callback.
Parameters:
Name Type Description
event Object The event object.

FibonacciLevel

The fibonacci level structure.
Type:
  • object
Properties:
Name Type Argument Default Description
visible boolean <optional>
 true The flag that indicates whether level is visible.
value number The level value.
theme object <optional>
 The theme for the level.
Example
var point = {
     x: 10,
     y: 20
 };

FillTheme

The fill theme structure.
Type:
  • object
Properties:
Name Type Argument Default Description
fillEnabled boolean <optional>
 true The flag that indicates whether fill theme is enabled.
fillPriority FillPriority <optional>
 'color' The fill priority (for future use).
fillColor string <optional>
 'black' The fill color.
Example
// Red fill theme
var fillTheme = {
 fillColor: 'red'
};

Instrument

The instrument structure.
Type:
  • object
Properties:
Name Type Argument Description
symbol string The symbol name. E.g. 'AAPL'.
company string <optional>
 The company name. E.g. 'Apple Inc.'.
exchange string <optional>
 The exchange. E.g. 'NSDQ'.

KagiReversalAmount

The kagi reversal amount structure.
Type:
  • object
Properties:
Name Type Description
kind string The reversal amount kind (atr or fixed).
value number The reversal amount.
Example
var reversal = {
     kind: StockChartX.KagiReversalKind.ATR,
     value: 14
 };

OHLCDataSeries

The OHLC data series object.
Type:
  • object
Properties:
Name Type Description
open StockChartX.DataSeries The open data series.
high StockChartX.DataSeries The high data series.
low StockChartX.DataSeries The low data series.
close StockChartX.DataSeries The close data series.

Padding

The padding values structure.
Type:
  • object
Properties:
Name Type Description
left number The left padding.
top number The top padding.
right number The right padding.
bottom number The bottom padding.
Example
var padding = {
     left: 5,
     top: 5,
     right: 10,
     bottom: 10
 };

Point

The point structure.
Type:
  • object
Properties:
Name Type Description
x number The X coordinate.
y number The Y coordinate.
Example
var point = {
     x: 10,
     y: 20
 };

PointAndFigureBoxSize

The point & figure box size structure.
Type:
  • object
Properties:
Name Type Description
kind string The box size kind (atr or fixed).
value number The box size value.
Example
var boxSize = {
     kind: StockChartX.PointAndFigureBoxSizeKind.ATR,
     value: 14
 };

PointBehavior

The point behavior structure.
Type:
  • object
Properties:
Name Type Description
x StockChartX.XPointBehavior The X coordinate behavior.
y StockChartX.YPointBehavior The Y coordinate behavior.
See:
Example
var behavior = {
 x: StockChartX.XPointBehavior.DATE,
 y: StockChartX.YPointBehavior.VALUE
};

RenkoBoxSize

The renko box size structure.
Type:
  • object
Properties:
Name Type Description
kind string The box size kind (atr or fixed).
value number The box size value.
Example
var boxSize = {
     kind: StockChartX.RenkoBoxSizeKind.ATR,
     value: 14
 };

SelectionMarkerTheme

The selection marker theme structure.
Type:
  • object
Properties:
Name Type Description
line StrokeTheme The border line theme.
fill FillTheme The fill theme.
Example
// Selection marker with black border and white background.
var theme = {
 line: {
     strokeColor: 'black'
 },
 fill: {
     fillColor: 'white'
 }
};

Size

The size structure.
Type:
  • object
Properties:
Name Type Description
width number The width.
height number The height.
Example
var size = {
 width: 10,
 height: 20
};

StringPaddingOptions

The string padding options
Type:
  • object
Properties:
Name Type Description
width number The number of characters in the resulting string (equal to the number of original characters plus any additional padding characters.
alignLeft boolean If true then characters are left aligned, otherwise characters are right aligned.
padding char The padding character.

StrokeTheme

The stroke theme structure.
Type:
  • object
Properties:
Name Type Argument Default Description
strokeEnabled boolean <optional>
 true The flag that indicates whether stroke theme is enabled.
strokePriority StrokePriority <optional>
 'color' The stroke priority (for future use).
width number <optional>
 1 The stroke width.
strokeColor string <optional>
 'black' The stroke color.
lineStyle LineStyle <optional>
 'solid' The stroke style.
lineCap string <optional>
 'butt' The style of the end caps for the line. Possible values are 'butt', 'round' and 'square'.
lineJoin string <optional>
 'miter' The type of corner created, when two lines meet. Possible values are 'bevel', 'round' and 'miter'.
Example
// Stroke theme for the solid red 5 px line.
var strokeTheme = {
 width: 5,
 strokeColor: 'red'
};

// Stroke theme for the dashed green line
var strokeTheme = {
 strokeColor: 'green',
 lineStyle: StockChartX.LineStyle.DASH
};

TextTheme

The text theme structure.
Type:
  • object
Properties:
Name Type Argument Default Description
fontFamily String <optional>
 'Arial' The font family (e.g. 'Arial', 'Calibri', ...). 'Arial' by default.
fontSize Number <optional>
 12 The font size.
fontStyle String <optional>
 'normal' The font style (e.g. 'normal', 'italic'). 'normal' by default.
fontWeight String <optional>
 'normal' The font weight (e.g. 'normal', 'bold'). 'normal' by default.
fontVariant String <optional>
 'normal' The font variant.
Mixes In:
  • StrokeTheme
  • FillTheme
Example
var theme = {
 fontFamily: 'Times New Roman',
 fontSize: 14,
 fillColor: 'green',
 strokeEnabled: false
};

ValueScaleMajorTick

The value scale major tick mark structure.
Type:
  • object
Properties:
Name Type Description
y number The Y coordinate of the tick mark.
value number The value.
text string The text representation of the date.

ValueScaleMinorTick

The value scale minor tick mark structure.
Type:
  • object
Properties:
Name Type Description
y number The Y coordinate of the tick mark.

WindowEvent

The window mouse/touch event.
Type:
  • Object
Properties:
Name Type Argument Description
pointerPosition StockChartX.Point The current pointer position.
evt JQueryEventObject The jQuery event object.
stopPropagation boolean <optional>
 The flag that indicates whether bubbling of an event to parent elements should be stopped.