@graphysdk/viz-engine 0.0.1-experimental.3 → 0.0.1-experimental.5

package/dist/index.d.ts

@@ -110,6 +110,29 @@ declare interface AnnotationDataPoint {
     rowValue?: DataValue;
 }
 
+/**
+ * Attach annotations to a spec. Multiple `annotations(...)` items append within
+ * each group (like `geom` layers and `highlight`s), they don't replace.
+ *
+ * @example
+ * pipe(
+ *   createSpec({ x: 'quarter', y: 'revenue' }),
+ *   geom.bar(),
+ *   scale.x(),
+ *   scale.y(),
+ *   annotations({
+ *     differenceArrows: [
+ *       {
+ *         start: { anchorValue: 'Q1', groupValue: null },
+ *         end: { anchorValue: 'Q3', groupValue: null },
+ *         label: 'relative-difference',
+ *       },
+ *     ],
+ *   }),
+ * );
+ */
+export declare const annotations: (input: AnnotationsInput) => AnnotationsItem;
+
 /**
  * Compiles annotations into a render-ready format.
  *
@@ -143,6 +166,12 @@ export declare interface AnnotationsInput {
     comments?: CommentAnnotationInput[];
 }
 
+/** Annotations as a pipeable spec item. Produced by {@link annotations}. */
+export declare interface AnnotationsItem {
+    type: 'annotations';
+    annotations: AnnotationsInput;
+}
+
 /** Resolved annotations for a chart, with every group present and all fields defaulted. */
 export declare interface AnnotationsSpec {
     differenceArrows: DifferenceArrowSpec[];
@@ -5925,7 +5954,7 @@ export declare interface SpecInput {
     config: ConfigInput;
 }
 
-declare type SpecItem = LayerInput | ScaleInput | CoordInput | ConfigItem | TransformInput | MappingItem | HighlightInput;
+declare type SpecItem = LayerInput | ScaleInput | CoordInput | ConfigItem | TransformInput | MappingItem | HighlightInput | AnnotationsItem;
 
 /**
  * Compiles a raw compiler input or graph config into a resolved Spec.