Skip to content

Commit 5f877eb

Browse files
committed
fix(Config): add jsdoc for settings Camera.Speed, Camera.Step
1 parent dc30b69 commit 5f877eb

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

packages/graph/src/graphConfig.ts

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,42 @@ export type TGraphConstants = {
107107
};
108108

109109
camera: {
110-
/* Speed camera scale */
110+
/**
111+
* Zoom speed multiplier that affects how fast the camera zooms in/out.
112+
* Higher values make zoom faster, lower values make it slower.
113+
*
114+
* @remarks
115+
* This value is multiplied by STEP and the wheel delta to calculate the zoom change.
116+
* The formula is: `zoom_change = STEP * SPEED * wheel_delta * current_scale`
117+
* where current_scale provides smooth acceleration (zoom is faster when more zoomed in).
118+
*
119+
* @default 1
120+
* @example
121+
* // Double the zoom speed
122+
* SPEED: 2
123+
*
124+
* // Half the zoom speed (smoother, more controlled)
125+
* SPEED: 0.5
126+
*/
111127
SPEED: number;
112-
/* Step on camera scale */
128+
/**
129+
* Base zoom step per mouse wheel tick or trackpad pinch unit.
130+
* This is the fundamental increment of scale change before applying speed multipliers.
131+
*
132+
* @remarks
133+
* This value determines the granularity of zoom changes.
134+
* - Smaller values (e.g., 0.004) result in finer, more gradual zoom
135+
* - Larger values (e.g., 0.016) result in more aggressive, faster zoom
136+
* - Works together with SPEED: `zoom_change = STEP * SPEED * wheel_delta * current_scale`
137+
*
138+
* @default 0.008
139+
* @example
140+
* // Finer zoom control
141+
* STEP: 0.004
142+
*
143+
* // More aggressive zoom
144+
* STEP: 0.016
145+
*/
113146
STEP: number;
114147
/**
115148
* Auto-panning threshold: distance from edge in pixels to activate auto-panning

0 commit comments

Comments
 (0)