@jspsych-contrib/plugin-trail-making 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,341 @@
+import { JsPsychPlugin, ParameterType, JsPsych, TrialType } from 'jspsych';
+
+declare const info: {
+    readonly name: "trail-making";
+    readonly version: string;
+    readonly parameters: {
+        /**
+         * The type of trail making test to run.
+         * "A" = numbers only (1-2-3-4...)
+         * "B" = alternating numbers and letters (1-A-2-B-3-C...)
+         */
+        readonly test_type: {
+            readonly type: ParameterType.STRING;
+            readonly default: "A";
+        };
+        /**
+         * The number of targets to display. For type "B", this should be an even number
+         * to have equal numbers and letters.
+         */
+        readonly num_targets: {
+            readonly type: ParameterType.INT;
+            readonly default: 25;
+        };
+        /**
+         * The width of the display area in pixels.
+         */
+        readonly canvas_width: {
+            readonly type: ParameterType.INT;
+            readonly default: 600;
+        };
+        /**
+         * The height of the display area in pixels.
+         */
+        readonly canvas_height: {
+            readonly type: ParameterType.INT;
+            readonly default: 600;
+        };
+        /**
+         * The radius of each target circle in pixels.
+         */
+        readonly target_radius: {
+            readonly type: ParameterType.INT;
+            readonly default: 25;
+        };
+        /**
+         * The minimum distance between target centers in pixels.
+         */
+        readonly min_separation: {
+            readonly type: ParameterType.INT;
+            readonly default: 80;
+        };
+        /**
+         * The color of unvisited target circles.
+         */
+        readonly target_color: {
+            readonly type: ParameterType.STRING;
+            readonly default: "#ffffff";
+        };
+        /**
+         * The border color of target circles.
+         */
+        readonly target_border_color: {
+            readonly type: ParameterType.STRING;
+            readonly default: "#000000";
+        };
+        /**
+         * The color of visited (correctly clicked) target circles.
+         */
+        readonly visited_color: {
+            readonly type: ParameterType.STRING;
+            readonly default: "#90EE90";
+        };
+        /**
+         * The color of the line connecting targets.
+         */
+        readonly line_color: {
+            readonly type: ParameterType.STRING;
+            readonly default: "#000000";
+        };
+        /**
+         * The width of the connecting line in pixels.
+         */
+        readonly line_width: {
+            readonly type: ParameterType.INT;
+            readonly default: 2;
+        };
+        /**
+         * The color to flash when an error is made.
+         */
+        readonly error_color: {
+            readonly type: ParameterType.STRING;
+            readonly default: "#FF6B6B";
+        };
+        /**
+         * Duration in milliseconds to show error feedback.
+         */
+        readonly error_duration: {
+            readonly type: ParameterType.INT;
+            readonly default: 500;
+        };
+        /**
+         * Optional array of {x, y, label} objects to specify exact target positions.
+         * If provided, overrides num_targets and random positioning.
+         * Coordinates are in pixels from top-left of canvas.
+         */
+        readonly targets: {
+            readonly type: ParameterType.COMPLEX;
+            readonly default: any;
+        };
+        /**
+         * Text prompt displayed above the canvas.
+         */
+        readonly prompt: {
+            readonly type: ParameterType.HTML_STRING;
+            readonly default: any;
+        };
+        /**
+         * Random seed for reproducible target layouts. If null, uses random seed.
+         */
+        readonly seed: {
+            readonly type: ParameterType.INT;
+            readonly default: any;
+        };
+    };
+    readonly data: {
+        /** The type of trail making test ("A" or "B"). */
+        readonly test_type: {
+            readonly type: ParameterType.STRING;
+        };
+        /** Array of target objects with x, y, and label properties. */
+        readonly targets: {
+            readonly type: ParameterType.COMPLEX;
+            readonly array: true;
+        };
+        /** Array of click events with target_index, label, time, x, y, and correct properties. */
+        readonly clicks: {
+            readonly type: ParameterType.COMPLEX;
+            readonly array: true;
+        };
+        /** Total time in milliseconds from first click to last correct click. */
+        readonly completion_time: {
+            readonly type: ParameterType.INT;
+        };
+        /** Number of errors (incorrect clicks). */
+        readonly num_errors: {
+            readonly type: ParameterType.INT;
+        };
+        /** Total path distance in pixels (sum of distances between consecutive correct targets). */
+        readonly total_path_distance: {
+            readonly type: ParameterType.FLOAT;
+        };
+        /** Array of response times between consecutive correct clicks. */
+        readonly inter_click_times: {
+            readonly type: ParameterType.INT;
+            readonly array: true;
+        };
+    };
+};
+type Info = typeof info;
+/**
+ * **trail-making**
+ *
+ * A jsPsych plugin for the Trail Making Test (TMT), a neuropsychological test of
+ * visual attention and task switching. Participants connect circles in sequence
+ * as quickly as possible.
+ *
+ * Part A: Connect numbers in order (1-2-3-4...)
+ * Part B: Alternate between numbers and letters (1-A-2-B-3-C...)
+ *
+ * @author Josh de Leeuw
+ * @see {@link https://github.com/jspsych/jspsych-contrib/tree/main/packages/plugin-trail-making}
+ */
+declare class TrailMakingPlugin implements JsPsychPlugin<Info> {
+    private jsPsych;
+    static info: {
+        readonly name: "trail-making";
+        readonly version: string;
+        readonly parameters: {
+            /**
+             * The type of trail making test to run.
+             * "A" = numbers only (1-2-3-4...)
+             * "B" = alternating numbers and letters (1-A-2-B-3-C...)
+             */
+            readonly test_type: {
+                readonly type: ParameterType.STRING;
+                readonly default: "A";
+            };
+            /**
+             * The number of targets to display. For type "B", this should be an even number
+             * to have equal numbers and letters.
+             */
+            readonly num_targets: {
+                readonly type: ParameterType.INT;
+                readonly default: 25;
+            };
+            /**
+             * The width of the display area in pixels.
+             */
+            readonly canvas_width: {
+                readonly type: ParameterType.INT;
+                readonly default: 600;
+            };
+            /**
+             * The height of the display area in pixels.
+             */
+            readonly canvas_height: {
+                readonly type: ParameterType.INT;
+                readonly default: 600;
+            };
+            /**
+             * The radius of each target circle in pixels.
+             */
+            readonly target_radius: {
+                readonly type: ParameterType.INT;
+                readonly default: 25;
+            };
+            /**
+             * The minimum distance between target centers in pixels.
+             */
+            readonly min_separation: {
+                readonly type: ParameterType.INT;
+                readonly default: 80;
+            };
+            /**
+             * The color of unvisited target circles.
+             */
+            readonly target_color: {
+                readonly type: ParameterType.STRING;
+                readonly default: "#ffffff";
+            };
+            /**
+             * The border color of target circles.
+             */
+            readonly target_border_color: {
+                readonly type: ParameterType.STRING;
+                readonly default: "#000000";
+            };
+            /**
+             * The color of visited (correctly clicked) target circles.
+             */
+            readonly visited_color: {
+                readonly type: ParameterType.STRING;
+                readonly default: "#90EE90";
+            };
+            /**
+             * The color of the line connecting targets.
+             */
+            readonly line_color: {
+                readonly type: ParameterType.STRING;
+                readonly default: "#000000";
+            };
+            /**
+             * The width of the connecting line in pixels.
+             */
+            readonly line_width: {
+                readonly type: ParameterType.INT;
+                readonly default: 2;
+            };
+            /**
+             * The color to flash when an error is made.
+             */
+            readonly error_color: {
+                readonly type: ParameterType.STRING;
+                readonly default: "#FF6B6B";
+            };
+            /**
+             * Duration in milliseconds to show error feedback.
+             */
+            readonly error_duration: {
+                readonly type: ParameterType.INT;
+                readonly default: 500;
+            };
+            /**
+             * Optional array of {x, y, label} objects to specify exact target positions.
+             * If provided, overrides num_targets and random positioning.
+             * Coordinates are in pixels from top-left of canvas.
+             */
+            readonly targets: {
+                readonly type: ParameterType.COMPLEX;
+                readonly default: any;
+            };
+            /**
+             * Text prompt displayed above the canvas.
+             */
+            readonly prompt: {
+                readonly type: ParameterType.HTML_STRING;
+                readonly default: any;
+            };
+            /**
+             * Random seed for reproducible target layouts. If null, uses random seed.
+             */
+            readonly seed: {
+                readonly type: ParameterType.INT;
+                readonly default: any;
+            };
+        };
+        readonly data: {
+            /** The type of trail making test ("A" or "B"). */
+            readonly test_type: {
+                readonly type: ParameterType.STRING;
+            };
+            /** Array of target objects with x, y, and label properties. */
+            readonly targets: {
+                readonly type: ParameterType.COMPLEX;
+                readonly array: true;
+            };
+            /** Array of click events with target_index, label, time, x, y, and correct properties. */
+            readonly clicks: {
+                readonly type: ParameterType.COMPLEX;
+                readonly array: true;
+            };
+            /** Total time in milliseconds from first click to last correct click. */
+            readonly completion_time: {
+                readonly type: ParameterType.INT;
+            };
+            /** Number of errors (incorrect clicks). */
+            readonly num_errors: {
+                readonly type: ParameterType.INT;
+            };
+            /** Total path distance in pixels (sum of distances between consecutive correct targets). */
+            readonly total_path_distance: {
+                readonly type: ParameterType.FLOAT;
+            };
+            /** Array of response times between consecutive correct clicks. */
+            readonly inter_click_times: {
+                readonly type: ParameterType.INT;
+                readonly array: true;
+            };
+        };
+    };
+    constructor(jsPsych: JsPsych);
+    trial(display_element: HTMLElement, trial: TrialType<Info>): void;
+    private generateTargets;
+    private generateLabels;
+    private getCorrectSequence;
+    private findClickedTarget;
+    private drawCanvas;
+    private endTrial;
+}
+
+export { TrailMakingPlugin as default };