@spectrum-charts/vega-spec-builder 1.27.0 → 1.28.0

package/dist/@types/src/bullet/bulletMarkUtils.d.ts

@@ -1,15 +1,22 @@
-import { Axis, Mark } from 'vega';
+import { Axis, Mark, TextValueRef } from 'vega';
 import { BulletSpecOptions } from '../types';
 export declare const addMarks: (state: Mark[], args_0: BulletSpecOptions) => Mark[];
 export declare function getBulletMarkRect(bulletOptions: BulletSpecOptions): Mark;
 export declare function getBulletMarkTarget(bulletOptions: BulletSpecOptions): Mark;
 export declare function getBulletMarkLabel(bulletOptions: BulletSpecOptions): Mark;
+/**
+ * Gets the text production rules for a bullet value label.
+ * Handles shortNumber, shortCurrency, and d3 format strings consistently.
+ */
+export declare function getBulletValueText(numberFormat: string, datumProperty: string): ({
+    test?: string;
+} & TextValueRef)[];
 export declare function getBulletMarkValueLabel(bulletOptions: BulletSpecOptions): Mark;
 export declare function getBulletMarkTargetValueLabel(bulletOptions: BulletSpecOptions): Mark;
 export declare function getBulletMarkThreshold(bulletOptions: BulletSpecOptions): Mark;
 export declare function getBulletTrack(bulletOptions: BulletSpecOptions): Mark;
 export declare function getBulletLabelAxesLeft(labelOffset: any): Axis;
 export declare function getBulletLabelAxesRight(bulletOptions: BulletSpecOptions, labelOffset: any): Axis;
-export declare function getBulletScaleAxes(): Axis;
+export declare function getBulletScaleAxes(bulletOptions: BulletSpecOptions): Axis;
 export declare const addAxes: (state: Axis[], args_0: BulletSpecOptions) => Axis[];
 //# sourceMappingURL=bulletMarkUtils.d.ts.map

