TinyBase logoTinyBase β

TimeXAxisProps

The TimeXAxisProps type describes x-axis configuration for time axes.

(
  BaseXAxisProps &
  {
    scale: "time";
    timestampUnit?: TimestampUnit;
    min?: TimeValue;
    max?: TimeValue;
    ticks?: readonly TimeValue[];
    tickFormatter?: (tick: Date, timestamp: number) => string;
  }
)
TypeDescription
scale"time"

An optional scale to use for the x axis.

timestampUnit?TimestampUnit

The unit for numeric timestamp values on a time x axis.

min?TimeValue

An optional minimum x-axis bound for continuous numeric or time x values.

max?TimeValue

An optional maximum x-axis bound for continuous numeric or time x values.

ticks?readonly TimeValue[]

Optional tick values to use for a continuous numeric or time x axis.

tickFormatter?(tick: Date, timestamp: number) => string

An optional function for formatting x-axis tick labels.

Since

v8.5.0