svelteplot 0.10.2 → 0.10.3-pr-370.1

package/dist/marks/GridY.svelte.d.ts

@@ -1,4 +1,5 @@
 import type { RawValue, ChannelAccessor } from '../types/index.js';
+import { usePlot } from '../hooks/usePlot.svelte.js';
 declare function $$render<Datum = RawValue>(): {
     props: Omit<Partial<{
         filter: import("../types/index.js").ConstantAccessor<boolean, Datum>;
@@ -7,14 +8,14 @@ declare function $$render<Datum = RawValue>(): {
         fy: ChannelAccessor<Datum>;
         dx: import("../types/index.js").ConstantAccessor<number, Datum>;
         dy: import("../types/index.js").ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: usePlot;
+        dodgeY: usePlot;
         fill: ChannelAccessor<Datum>;
         fillOpacity: import("../types/index.js").ConstantAccessor<number, Datum>;
-        sort: ((a: RawValue, b: RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | import("../types/index.js").ConstantAccessor<RawValue, Datum>;
+        } | ((a: RawValue, b: RawValue) => number) | import("../types/index.js").ConstantAccessor<RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: import("../types/index.js").ConstantAccessor<number, Datum>;
         strokeOpacity: import("../types/index.js").ConstantAccessor<number, Datum>;
@@ -64,9 +65,13 @@ declare function $$render<Datum = RawValue>(): {
         style: string;
         cursor: import("../types/index.js").ConstantAccessor<import("csstype").Property.Cursor, Datum>;
     }>, "fill" | "fillOpacity"> & {
+        /** custom values at which to draw horizontal gridlines */
         data?: Datum[];
+        /** whether these gridlines were automatically added by the Plot component */
         automatic?: boolean;
+        /** the starting horizontal position of the gridline */
         x1?: ChannelAccessor<Datum>;
+        /** the ending horizontal position of the gridline */
         x2?: ChannelAccessor<Datum>;
     };
     exports: {};

package/dist/marks/HTMLTooltip.svelte

@@ -4,12 +4,19 @@
 -->
 <script lang="ts" generics="Datum = DataRow">
     interface HTMLTooltipMarkProps {
+        /** the input data array */
         data: Datum[];
+        /** the horizontal position channel; bound to the x scale */
         x?: ChannelAccessor<Datum>;
+        /** the vertical position channel; bound to the y scale */
         y?: ChannelAccessor<Datum>;
+        /** the radius channel, used for positioning with dot-based data */
         r?: ChannelAccessor<Datum>;
+        /** the horizontal facet channel */
         fx?: ChannelAccessor<Datum>;
+        /** the vertical facet channel */
         fy?: ChannelAccessor<Datum>;
+        /** snippet for rendering the tooltip content; receives the nearest datum */
         children: Snippet<[{ datum: Datum }]>;
     }
     import { type Snippet } from 'svelte';

package/dist/marks/HTMLTooltip.svelte.d.ts

@@ -2,12 +2,19 @@ import { type Snippet } from 'svelte';
 import type { ChannelAccessor, DataRow } from '../types/index.js';
 declare function $$render<Datum = DataRow>(): {
     props: {
+        /** the input data array */
         data: Datum[];
+        /** the horizontal position channel; bound to the x scale */
         x?: ChannelAccessor<Datum>;
+        /** the vertical position channel; bound to the y scale */
         y?: ChannelAccessor<Datum>;
+        /** the radius channel, used for positioning with dot-based data */
         r?: ChannelAccessor<Datum>;
+        /** the horizontal facet channel */
         fx?: ChannelAccessor<Datum>;
+        /** the vertical facet channel */
         fy?: ChannelAccessor<Datum>;
+        /** snippet for rendering the tooltip content; receives the nearest datum */
         children: Snippet<[{
             datum: Datum;
         }]>;

package/dist/marks/Image.svelte.d.ts

@@ -1,4 +1,5 @@
 import type { ChannelAccessor, ConstantAccessor, DataRecord, LinkableMarkProps } from '../types';
+import { resolveProp } from '../helpers/resolve';
 declare function $$render<Datum extends DataRecord>(): {
     props: Partial<{
         filter: ConstantAccessor<boolean, Datum>;
@@ -7,14 +8,14 @@ declare function $$render<Datum extends DataRecord>(): {
         fy: ChannelAccessor<Datum>;
         dx: ConstantAccessor<number, Datum>;
         dy: ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: resolveProp;
+        dodgeY: resolveProp;
         fill: ChannelAccessor<Datum>;
         fillOpacity: ConstantAccessor<number, Datum>;
-        sort: ((a: import("../types").RawValue, b: import("../types").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | ConstantAccessor<import("../types").RawValue, Datum>;
+        } | ((a: import("../types").RawValue, b: import("../types").RawValue) => number) | ConstantAccessor<import("../types").RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: ConstantAccessor<number, Datum>;
         strokeOpacity: ConstantAccessor<number, Datum>;

package/dist/marks/Line.svelte.d.ts

@@ -9,14 +9,14 @@ declare function $$render<Datum extends DataRecord>(): {
         fy: ChannelAccessor<Datum>;
         dx: ConstantAccessor<number, Datum>;
         dy: ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge.js").DodgeXOptions;
-        dodgeY: import("../transforms/dodge.js").DodgeYOptions;
+        dodgeX: RawValue;
+        dodgeY: RawValue;
         fill: ChannelAccessor<Datum>;
         fillOpacity: ConstantAccessor<number, Datum>;
-        sort: ((a: RawValue, b: RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | ConstantAccessor<RawValue, Datum>;
+        } | ((a: import("../types/data.js").RawValue, b: import("../types/data.js").RawValue) => number) | ConstantAccessor<import("../types/data.js").RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: ConstantAccessor<number, Datum>;
         strokeOpacity: ConstantAccessor<number, Datum>;

package/dist/marks/LineX.svelte.d.ts

@@ -7,14 +7,14 @@ declare function $$render<Datum extends DataRow>(): {
         fy: import("../types").ChannelAccessor<Record<string | symbol, import("../types").RawValue>>;
         dx: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
         dy: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: DataRow;
+        dodgeY: DataRow;
         fill: import("../types").ChannelAccessor<Record<string | symbol, import("../types").RawValue>>;
         fillOpacity: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
-        sort: ((a: import("../types").RawValue, b: import("../types").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | import("../types").ConstantAccessor<import("../types").RawValue, Record<string | symbol, import("../types").RawValue>>;
+        } | ((a: import("../types").RawValue, b: import("../types").RawValue) => number) | import("../types").ConstantAccessor<import("../types").RawValue, Record<string | symbol, import("../types").RawValue>>;
         stroke: import("../types").ChannelAccessor<Record<string | symbol, import("../types").RawValue>>;
         strokeWidth: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
         strokeOpacity: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
@@ -73,7 +73,7 @@ declare function $$render<Datum extends DataRow>(): {
         outlineStrokeOpacity?: number;
         curve?: import("../types").CurveName | import("d3-shape").CurveFactory | "auto";
         tension?: number;
-        sort?: import("../types").ConstantAccessor<import("../types").RawValue, Record<string | symbol, import("../types").RawValue>> | {
+        sort?: import("../types").ConstantAccessor<DataRow, Datum_1> | {
             channel: "stroke" | "fill";
         };
         text?: import("../types").ConstantAccessor<string, Record<string | symbol, import("../types").RawValue>>;
@@ -83,7 +83,7 @@ declare function $$render<Datum extends DataRow>(): {
         textStrokeWidth?: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
         lineClass?: import("../types").ConstantAccessor<string, Record<string | symbol, import("../types").RawValue>>;
         canvas?: boolean;
-    }, "data" | "y"> & {
+    }, "y" | "data"> & {
         data: Datum[];
     };
     exports: {};

package/dist/marks/LineY.svelte.d.ts

@@ -7,14 +7,14 @@ declare function $$render<Datum extends DataRow>(): {
         fy: import("../types").ChannelAccessor<Record<string | symbol, import("../types").RawValue>>;
         dx: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
         dy: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: DataRow;
+        dodgeY: DataRow;
         fill: import("../types").ChannelAccessor<Record<string | symbol, import("../types").RawValue>>;
         fillOpacity: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
-        sort: ((a: import("../types").RawValue, b: import("../types").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | import("../types").ConstantAccessor<import("../types").RawValue, Record<string | symbol, import("../types").RawValue>>;
+        } | ((a: import("../types").RawValue, b: import("../types").RawValue) => number) | import("../types").ConstantAccessor<import("../types").RawValue, Record<string | symbol, import("../types").RawValue>>;
         stroke: import("../types").ChannelAccessor<Record<string | symbol, import("../types").RawValue>>;
         strokeWidth: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
         strokeOpacity: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
@@ -73,7 +73,7 @@ declare function $$render<Datum extends DataRow>(): {
         outlineStrokeOpacity?: number;
         curve?: import("../types").CurveName | import("d3-shape").CurveFactory | "auto";
         tension?: number;
-        sort?: import("../types").ConstantAccessor<import("../types").RawValue, Record<string | symbol, import("../types").RawValue>> | {
+        sort?: import("../types").ConstantAccessor<DataRow, Datum_1> | {
             channel: "stroke" | "fill";
         };
         text?: import("../types").ConstantAccessor<string, Record<string | symbol, import("../types").RawValue>>;
@@ -83,7 +83,7 @@ declare function $$render<Datum extends DataRow>(): {
         textStrokeWidth?: import("../types").ConstantAccessor<number, Record<string | symbol, import("../types").RawValue>>;
         lineClass?: import("../types").ConstantAccessor<string, Record<string | symbol, import("../types").RawValue>>;
         canvas?: boolean;
-    }, "data" | "x"> & {
+    }, "x" | "data"> & {
         data: Datum[];
     };
     exports: {};

package/dist/marks/Link.svelte

@@ -4,7 +4,9 @@
 
 <script lang="ts" generics="Datum extends DataRecord">
     interface LinkMarkProps extends BaseMarkProps<Datum>, MarkerOptions {
+        /** the input data array; each element becomes one link */
         data: Datum[];
+        /** sort order for data points before rendering */
         sort?: ConstantAccessor<RawValue> | { channel: 'stroke' | 'fill' };
         /**
          * the x1 channel accessor for the start of the link
@@ -18,7 +20,7 @@
          * the x2 channel accessor for the end of the link
          */
         x2: ChannelAccessor<Datum>;
-
+        /** the y2 channel accessor for the end of the link */
         y2: ChannelAccessor<Datum>;
         /**
          * the curve type, defaults to 'auto' which uses a linear curve for planar projections

package/dist/marks/Link.svelte.d.ts

@@ -1,5 +1,6 @@
 import type { DataRecord, ConstantAccessor, ChannelAccessor, CurveName, MarkerOptions, RawValue } from '../types/index.js';
 import { type CurveFactory } from 'd3-shape';
+import { sort } from '../transforms/sort.js';
 declare function $$render<Datum extends DataRecord>(): {
     props: Partial<{
         filter: ConstantAccessor<boolean, Datum>;
@@ -8,14 +9,14 @@ declare function $$render<Datum extends DataRecord>(): {
         fy: ChannelAccessor<Datum>;
         dx: ConstantAccessor<number, Datum>;
         dy: ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge.js").DodgeXOptions;
-        dodgeY: import("../transforms/dodge.js").DodgeYOptions;
+        dodgeX: sort;
+        dodgeY: sort;
         fill: ChannelAccessor<Datum>;
         fillOpacity: ConstantAccessor<number, Datum>;
-        sort: ((a: RawValue, b: RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | ConstantAccessor<RawValue, Datum>;
+        } | ((a: RawValue, b: RawValue) => number) | ConstantAccessor<RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: ConstantAccessor<number, Datum>;
         strokeOpacity: ConstantAccessor<number, Datum>;
@@ -65,7 +66,9 @@ declare function $$render<Datum extends DataRecord>(): {
         style: string;
         cursor: ConstantAccessor<import("csstype").Property.Cursor, Datum>;
     }> & MarkerOptions & {
+        /** the input data array; each element becomes one link */
         data: Datum[];
+        /** sort order for data points before rendering */
         sort?: ConstantAccessor<RawValue> | {
             channel: "stroke" | "fill";
         };
@@ -81,6 +84,7 @@ declare function $$render<Datum extends DataRecord>(): {
          * the x2 channel accessor for the end of the link
          */
         x2: ChannelAccessor<Datum>;
+        /** the y2 channel accessor for the end of the link */
         y2: ChannelAccessor<Datum>;
         /**
          * the curve type, defaults to 'auto' which uses a linear curve for planar projections

package/dist/marks/Pointer.svelte

@@ -1,11 +1,18 @@
 <script lang="ts" generics="Datum extends DataRow">
     interface PointerMarkProps {
+        /** the input data array */
         data: Datum[];
+        /** snippet rendered with the currently selected data points */
         children?: Snippet<[{ data: Datum[] }]>;
+        /** the horizontal position channel; bound to the x scale */
         x?: ChannelAccessor<Datum>;
+        /** the vertical position channel; bound to the y scale */
         y?: ChannelAccessor<Datum>;
+        /** grouping channel for splitting data into separate search trees */
         z?: ChannelAccessor<Datum>;
+        /** the horizontal facet channel */
         fx?: ChannelAccessor<Datum>;
+        /** the vertical facet channel */
         fy?: ChannelAccessor<Datum>;
         /**
          * maximum cursor distance to select data points

package/dist/marks/Pointer.svelte.d.ts

@@ -2,14 +2,21 @@ import { type Snippet } from 'svelte';
 import type { ChannelAccessor, DataRow } from '../types/index.js';
 declare function $$render<Datum extends DataRow>(): {
     props: {
+        /** the input data array */
         data: Datum[];
+        /** snippet rendered with the currently selected data points */
         children?: Snippet<[{
             data: Datum[];
         }]>;
+        /** the horizontal position channel; bound to the x scale */
         x?: ChannelAccessor<Datum>;
+        /** the vertical position channel; bound to the y scale */
         y?: ChannelAccessor<Datum>;
+        /** grouping channel for splitting data into separate search trees */
         z?: ChannelAccessor<Datum>;
+        /** the horizontal facet channel */
         fx?: ChannelAccessor<Datum>;
+        /** the vertical facet channel */
         fy?: ChannelAccessor<Datum>;
         /**
          * maximum cursor distance to select data points

package/dist/marks/Rect.svelte.d.ts

@@ -1,4 +1,5 @@
 import type { DataRecord, BaseRectMarkProps, ChannelAccessor, LinkableMarkProps } from '../types/index.js';
+import { IS_SORTED } from '../transforms/sort';
 declare function $$render<Datum extends DataRecord>(): {
     props: Partial<{
         filter: import("../types/index.js").ConstantAccessor<boolean, Datum>;
@@ -7,14 +8,14 @@ declare function $$render<Datum extends DataRecord>(): {
         fy: ChannelAccessor<Datum>;
         dx: import("../types/index.js").ConstantAccessor<number, Datum>;
         dy: import("../types/index.js").ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: IS_SORTED;
+        dodgeY: IS_SORTED;
         fill: ChannelAccessor<Datum>;
         fillOpacity: import("../types/index.js").ConstantAccessor<number, Datum>;
-        sort: ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | import("../types/index.js").ConstantAccessor<import("../types/data").RawValue, Datum>;
+        } | ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | import("../types/index.js").ConstantAccessor<import("../types/data").RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: import("../types/index.js").ConstantAccessor<number, Datum>;
         strokeOpacity: import("../types/index.js").ConstantAccessor<number, Datum>;

package/dist/marks/RuleX.svelte.d.ts

@@ -1,4 +1,5 @@
 import type { DataRecord, ConstantAccessor, ChannelAccessor, RawValue } from '../types/index.js';
+import { usePlot } from '../hooks/usePlot.svelte.js';
 declare function $$render<Datum = DataRecord | RawValue>(): {
     props: Omit<Partial<{
         filter: ConstantAccessor<boolean, Datum>;
@@ -7,14 +8,14 @@ declare function $$render<Datum = DataRecord | RawValue>(): {
         fy: ChannelAccessor<Datum>;
         dx: ConstantAccessor<number, Datum>;
         dy: ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: usePlot;
+        dodgeY: usePlot;
         fill: ChannelAccessor<Datum>;
         fillOpacity: ConstantAccessor<number, Datum>;
-        sort: ((a: RawValue, b: RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | ConstantAccessor<RawValue, Datum>;
+        } | ((a: RawValue, b: RawValue) => number) | ConstantAccessor<RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: ConstantAccessor<number, Datum>;
         strokeOpacity: ConstantAccessor<number, Datum>;

package/dist/marks/RuleY.svelte.d.ts

@@ -1,4 +1,5 @@
 import type { DataRecord, ConstantAccessor, ChannelAccessor } from '../types/index.js';
+import { IS_SORTED } from '../transforms/sort';
 declare function $$render<Datum = DataRecord>(): {
     props: Omit<Partial<{
         filter: ConstantAccessor<boolean, Datum>;
@@ -7,14 +8,14 @@ declare function $$render<Datum = DataRecord>(): {
         fy: ChannelAccessor<Datum>;
         dx: ConstantAccessor<number, Datum>;
         dy: ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: IS_SORTED;
+        dodgeY: IS_SORTED;
         fill: ChannelAccessor<Datum>;
         fillOpacity: ConstantAccessor<number, Datum>;
-        sort: ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | ConstantAccessor<import("../types/data").RawValue, Datum>;
+        } | ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | ConstantAccessor<import("../types/data").RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: ConstantAccessor<number, Datum>;
         strokeOpacity: ConstantAccessor<number, Datum>;

package/dist/marks/Spike.svelte

@@ -7,11 +7,17 @@
         ComponentProps<typeof Vector>,
         'data' | 'x' | 'y' | 'r' | 'length' | 'rotate'
     > {
+        /** the input data array; each element becomes one spike */
         data: Datum[];
+        /** the horizontal position channel; bound to the x scale */
         x: ChannelAccessor<Datum>;
+        /** the vertical position channel; bound to the y scale */
         y: ChannelAccessor<Datum>;
+        /** the radius (width) of the spike base in pixels */
         r?: number;
+        /** the length of the spike in pixels */
         length?: ChannelAccessor<Datum>;
+        /** rotation angle of the spike in degrees */
         rotate?: ChannelAccessor<Datum>;
     }
     import Vector from './Vector.svelte';

package/dist/marks/Spike.svelte.d.ts

@@ -7,14 +7,14 @@ declare function $$render<Datum extends DataRecord>(): {
         fy: ChannelAccessor<Record<string | symbol, import("../types/data").RawValue>>;
         dx: import("../types/index.js").ConstantAccessor<number, Record<string | symbol, import("../types/data").RawValue>>;
         dy: import("../types/index.js").ConstantAccessor<number, Record<string | symbol, import("../types/data").RawValue>>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: DodgeXOptions;
+        dodgeY: DodgeYOptions;
         fill: ChannelAccessor<Record<string | symbol, import("../types/data").RawValue>>;
         fillOpacity: import("../types/index.js").ConstantAccessor<number, Record<string | symbol, import("../types/data").RawValue>>;
-        sort: ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | import("../types/index.js").ConstantAccessor<import("../types/data").RawValue, Record<string | symbol, import("../types/data").RawValue>>;
+        } | ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | import("../types/index.js").ConstantAccessor<import("../types/data").RawValue, Record<string | symbol, import("../types/data").RawValue>>;
         stroke: ChannelAccessor<Record<string | symbol, import("../types/data").RawValue>>;
         strokeWidth: import("../types/index.js").ConstantAccessor<number, Record<string | symbol, import("../types/data").RawValue>>;
         strokeOpacity: import("../types/index.js").ConstantAccessor<number, Record<string | symbol, import("../types/data").RawValue>>;
@@ -74,12 +74,18 @@ declare function $$render<Datum extends DataRecord>(): {
         shape?: "arrow" | "spike" | "arrow-filled" | import("./Vector.svelte").ShapeRenderer;
         children?: import("svelte").Snippet;
         canvas?: boolean;
-    }, "data" | "r" | "length" | "x" | "y" | "rotate"> & {
+    }, "r" | "length" | "x" | "y" | "data" | "rotate"> & {
+        /** the input data array; each element becomes one spike */
         data: Datum[];
+        /** the horizontal position channel; bound to the x scale */
         x: ChannelAccessor<Datum>;
+        /** the vertical position channel; bound to the y scale */
         y: ChannelAccessor<Datum>;
+        /** the radius (width) of the spike base in pixels */
         r?: number;
+        /** the length of the spike in pixels */
         length?: ChannelAccessor<Datum>;
+        /** rotation angle of the spike in degrees */
         rotate?: ChannelAccessor<Datum>;
     };
     exports: {};

package/dist/marks/Text.svelte.d.ts

@@ -1,6 +1,7 @@
 import type * as CSS from 'csstype';
 import { type Snippet } from 'svelte';
 import type { DataRecord, ConstantAccessor, ChannelAccessor, LinkableMarkProps } from '../types/index.js';
+import { indexData } from '../transforms/recordize';
 declare function $$render<Datum extends DataRecord>(): {
     props: (Partial<{
         filter: ConstantAccessor<boolean, Datum>;
@@ -9,14 +10,14 @@ declare function $$render<Datum extends DataRecord>(): {
         fy: ChannelAccessor<Datum>;
         dx: ConstantAccessor<number, Datum>;
         dy: ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: indexData;
+        dodgeY: indexData;
         fill: ChannelAccessor<Datum>;
         fillOpacity: ConstantAccessor<number, Datum>;
-        sort: ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | ConstantAccessor<import("../types/data").RawValue, Datum>;
+        } | ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | ConstantAccessor<import("../types/data").RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: ConstantAccessor<number, Datum>;
         strokeOpacity: ConstantAccessor<number, Datum>;
@@ -118,14 +119,14 @@ declare function $$render<Datum extends DataRecord>(): {
         fy: ChannelAccessor<Datum>;
         dx: ConstantAccessor<number, Datum>;
         dy: ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: indexData;
+        dodgeY: indexData;
         fill: ChannelAccessor<Datum>;
         fillOpacity: ConstantAccessor<number, Datum>;
-        sort: ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | ConstantAccessor<import("../types/data").RawValue, Datum>;
+        } | ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | ConstantAccessor<import("../types/data").RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: ConstantAccessor<number, Datum>;
         strokeOpacity: ConstantAccessor<number, Datum>;

package/dist/marks/TickX.svelte

@@ -5,6 +5,7 @@
 
 <script lang="ts" generics="Datum extends DataRow">
     interface TickXMarkProps extends Omit<BaseMarkProps<Datum>, 'fill' | 'fillOpacity'> {
+        /** the input data array; each element becomes one vertical tick */
         data: Datum[];
         /**
          * the horizontal position; bound to the x scale
@@ -20,6 +21,7 @@
          * length of the tick. Defaults to 10 pixel
          */
         tickLength?: ConstantAccessor<number, Datum>;
+        /** if true, renders using Canvas instead of SVG */
         canvas?: boolean;
     }
     import Mark from '../Mark.svelte';

package/dist/marks/TickX.svelte.d.ts

@@ -1,4 +1,5 @@
 import type { ChannelAccessor, DataRow, ConstantAccessor } from '../types/index.js';
+import { usePlot } from '../hooks/usePlot.svelte.js';
 declare function $$render<Datum extends DataRow>(): {
     props: Omit<Partial<{
         filter: ConstantAccessor<boolean, Datum>;
@@ -7,14 +8,14 @@ declare function $$render<Datum extends DataRow>(): {
         fy: ChannelAccessor<Datum>;
         dx: ConstantAccessor<number, Datum>;
         dy: ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: usePlot;
+        dodgeY: usePlot;
         fill: ChannelAccessor<Datum>;
         fillOpacity: ConstantAccessor<number, Datum>;
-        sort: ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | ConstantAccessor<import("../types/data").RawValue, Datum>;
+        } | ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | ConstantAccessor<import("../types/data").RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: ConstantAccessor<number, Datum>;
         strokeOpacity: ConstantAccessor<number, Datum>;
@@ -64,6 +65,7 @@ declare function $$render<Datum extends DataRow>(): {
         style: string;
         cursor: ConstantAccessor<import("csstype").Property.Cursor, Datum>;
     }>, "fill" | "fillOpacity"> & {
+        /** the input data array; each element becomes one vertical tick */
         data: Datum[];
         /**
          * the horizontal position; bound to the x scale
@@ -79,6 +81,7 @@ declare function $$render<Datum extends DataRow>(): {
          * length of the tick. Defaults to 10 pixel
          */
         tickLength?: ConstantAccessor<number, Datum>;
+        /** if true, renders using Canvas instead of SVG */
         canvas?: boolean;
     };
     exports: {};

package/dist/marks/TickY.svelte

@@ -4,14 +4,15 @@
 -->
 <script lang="ts" generics="Datum extends DataRow">
     interface TickYMarkProps extends Omit<BaseMarkProps<Datum>, 'fill' | 'fillOpacity'> {
+        /** the input data array; each element becomes one horizontal tick */
         data: Datum[];
         /**
-         * the vertical position; bound to the x scale
+         * the vertical position; bound to the y scale
          */
         y?: ChannelAccessor<Datum>;
         /**
-         * the horizontal position; bound to the y scale, which must be band. If the y channel
-         * is not specified, the tick will span the full vertical extent of the frame.
+         * the horizontal position; bound to the x scale, which must be band. If the x channel
+         * is not specified, the tick will span the full horizontal extent of the frame.
          */
         x?: ChannelAccessor<Datum>;
         /**
@@ -19,6 +20,7 @@
          * length of the tick. Defaults to 10 pixel
          */
         tickLength?: ConstantAccessor<number, Datum>;
+        /** if true, renders using Canvas instead of SVG */
         canvas?: boolean;
     }
     import Mark from '../Mark.svelte';

package/dist/marks/TickY.svelte.d.ts

@@ -1,4 +1,5 @@
 import type { ChannelAccessor, DataRow, ConstantAccessor } from '../types/index.js';
+import { usePlot } from '../hooks/usePlot.svelte.js';
 declare function $$render<Datum extends DataRow>(): {
     props: Omit<Partial<{
         filter: ConstantAccessor<boolean, Datum>;
@@ -7,14 +8,14 @@ declare function $$render<Datum extends DataRow>(): {
         fy: ChannelAccessor<Datum>;
         dx: ConstantAccessor<number, Datum>;
         dy: ConstantAccessor<number, Datum>;
-        dodgeX: import("../transforms/dodge").DodgeXOptions;
-        dodgeY: import("../transforms/dodge").DodgeYOptions;
+        dodgeX: usePlot;
+        dodgeY: usePlot;
         fill: ChannelAccessor<Datum>;
         fillOpacity: ConstantAccessor<number, Datum>;
-        sort: ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | {
+        sort: {
             channel: string;
             order?: "ascending" | "descending";
-        } | ConstantAccessor<import("../types/data").RawValue, Datum>;
+        } | ((a: import("../types/data").RawValue, b: import("../types/data").RawValue) => number) | ConstantAccessor<import("../types/data").RawValue, Datum>;
         stroke: ChannelAccessor<Datum>;
         strokeWidth: ConstantAccessor<number, Datum>;
         strokeOpacity: ConstantAccessor<number, Datum>;
@@ -64,14 +65,15 @@ declare function $$render<Datum extends DataRow>(): {
         style: string;
         cursor: ConstantAccessor<import("csstype").Property.Cursor, Datum>;
     }>, "fill" | "fillOpacity"> & {
+        /** the input data array; each element becomes one horizontal tick */
         data: Datum[];
         /**
-         * the vertical position; bound to the x scale
+         * the vertical position; bound to the y scale
          */
         y?: ChannelAccessor<Datum>;
         /**
-         * the horizontal position; bound to the y scale, which must be band. If the y channel
-         * is not specified, the tick will span the full vertical extent of the frame.
+         * the horizontal position; bound to the x scale, which must be band. If the x channel
+         * is not specified, the tick will span the full horizontal extent of the frame.
          */
         x?: ChannelAccessor<Datum>;
         /**
@@ -79,6 +81,7 @@ declare function $$render<Datum extends DataRow>(): {
          * length of the tick. Defaults to 10 pixel
          */
         tickLength?: ConstantAccessor<number, Datum>;
+        /** if true, renders using Canvas instead of SVG */
         canvas?: boolean;
     };
     exports: {};