API Reference

Class: XAxisLabel

CIQ.ChartEngine. XAxisLabel

new XAxisLabel(params)

This is the object stored in CIQ.ChartEngine.chart.xaxis array which contains information regarding an x-axis tick. See CIQ.ChartEngine.AdvancedInjectable.createXAxis for more detail.

Name Type Description
params object

input parameters

Name Type Argument Description
hz number

Horizontal position of center of label in pixels. Any elements with negative positions will be off the edge of the screen, and are only maintained to help produce a more predictable display as the chart is zoomed and panned.

grid string

Either "line" or "boundary" depending on whether the label should be a date/time boundary or just a grid line

text string

The text to display in the label

raw string <optional>

The raw value used to generate the text

level number <optional>

The order in which the label gets put into the axis (lowest numbers first)

marketOpenOffset number <optional>

For minute labels, number of minutes between midnight market time and label time. If provided, may be used to align levels with market open times regardless of display time zone.

  • 8.4.0 added raw and priority parameter, rationalized to object parameter