@malloydata/render 0.0.51-dev230705184641 → 0.0.51-dev230705200719

package/dist/data_styles.d.ts

@@ -92,7 +92,7 @@ export interface TimeRenderOptions extends TextRenderOptions {
     time?: Record<string, unknown>;
 }
 export interface NumberRenderOptions extends TextRenderOptions {
-    number?: Record<string, unknown>;
+    value_format?: string;
 }
 export interface ImageRenderOptions extends TextRenderOptions {
     border?: boolean;

package/dist/html/currency.d.ts

@@ -1,4 +1,4 @@
-import { DataColumn, Explore, Field, MalloyTagProperties } from '@malloydata/malloy';
+import { DataColumn, Explore, Field } from '@malloydata/malloy';
 import { HTMLTextRenderer } from './text';
 import { RendererFactory } from '../renderer_factory';
 import { CurrencyRenderOptions, StyleDefaults } from '../data_styles';
@@ -11,7 +11,7 @@ export declare class HTMLCurrencyRenderer extends HTMLTextRenderer {
 }
 export declare class CurrencyRendererFactory extends RendererFactory<CurrencyRenderOptions> {
     static readonly instance: CurrencyRendererFactory;
+    constructor();
     create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, options: CurrencyRenderOptions): Renderer;
-    parseTagParameters(tags: MalloyTagProperties): CurrencyRenderOptions | undefined;
     get rendererName(): string;
 }

package/dist/html/currency.js

@@ -56,15 +56,16 @@ class HTMLCurrencyRenderer extends text_1.HTMLTextRenderer {
 }
 exports.HTMLCurrencyRenderer = HTMLCurrencyRenderer;
 class CurrencyRendererFactory extends renderer_factory_1.RendererFactory {
+    constructor() {
+        super();
+        this.addExtractor((options, value) => {
+            var _a;
+            options.currency = (_a = value) !== null && _a !== void 0 ? _a : data_styles_1.Currency.Dollars;
+        }, this.rendererName);
+    }
     create(document, _styleDefaults, _rendererOptions, _field, options) {
         return new HTMLCurrencyRenderer(document, options);
     }
-    parseTagParameters(tags) {
-        var _a;
-        return {
-            currency: (_a = tags[this.rendererName]) !== null && _a !== void 0 ? _a : data_styles_1.Currency.Dollars,
-        };
-    }
     get rendererName() {
         return 'currency';
     }

package/dist/html/number.d.ts

@@ -5,12 +5,15 @@ import { RendererOptions } from '../renderer_types';
 import { Renderer } from '../renderer';
 import { RendererFactory } from '../renderer_factory';
 export declare class HTMLNumberRenderer extends HTMLTextRenderer {
+    readonly options: NumberRenderOptions;
+    constructor(document: Document, options: NumberRenderOptions);
     getNumber(data: DataColumn): number | null;
     getText(data: DataColumn): string | null;
 }
 export declare class NumberRendererFactory extends RendererFactory<NumberRenderOptions> {
     static readonly instance: NumberRendererFactory;
+    constructor();
     activates(field: Field | Explore): boolean;
-    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, _options: NumberRenderOptions): Renderer;
+    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, options: NumberRenderOptions): Renderer;
     get rendererName(): string;
 }

package/dist/html/number.js

@@ -21,16 +21,33 @@
  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NumberRendererFactory = exports.HTMLNumberRenderer = void 0;
 const malloy_1 = require("@malloydata/malloy");
 const text_1 = require("./text");
 const renderer_factory_1 = require("../renderer_factory");