package/dist/@types/src/bullet/bulletMarkUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bulletMarkUtils.d.ts","sourceRoot":"","sources":["../../../../src/bullet/bulletMarkUtils.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,IAAI,EAAa,IAAI,EAAE,MAAM,MAAM,CAAC;AAI7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,QAAQ,sDAiDnB,CAAC;AAEH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAwCxE;AAED,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAiC1E;AAED,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAoBzE;AAED,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CA8B9E;AAED,wBAAgB,6BAA6B,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAyBpF;AAED,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAqC7E;AAED,wBAAgB,cAAc,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAgCrE;AAED,wBAAgB,sBAAsB,CAAC,WAAW,KAAA,GAAG,IAAI,CAUxD;AAED,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,iBAAiB,EAAE,WAAW,KAAA,GAAG,IAAI,CAsB3F;AAED,wBAAgB,kBAAkB,IAAI,IAAI,CAWzC;AAED,eAAO,MAAM,OAAO,sDASlB,CAAC"}
+{"version":3,"file":"bulletMarkUtils.d.ts","sourceRoot":"","sources":["../../../../src/bullet/bulletMarkUtils.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,IAAI,EAAa,IAAI,EAAE,YAAY,EAAE,MAAM,MAAM,CAAC;AAK3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE7C,eAAO,MAAM,QAAQ,sDAiDnB,CAAC;AAEH,wBAAgB,iBAAiB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAwCxE;AAED,wBAAgB,mBAAmB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAiC1E;AAED,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAoBzE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAChC,YAAY,EAAE,MAAM,EACpB,aAAa,EAAE,MAAM,GACpB,CAAC;IAAE,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,YAAY,CAAC,EAAE,CAGtC;AAED,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CA+B9E;AAED,wBAAgB,6BAA6B,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CA+BpF;AAED,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAqC7E;AAED,wBAAgB,cAAc,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAgCrE;AAED,wBAAgB,sBAAsB,CAAC,WAAW,KAAA,GAAG,IAAI,CAUxD;AAwBD,wBAAgB,uBAAuB,CAAC,aAAa,EAAE,iBAAiB,EAAE,WAAW,KAAA,GAAG,IAAI,CAyB3F;AAED,wBAAgB,kBAAkB,CAAC,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAuBzE;AAED,eAAO,MAAM,OAAO,sDASlB,CAAC"}

package/dist/@types/src/types/marks/bulletSpec.types.d.ts

@@ -19,6 +19,8 @@ export interface BulletOptions {
     maxScaleValue?: number;
     /** Key in the data that is used as the metric */
     metric?: string;
+    /** Key in the data that contains a custom label for the metric value. When provided, this label will be displayed instead of the metric value. */
+    metricLabel?: string;
     /** Adds an axis that follows the max target in basic mode */
     metricAxis?: boolean;
     /** Sets the name of the component. */
@@ -45,6 +47,8 @@ export interface BulletOptions {
     showTargetValue?: boolean;
     /** Target line */
     target?: string;
+    /** Key in the data that contains a label for the target value. When provided, this label will be displayed instead of the target value. */
+    targetLabel?: string;
     /** changes color based on threshold */
     /** If true, the metric bar will be colored according to the thresholds. */
     thresholdBarColor?: boolean;

package/dist/@types/src/types/marks/bulletSpec.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bulletSpec.types.d.ts","sourceRoot":"","sources":["../../../../../src/types/marks/bulletSpec.types.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEpE,MAAM,MAAM,mBAAmB,GAAG;IAAE,YAAY,CAAC,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAElG,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,QAAQ,CAAC;IAEnB,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wFAAwF;IACxF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sEAAsE;IACtE,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC7B,8HAA8H;IAC9H,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC/B,yEAAyE;IACzE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;IAC5C,kDAAkD;IAClD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yDAAyD;IACzD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kBAAkB;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,2EAA2E;IAC3E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACnC,mDAAmD;IACnD,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,KAAK,yBAAyB,GAC1B,MAAM,GACN,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,OAAO,GACP,WAAW,GACX,YAAY,GACZ,iBAAiB,GACjB,eAAe,GACf,WAAW,GACX,eAAe,GACf,OAAO,GACP,YAAY,GACZ,mBAAmB,CAAC;AAExB,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB,CAAC,aAAa,EAAE,yBAAyB,CAAC;IACpG,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf"}
+{"version":3,"file":"bulletSpec.types.d.ts","sourceRoot":"","sources":["../../../../../src/types/marks/bulletSpec.types.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEpE,MAAM,MAAM,mBAAmB,GAAG;IAAE,YAAY,CAAC,EAAE,MAAM,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAElG,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,QAAQ,CAAC;IAEnB,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,wFAAwF;IACxF,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,sEAAsE;IACtE,SAAS,CAAC,EAAE,KAAK,GAAG,QAAQ,CAAC;IAC7B,8HAA8H;IAC9H,aAAa,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC/B,yEAAyE;IACzE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,iDAAiD;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kJAAkJ;IAClJ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6DAA6D;IAC7D,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,sCAAsC;IACtC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;IAC5C,kDAAkD;IAClD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,yDAAyD;IACzD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,kBAAkB;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,2IAA2I;IAC3I,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,2EAA2E;IAC3E,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;;;;OAQG;IACH,UAAU,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACnC,mDAAmD;IACnD,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,KAAK,yBAAyB,GAC1B,MAAM,GACN,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,OAAO,GACP,WAAW,GACX,YAAY,GACZ,iBAAiB,GACjB,eAAe,GACf,WAAW,GACX,eAAe,GACf,OAAO,GACP,YAAY,GACZ,mBAAmB,CAAC;AAExB,MAAM,WAAW,iBAAkB,SAAQ,iBAAiB,CAAC,aAAa,EAAE,yBAAyB,CAAC;IACpG,WAAW,EAAE,WAAW,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf"}