@malloydata/render 0.0.331 → 0.0.333

package/dist/module/component/cell-utils.d.ts

@@ -0,0 +1,40 @@
+import { Cell } from '../data_tree';
+import { Tag } from '@malloydata/malloy-tag';
+export interface RenderCellValueOptions {
+    /**
+     * Value to return for null cells.
+     * Defaults to NULL_SYMBOL ('∅').
+     */
+    nullValue?: string;
+    /**
+     * Override tag for formatting.
+     * Use this when rendering array elements - pass the array field's tag
+     * so formatting (currency, percent, etc.) is applied from the array definition.
+     * If not provided, uses the cell's own field tag.
+     */
+    tag?: Tag;
+}
+/**
+ * Render a Cell value to a formatted display string.
+ *
+ * Handles all cell types with appropriate formatting:
+ * - Numbers: uses renderNumberCell (handles bigint precision + formatting tags)
+ * - Dates: uses renderDateTimeField with isDate: true
+ * - Timestamps: uses renderDateTimeField with isDate: false
+ * - Strings: returns value directly
+ * - Booleans: returns 'true' or 'false'
+ * - Null: returns nullValue option (defaults to NULL_SYMBOL)
+ *
+ * @example
+ * // Basic usage (pivot headers, etc.)
+ * renderCellValue(cell)
+ *
+ * @example
+ * // Array elements - use array field's tag for formatting
+ * renderCellValue(elementCell, { tag: arrayField.tag })
+ *
+ * @example
+ * // Custom null display
+ * renderCellValue(cell, { nullValue: '' })
+ */
+export declare function renderCellValue(cell: Cell, options?: RenderCellValueOptions): string;

package/dist/module/component/render-numeric-field.d.ts

@@ -1,15 +1,26 @@
 import { RenderTimeStringOptions } from '../util';
 import { Field, NumberCell } from '../data_tree';
-export declare function renderNumericField(f: Field, value: number | null | undefined): string;
+import { Tag } from '@malloydata/malloy-tag';
+/**
+ * Renders a numeric field with formatting based on tags.
+ *
+ * Supports:
+ * - Currency shorthand: # currency=usd2m, # currency=eur0k
+ * - Currency verbose: # currency { scale=m decimals=2 suffix=finance }
+ * - Number shorthand: # number=1k, # number=0m, # number=auto
+ * - Number verbose: # number { scale=m decimals=2 suffix=word }
+ * - Legacy: # number=big, # currency=euro
+ */
+export declare function renderNumericField(f: Field, value: number | null | undefined, tagOverride?: Tag): string;
 /**
  * Render a big number value (stored as string for precision).
  * Used when NumberCell.stringValue is defined (bigint/bigdecimal subtypes).
  * Default formatting preserves full precision with comma separators.
  *
- * Note: percent, duration, and custom number formats are lossy for values > 2^53
- * because they require numeric operations. Currency preserves precision.
+ * Note: percent, duration, scale, and custom number formats are lossy for values > 2^53
+ * because they require numeric operations. This is acceptable for abbreviated display.
  */
-export declare function renderBigNumberField(f: Field, value: string | null | undefined): string;
+export declare function renderBigNumberField(f: Field, value: string | null | undefined, tagOverride?: Tag): string;
 /**
  * Render a NumberCell for display, automatically handling bigint precision.
  *
@@ -25,7 +36,8 @@ export declare function renderBigNumberField(f: Field, value: string | null | un
  *   const displayValue = renderNumberCell(cell);
  *
  * @param cell - A NumberCell from the data tree
+ * @param tagOverride - Optional tag to use for formatting (e.g., for array elements, use the array field's tag)
  * @returns Formatted string for display, respecting field tags (currency, percent, etc.)
  */
-export declare function renderNumberCell(cell: NumberCell): string;
-export declare function renderDateTimeField(f: Field, value: Date | null | undefined, options?: RenderTimeStringOptions): string;
+export declare function renderNumberCell(cell: NumberCell, tagOverride?: Tag): string;
+export declare function renderDateTimeField(f: Field, value: Date | null | undefined, options?: RenderTimeStringOptions, tagOverride?: Tag): string;

package/dist/module/html/data_styles.d.ts

@@ -86,14 +86,22 @@ export declare enum Currency {
     Euros = "euro",
     Pounds = "pound"
 }
+export type Scale = 'k' | 'm' | 'b' | 't' | 'q' | 'auto';
+export type SuffixFormat = 'letter' | 'lower' | 'word' | 'short' | 'finance' | 'scientific' | 'none';
 export interface CurrencyRenderOptions extends TextRenderOptions {
     currency?: Currency;
+    scale?: Scale;
+    decimals?: number;
+    suffix?: SuffixFormat;
 }
 export interface TimeRenderOptions extends TextRenderOptions {
     time?: Record<string, unknown>;
 }
 export interface NumberRenderOptions extends TextRenderOptions {
     value_format?: string;
+    scale?: Scale;
+    decimals?: number;
+    suffix?: SuffixFormat;
 }
 export declare enum DataVolumeUnit {
     Bytes = "bytes",