@opendata-ai/openchart-core 7.9.3 → 7.11.0

package/dist/index.d.ts

@@ -4520,8 +4520,10 @@ type DateGranularity = 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' |
  *   Pass `false` when formatting ticks from a local-time scale (d3 scaleTime),
  *   so that e.g. midnight local isn't misread as an intra-day UTC time.
  *   Defaults to `true` for backward compatibility.
+ * @param compact - Use the compact format table (axis ticks whose full-format
+ *   labels would overlap). Defaults to `false`.
  */
-declare function formatDate(value: Date | string | number, _locale?: string, granularity?: DateGranularity, useUtc?: boolean): string;
+declare function formatDate(value: Date | string | number, _locale?: string, granularity?: DateGranularity, useUtc?: boolean, compact?: boolean): string;
 /**
  * Build a formatter for temporal values using a d3-time-format string (e.g. "%Y", "%b %Y").
  * Returns a function that accepts a Date, string, or number and returns the formatted string.

package/dist/index.js

@@ -3198,15 +3198,29 @@ var GRANULARITY_FORMATS = {
   hour: "%b %d %H:%M",
   minute: "%H:%M"
 };
-function formatDate(value, _locale, granularity, useUtc = true) {
+var GRANULARITY_FORMATS_COMPACT = {
+  year: "%Y",
+  quarter: "",
+  // special-cased below, like GRANULARITY_FORMATS
+  month: "%b",
+  week: "%b %d",
+  day: "%b %d",
+  hour: "%H:%M",
+  minute: "%H:%M"
+};
+function formatDate(value, _locale, granularity, useUtc = true, compact = false) {
   const date = value instanceof Date ? value : new Date(value);
   if (Number.isNaN(date.getTime())) return String(value);
   const gran = granularity ?? inferGranularity(date, useUtc);
   if (gran === "quarter") {
     const q = useUtc ? Math.ceil((date.getUTCMonth() + 1) / 3) : Math.ceil((date.getMonth() + 1) / 3);
-    return `Q${q} ${date.getFullYear()}`;
+    const year = useUtc ? date.getUTCFullYear() : date.getFullYear();
+    if (compact) {
+      return `Q${q} '${String(year).slice(-2)}`;
+    }
+    return `Q${q} ${year}`;
   }
-  const formatStr = GRANULARITY_FORMATS[gran];
+  const formatStr = (compact ? GRANULARITY_FORMATS_COMPACT : GRANULARITY_FORMATS)[gran];
   if (useUtc) {
     return utcFormat(formatStr)(date);
   }