MAIDR JavaScript API
    Preparing search index...
    • One instant of a time axis, in terms a reader can hear.

      ECharts hands over epoch milliseconds. A date is announced as the day it is when the instant lands exactly on a midnight -- which is what daily data does -- and as the full timestamp otherwise, so nothing is rounded away from a chart that carries a time of day.

      Whose midnight is the chart's useUTC. ECharts draws in local time unless told otherwise, and a local midnight read in UTC is announced as the day before east of Greenwich and as eight in the morning in California -- not the date on the axis. Superset and Metabase both set useUTC: true.

      A non-time axis is left as the number it is.

      Parameters

      • value: number | null | undefined

        The raw value of the time column

      • dated: boolean

        Whether the axis was declared type: 'time'

      • utc: boolean = true

        Whether the chart draws its times in UTC

      Returns string | number

      The value to announce