Skip to content

XAxisConfig

Example

ts
{
  height: 36,
  border: { color: '#e5e5e5', width: 1 },
  minorLabels: {
    color: '#1a1a1a',
    fontSize: 12,
  },
  majorLabels: {
    color: '#1a1a1a',
    fontSize: 12,
    fontWeight: 'bold',
  },
  timeZoneId: 'America/New_York'
}

Properties

height

  • Type: number
  • Default: 36

Height of the x-axis in pixels.

border

Configuration for the border drawn along the top edge of the x-axis. Set to false to hide the border.

minorLabels

Configuration for minor time labels on the x-axis. Set to false to hide minor labels.

majorLabels

Configuration for major time labels on the x-axis. Set to false to hide major labels.

timeZoneId

  • Type: string

An IANA time zone identifier used to display timestamps in a specific time zone (e.g. 'America/New_York'). Defaults to UTC, or defaults to exchange local time zone if using session index provider.

TypeScript

ts
interface XAxisConfig {
  height?: number;
  border?: false | LineConfig;
  minorLabels?: false | TimeLabelConfig;
  majorLabels?: false | TimeLabelConfig;
  timeZoneId?: string;
}

React Candlesticks is available on npm and GitHub under the MIT License.