@uwdata/mosaic-spec 0.7.1 → 0.8.0

package/src/spec/marks/Vector.ts

@@ -0,0 +1,113 @@
+import { ParamRef } from '../Param.js';
+import { FrameAnchor } from '../PlotTypes.js';
+import { ChannelValue, ChannelValueSpec, MarkData, MarkOptions } from './Marks.js';
+
+/**
+ * The built-in vector shape implementations; one of:
+ *
+ * - *arrow* - a straight line with an open arrowhead at the end (↑)
+ * - *spike* - an isosceles triangle with a flat base (▲)
+ */
+export type VectorShapeName = 'arrow' | 'spike';
+
+/** How to draw a vector: either a named shape or a custom implementation. */
+export type VectorShape = VectorShapeName;
+
+/** Options for the vector mark. */
+export interface VectorOptions extends MarkOptions {
+  /**
+   * The horizontal position of the vector’s anchor point; an optional channel
+   * bound to the *x* scale. Default depends on the **frameAnchor**.
+   */
+  x?: ChannelValueSpec;
+
+  /**
+   * The vertical position of the vector’s anchor point; an optional channel
+   * bound to the *y* scale. Default depends on the **frameAnchor**.
+   */
+  y?: ChannelValueSpec;
+
+  /**
+   * The vector shape’s radius, such as half the width of the *arrow*’s head or
+   * the *spike*’s base; a constant number in pixels. Defaults to 3.5 pixels.
+   */
+  r?: number | ParamRef;
+
+  /**
+   * The vector’s length; either an optional channel bound to the *length* scale
+   * or a constant number in pixels. Defaults to 12 pixels.
+   */
+  length?: ChannelValueSpec;
+
+  /**
+   * The vector’s orientation (rotation angle); either a constant number in
+   * degrees clockwise, or an optional channel (with no associated scale).
+   * Defaults to 0 degrees with the vector pointing up.
+   */
+  rotate?: ChannelValue;
+
+  /** The shape of the vector; a constant. Defaults to *arrow*. */
+  shape?: VectorShape | ParamRef;
+
+  /**
+   * The vector’s position along its orientation relative to its anchor point; a
+   * constant. Assuming a default **rotate** angle of 0°, one of:
+   *
+   * - *start* - from [*x*, *y*] to [*x*, *y* - *l*]
+   * - *middle* (default) - from [*x*, *y* + *l* / 2] to [*x*, *y* - *l* / 2]
+   * - *end* - from [*x*, *y* + *l*] to [*x*, *y*]
+   *
+   * where [*x*, *y*] is the vector’s anchor point and *l* is the vector’s
+   * (possibly scaled) length in pixels.
+   */
+  anchor?: 'start' | 'middle' | 'end' | ParamRef;
+
+  /**
+   * The vector’s frame anchor, to default **x** and **y** relative to the
+   * frame; a constant representing one of the frame corners (*top-left*,
+   * *top-right*, *bottom-right*, *bottom-left*), sides (*top*, *right*,
+   * *bottom*, *left*), or *middle* (default). Has no effect if both **x**
+   * and **y** are specified.
+   */
+  frameAnchor?: FrameAnchor | ParamRef;
+}
+
+/** The vector mark. */
+export interface Vector extends MarkData, VectorOptions {
+  /**
+   * A vector mark.
+   *
+   * If none of **frameAnchor**, **x**, and **y** are specified, then **x** and
+   * **y** default to accessors assuming that *data* contains tuples [[*x₀*,
+   * *y₀*], [*x₁*, *y₁*], [*x₂*, *y₂*], …]
+   */
+  mark: 'vector';
+}
+
+/** The vectorX mark. */
+export interface VectorX extends MarkData, VectorOptions {
+  /**
+   * Like vector, but **x** instead defaults to the identity function and **y**
+   * defaults to null, assuming that *data* is an array of numbers [*x₀*, *x₁*,
+   * *x₂*, …].
+   */
+  mark: 'vectorX';
+}
+
+/** The vectorY mark. */
+export interface VectorY extends MarkData, VectorOptions {
+  /**
+   * Like vector, but **y** instead defaults to the identity function and **x**
+   * defaults to null, assuming that *data* is an array of numbers [*y₀*, *y₁*,
+   * *y₂*, …].
+   */
+  mark: 'vectorY';
+}
+
+/** The spike mark. */
+export interface Spike extends MarkData, VectorOptions {
+  /**
+   * Like vector, but with default *options* suitable for drawing a spike map.
+   */
+  mark: 'spike';
+}

package/src/util.js

@@ -45,3 +45,11 @@ export function isFunction(value) {
 export function error(message, data) {
   throw Object.assign(Error(message), { data });
 }
+
+const re = /^(?:[-+]\d{2})?\d{4}(?:-\d{2}(?:-\d{2})?)?(?:T\d{2}:\d{2}(?::\d{2}(?:\.\d{3})?)?(?:Z|[-+]\d{2}:?\d{2})?)?$/;
+
+// adapted from https://github.com/mbostock/isoformat/
+export function isoparse(string, fallback) {
+  if (!re.test(string += '')) return fallback;
+  return new Date(string);
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "include": ["src/**/*.js", "src/**/*.ts"],
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "outDir": "dist/types",
+    "module": "node16",
+    "skipLibCheck": true
+  }
+}