+const numfmt_1 = __importDefault(require("numfmt"));
 class HTMLNumberRenderer extends text_1.HTMLTextRenderer {
+    constructor(document, options) {
+        super(document);
+        this.options = options;
+    }
     getNumber(data) {
         if (data.isNull()) {
             return null;
         }
+        if (this.options.value_format) {
+            try {
+                return numfmt_1.default.format(this.options.value_format, data.number.value);
+            }
+            catch {
+                // TODO: explore surfacing invalid format error, ignoring it for now.
+                return data.number.value;
+            }
+        }
         return data.number.value;
     }
     getText(data) {
@@ -40,13 +57,19 @@ class HTMLNumberRenderer extends text_1.HTMLTextRenderer {
 }
 exports.HTMLNumberRenderer = HTMLNumberRenderer;
 class NumberRendererFactory extends renderer_factory_1.RendererFactory {
+    constructor() {
+        super();
+        this.addExtractor((options, value) => {
+            options.value_format = value;
+        }, this.rendererName, 'value_format');
+    }
     activates(field) {
         return (field.hasParentExplore() &&
             field.isAtomicField() &&
             field.type === malloy_1.AtomicFieldType.Number);
     }
-    create(document, _styleDefaults, _rendererOptions, _field, _options) {
-        return new HTMLNumberRenderer(document);
+    create(document, _styleDefaults, _rendererOptions, _field, options) {
+        return new HTMLNumberRenderer(document, options);
     }
     get rendererName() {
         return 'number';

package/dist/html/percent.d.ts

@@ -9,6 +9,6 @@ export declare class HTMLPercentRenderer extends HTMLNumberRenderer {
 }
 export declare class PercentRendererFactory extends RendererFactory<PercentRenderOptions> {
     static readonly instance: PercentRendererFactory;
-    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, _options: PercentRenderOptions): Renderer;
+    create(document: Document, _styleDefaults: StyleDefaults, _rendererOptions: RendererOptions, _field: Field | Explore, options: PercentRenderOptions): Renderer;
     get rendererName(): string;
 }

package/dist/html/percent.js

@@ -35,8 +35,8 @@ class HTMLPercentRenderer extends number_1.HTMLNumberRenderer {
 }
 exports.HTMLPercentRenderer = HTMLPercentRenderer;
 class PercentRendererFactory extends renderer_factory_1.RendererFactory {
-    create(document, _styleDefaults, _rendererOptions, _field, _options) {
-        return new HTMLPercentRenderer(document);
+    create(document, _styleDefaults, _rendererOptions, _field, options) {
+        return new HTMLPercentRenderer(document, options);
     }
     get rendererName() {
         return 'percent';

package/dist/renderer_factory.d.ts

@@ -2,11 +2,15 @@ import { Explore, Field, MalloyTagProperties } from '@malloydata/malloy';
 import { Renderer } from './renderer';
 import { DataRenderOptions, RenderDef, StyleDefaults } from './data_styles';
 import { RendererOptions } from './renderer_types';
+declare type TagPropertyExtractor<T extends DataRenderOptions> = (options: T, extractedValue: string) => void;
 export declare abstract class RendererFactory<T extends DataRenderOptions> {
+    readonly tagOptionExtractors: Record<string, TagPropertyExtractor<T>>;
+    protected addExtractor(extractor: TagPropertyExtractor<T>, ...tags: string[]): void;
     activates(_field: Field | Explore): boolean;
     isValidMatch(_field: Field | Explore): boolean;
     matches(renderDef: RenderDef): boolean;
-    parseTagParameters(_tags: MalloyTagProperties): T | undefined;
+    parseTagParameters(tagProperties: MalloyTagProperties): T;
     abstract get rendererName(): string | undefined;
     abstract create(document: Document, styleDefaults: StyleDefaults, rendererOptions: RendererOptions, field: Field | Explore, renderOptions: T, timezone?: string): Renderer;
 }
+export {};

package/dist/renderer_factory.js

@@ -2,6 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RendererFactory = void 0;
 class RendererFactory {
+    constructor() {
+        this.tagOptionExtractors = {};
+    }
+    addExtractor(extractor, ...tags) {
+        for (const tag in tags) {
+            if (tag) {
+                this.tagOptionExtractors[tag] = extractor;
+            }
+        }
+    }
     activates(_field) {
         // Does not activate by default.
         return false;
@@ -12,8 +22,14 @@ class RendererFactory {
     matches(renderDef) {
         return renderDef.renderer === this.rendererName;
     }
-    parseTagParameters(_tags) {
-        return undefined;
+    parseTagParameters(tagProperties) {
+        const options = {};
+        for (const tag in this.tagOptionExtractors) {
+            if (tagProperties[tag] !== undefined &&
+                typeof tagProperties[tag] === 'string')
+                this.tagOptionExtractors[tag](options, tagProperties[tag]);
+        }
+        return options;
     }
 }
 exports.RendererFactory = RendererFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@malloydata/render",
-  "version": "0.0.51-dev230705184641",
+  "version": "0.0.51-dev230705200719",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,10 +18,11 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "@malloydata/malloy": "^0.0.51-dev230705184641",
+    "@malloydata/malloy": "^0.0.51-dev230705200719",
     "@types/luxon": "^2.4.0",
     "lodash": "^4.17.20",
     "luxon": "^2.4.0",
+    "numfmt": "^2.5.1",
     "us-atlas": "^3.0.0",
     "vega": "^5.21.0",
     "vega-lite": "^5.2.0"