@kabel-project/kabel 1.0.7 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (273) hide show
  1. package/dist/comment-renderer/renderer.d.ts +32 -0
  2. package/dist/comment-renderer/renderer.d.ts.map +1 -0
  3. package/dist/controllers/base.d.ts +39 -0
  4. package/dist/controllers/base.d.ts.map +1 -0
  5. package/dist/controllers/wasd.d.ts +33 -0
  6. package/dist/controllers/wasd.d.ts.map +1 -0
  7. package/dist/events/comment-drag-handle.d.ts +2 -0
  8. package/dist/events/comment-drag-handle.d.ts.map +1 -0
  9. package/dist/events/comment-input.d.ts +4 -0
  10. package/dist/events/comment-input.d.ts.map +1 -0
  11. package/dist/events/connection-line.d.ts +2 -0
  12. package/dist/events/connection-line.d.ts.map +1 -0
  13. package/dist/events/connector.d.ts +2 -0
  14. package/dist/events/connector.d.ts.map +1 -0
  15. package/dist/events/draggable.d.ts +2 -0
  16. package/dist/events/draggable.d.ts.map +1 -0
  17. package/{events/events.ts → dist/events/events.d.ts} +8 -7
  18. package/dist/events/events.d.ts.map +1 -0
  19. package/dist/events/input-box.d.ts +2 -0
  20. package/dist/events/input-box.d.ts.map +1 -0
  21. package/dist/events/node-x-btn.d.ts +2 -0
  22. package/dist/events/node-x-btn.d.ts.map +1 -0
  23. package/dist/kabel.js +2 -0
  24. package/dist/kabel.js.map +1 -0
  25. package/dist/renderers/apollo/apollo.d.ts +12 -0
  26. package/dist/renderers/apollo/apollo.d.ts.map +1 -0
  27. package/dist/renderers/apollo/constants.d.ts +21 -0
  28. package/dist/renderers/apollo/constants.d.ts.map +1 -0
  29. package/dist/renderers/apollo/renderer.d.ts +97 -0
  30. package/dist/renderers/apollo/renderer.d.ts.map +1 -0
  31. package/{renderers/atlas/atlas.ts → dist/renderers/atlas/atlas.d.ts} +6 -15
  32. package/dist/renderers/atlas/atlas.d.ts.map +1 -0
  33. package/dist/renderers/constants.d.ts +51 -0
  34. package/dist/renderers/constants.d.ts.map +1 -0
  35. package/dist/renderers/renderer.d.ts +470 -0
  36. package/dist/renderers/renderer.d.ts.map +1 -0
  37. package/dist/renderers/representer-node.d.ts +27 -0
  38. package/dist/renderers/representer-node.d.ts.map +1 -0
  39. package/dist/renderers/representer.d.ts +13 -0
  40. package/dist/renderers/representer.d.ts.map +1 -0
  41. package/dist/src/category.d.ts +48 -0
  42. package/dist/src/category.d.ts.map +1 -0
  43. package/{src/colors.ts → dist/src/colors.d.ts} +21 -20
  44. package/dist/src/colors.d.ts.map +1 -0
  45. package/dist/src/comment.d.ts +88 -0
  46. package/dist/src/comment.d.ts.map +1 -0
  47. package/dist/src/connection.d.ts +52 -0
  48. package/dist/src/connection.d.ts.map +1 -0
  49. package/dist/src/context-menu.d.ts +76 -0
  50. package/dist/src/context-menu.d.ts.map +1 -0
  51. package/dist/src/coordinates.d.ts +52 -0
  52. package/dist/src/coordinates.d.ts.map +1 -0
  53. package/dist/src/core.d.ts +153 -0
  54. package/dist/src/core.d.ts.map +1 -0
  55. package/dist/src/ctx-menu-registry.d.ts +22 -0
  56. package/dist/src/ctx-menu-registry.d.ts.map +1 -0
  57. package/dist/src/dropdown-menu.d.ts +87 -0
  58. package/dist/src/dropdown-menu.d.ts.map +1 -0
  59. package/dist/src/field.d.ts +305 -0
  60. package/dist/src/field.d.ts.map +1 -0
  61. package/dist/src/flyout.d.ts +41 -0
  62. package/dist/src/flyout.d.ts.map +1 -0
  63. package/dist/src/fonts-manager.d.ts +6 -0
  64. package/dist/src/fonts-manager.d.ts.map +1 -0
  65. package/dist/src/grid.d.ts +60 -0
  66. package/dist/src/grid.d.ts.map +1 -0
  67. package/dist/src/headless-node.d.ts +11 -0
  68. package/dist/src/headless-node.d.ts.map +1 -0
  69. package/dist/src/index.d.ts +38 -0
  70. package/dist/src/index.d.ts.map +1 -0
  71. package/dist/src/inject-headless.d.ts +4 -0
  72. package/dist/src/inject-headless.d.ts.map +1 -0
  73. package/{src/inject.ts → dist/src/inject.d.ts} +142 -213
  74. package/dist/src/inject.d.ts.map +1 -0
  75. package/{src/main-workspace.ts → dist/src/main-workspace.d.ts} +31 -51
  76. package/dist/src/main-workspace.d.ts.map +1 -0
  77. package/dist/src/mutator.d.ts +2 -0
  78. package/dist/src/mutator.d.ts.map +1 -0
  79. package/{src/node-types.ts → dist/src/node-types.d.ts} +26 -27
  80. package/dist/src/node-types.d.ts.map +1 -0
  81. package/dist/src/nodesvg.d.ts +266 -0
  82. package/dist/src/nodesvg.d.ts.map +1 -0
  83. package/{src/prototypes.ts → dist/src/prototypes.d.ts} +10 -9
  84. package/dist/src/prototypes.d.ts.map +1 -0
  85. package/{src/renderer-map.ts → dist/src/renderer-map.d.ts} +51 -86
  86. package/dist/src/renderer-map.d.ts.map +1 -0
  87. package/dist/src/toolbox.d.ts +51 -0
  88. package/dist/src/toolbox.d.ts.map +1 -0
  89. package/{src/types.ts → dist/src/types.d.ts} +159 -205
  90. package/dist/src/types.d.ts.map +1 -0
  91. package/dist/src/undo-redo.d.ts +15 -0
  92. package/dist/src/undo-redo.d.ts.map +1 -0
  93. package/{src/visual-types.ts → dist/src/visual-types.d.ts} +34 -29
  94. package/dist/src/visual-types.d.ts.map +1 -0
  95. package/dist/src/widget-prototypes.d.ts +10 -0
  96. package/dist/src/widget-prototypes.d.ts.map +1 -0
  97. package/dist/src/widget.d.ts +62 -0
  98. package/dist/src/widget.d.ts.map +1 -0
  99. package/{src/workspace-coords.ts → dist/src/workspace-coords.d.ts} +10 -14
  100. package/dist/src/workspace-coords.d.ts.map +1 -0
  101. package/dist/src/workspace-svg.d.ts +371 -0
  102. package/dist/src/workspace-svg.d.ts.map +1 -0
  103. package/dist/src/workspace.d.ts +50 -0
  104. package/dist/src/workspace.d.ts.map +1 -0
  105. package/dist/themes/dark.d.ts +4 -0
  106. package/dist/themes/dark.d.ts.map +1 -0
  107. package/dist/themes/default.d.ts +4 -0
  108. package/dist/themes/default.d.ts.map +1 -0
  109. package/dist/themes/themes.d.ts +6 -0
  110. package/dist/themes/themes.d.ts.map +1 -0
  111. package/dist/util/emitter.d.ts +10 -0
  112. package/dist/util/emitter.d.ts.map +1 -0
  113. package/dist/util/env.d.ts +7 -0
  114. package/dist/util/env.d.ts.map +1 -0
  115. package/{util/escape-html.ts → dist/util/escape-html.d.ts} +16 -22
  116. package/dist/util/escape-html.d.ts.map +1 -0
  117. package/dist/util/eventer.d.ts +29 -0
  118. package/dist/util/eventer.d.ts.map +1 -0
  119. package/dist/util/has-prop.d.ts +2 -0
  120. package/dist/util/has-prop.d.ts.map +1 -0
  121. package/dist/util/parse-color.d.ts +6 -0
  122. package/dist/util/parse-color.d.ts.map +1 -0
  123. package/dist/util/path.d.ts +25 -0
  124. package/dist/util/path.d.ts.map +1 -0
  125. package/dist/util/styler.d.ts +12 -0
  126. package/dist/util/styler.d.ts.map +1 -0
  127. package/dist/util/uid.d.ts +42 -0
  128. package/dist/util/uid.d.ts.map +1 -0
  129. package/{util/unescape-html.ts → dist/util/unescape-html.d.ts} +16 -22
  130. package/dist/util/unescape-html.d.ts.map +1 -0
  131. package/dist/util/user-state.d.ts +37 -0
  132. package/dist/util/user-state.d.ts.map +1 -0
  133. package/{util/wait-anim-frames.ts → dist/util/wait-anim-frames.d.ts} +11 -24
  134. package/dist/util/wait-anim-frames.d.ts.map +1 -0
  135. package/dist/util/window-listeners.d.ts +8 -0
  136. package/dist/util/window-listeners.d.ts.map +1 -0
  137. package/package.json +5 -2
  138. package/(1.0.7)kabel.md +0 -18
  139. package/_READ_ME_MEDIA_/documentation/docs.md +0 -293
  140. package/_READ_ME_MEDIA_/workspace.png +0 -0
  141. package/comment-renderer/renderer.ts +0 -228
  142. package/controllers/base.ts +0 -186
  143. package/controllers/wasd.ts +0 -132
  144. package/docs/README.md +0 -98
  145. package/docs/_media/docs.md +0 -289
  146. package/docs/_media/workspace.png +0 -0
  147. package/docs/classes/CommentModel.md +0 -271
  148. package/docs/classes/CommentRenderer.md +0 -457
  149. package/docs/classes/ConnectableField.md +0 -597
  150. package/docs/classes/Connection.md +0 -191
  151. package/docs/classes/ContextMenuHTML.md +0 -163
  152. package/docs/classes/Coordinates.md +0 -187
  153. package/docs/classes/DropdownContainer.md +0 -300
  154. package/docs/classes/DummyField.md +0 -393
  155. package/docs/classes/Eventer.md +0 -185
  156. package/docs/classes/Field.md +0 -461
  157. package/docs/classes/InjectMsg.md +0 -85
  158. package/docs/classes/NodeSvg.md +0 -1011
  159. package/docs/classes/NumberField.md +0 -559
  160. package/docs/classes/OptConnectField.md +0 -624
  161. package/docs/classes/Renderer.md +0 -1636
  162. package/docs/classes/RendererConstants.md +0 -343
  163. package/docs/classes/Representer.md +0 -95
  164. package/docs/classes/RepresenterNode.md +0 -175
  165. package/docs/classes/TextField.md +0 -559
  166. package/docs/classes/Toolbox.md +0 -172
  167. package/docs/classes/WASDController.md +0 -616
  168. package/docs/classes/Widget.md +0 -195
  169. package/docs/classes/WorkspaceController.md +0 -385
  170. package/docs/classes/WorkspaceCoords.md +0 -218
  171. package/docs/classes/WorkspaceSvg.md +0 -1380
  172. package/docs/functions/clearMainWorkspace.md +0 -20
  173. package/docs/functions/getMainWorkspace.md +0 -19
  174. package/docs/functions/inject.md +0 -35
  175. package/docs/functions/setMainWorkspace.md +0 -28
  176. package/docs/globals.md +0 -95
  177. package/docs/interfaces/ColorStyle.md +0 -43
  178. package/docs/interfaces/ConnectorToFrom.md +0 -57
  179. package/docs/interfaces/DrawState.md +0 -81
  180. package/docs/interfaces/FieldConnectionData.md +0 -25
  181. package/docs/interfaces/FieldOptions.md +0 -63
  182. package/docs/interfaces/FieldRawBoxData.md +0 -25
  183. package/docs/interfaces/FieldVisualInfo.md +0 -65
  184. package/docs/interfaces/GridOptions.md +0 -61
  185. package/docs/interfaces/InjectOptions.md +0 -133
  186. package/docs/interfaces/InputFieldJson.md +0 -50
  187. package/docs/interfaces/KabelCommentRendering.md +0 -31
  188. package/docs/interfaces/KabelInterface.md +0 -469
  189. package/docs/interfaces/KabelNodeRendering.md +0 -77
  190. package/docs/interfaces/KabelUIX.md +0 -105
  191. package/docs/interfaces/KabelUtils.md +0 -215
  192. package/docs/interfaces/NodeEvents.md +0 -42
  193. package/docs/interfaces/NodeJson.md +0 -104
  194. package/docs/interfaces/NodePrototype.md +0 -82
  195. package/docs/interfaces/RegisteredEl.md +0 -53
  196. package/docs/interfaces/SerializedNode.md +0 -128
  197. package/docs/interfaces/TblxCategoryStruct.md +0 -41
  198. package/docs/interfaces/TblxFieldStruct.md +0 -28
  199. package/docs/interfaces/TblxNodeStruct.md +0 -35
  200. package/docs/interfaces/WidgetOptions.md +0 -115
  201. package/docs/interfaces/WidgetPrototypeList.md +0 -15
  202. package/docs/type-aliases/AnyField.md +0 -13
  203. package/docs/type-aliases/AnyFieldCls.md +0 -13
  204. package/docs/type-aliases/Color.md +0 -13
  205. package/docs/type-aliases/Connectable.md +0 -13
  206. package/docs/type-aliases/EventArgs.md +0 -11
  207. package/docs/type-aliases/EventSetupFn.md +0 -25
  208. package/docs/type-aliases/Hex.md +0 -13
  209. package/docs/type-aliases/RGBObject.md +0 -37
  210. package/docs/type-aliases/RGBString.md +0 -13
  211. package/docs/type-aliases/RGBTuple.md +0 -13
  212. package/docs/type-aliases/TblxObjStruct.md +0 -52
  213. package/docs/variables/CategoryColors.md +0 -29
  214. package/docs/variables/FieldMap.md +0 -41
  215. package/docs/variables/NodePrototypes.md +0 -18
  216. package/docs/variables/default.md +0 -11
  217. package/events/comment-drag-handle.ts +0 -61
  218. package/events/comment-input.ts +0 -291
  219. package/events/connection-line.ts +0 -68
  220. package/events/connector.ts +0 -116
  221. package/events/draggable.ts +0 -119
  222. package/events/input-box.ts +0 -213
  223. package/events/node-x-btn.ts +0 -25
  224. package/index.d.ts +0 -4
  225. package/renderers/apollo/apollo.ts +0 -21
  226. package/renderers/apollo/constants.ts +0 -40
  227. package/renderers/apollo/renderer.ts +0 -331
  228. package/renderers/constants.ts +0 -87
  229. package/renderers/renderer.ts +0 -1288
  230. package/renderers/representer-node.ts +0 -52
  231. package/renderers/representer.ts +0 -25
  232. package/src/category.ts +0 -107
  233. package/src/comment.ts +0 -142
  234. package/src/connection.ts +0 -114
  235. package/src/context-menu.ts +0 -194
  236. package/src/coordinates.ts +0 -74
  237. package/src/core.ts +0 -202
  238. package/src/ctx-menu-registry.ts +0 -143
  239. package/src/dropdown-menu.ts +0 -215
  240. package/src/field.ts +0 -595
  241. package/src/flyout.ts +0 -165
  242. package/src/fonts-manager.ts +0 -38
  243. package/src/grid.ts +0 -162
  244. package/src/headless-node.ts +0 -27
  245. package/src/index.ts +0 -115
  246. package/src/inject-headless.ts +0 -18
  247. package/src/mutator.ts +0 -40
  248. package/src/nodesvg.ts +0 -756
  249. package/src/styles.css +0 -224
  250. package/src/toolbox.ts +0 -125
  251. package/src/undo-redo.ts +0 -87
  252. package/src/widget-prototypes.ts +0 -11
  253. package/src/widget.ts +0 -139
  254. package/src/workspace-svg.ts +0 -736
  255. package/src/workspace.ts +0 -155
  256. package/test-server.js +0 -61
  257. package/themes/dark.ts +0 -32
  258. package/themes/default.ts +0 -28
  259. package/themes/themes.ts +0 -9
  260. package/tsconfig.json +0 -25
  261. package/typedoc.json +0 -10
  262. package/util/emitter.ts +0 -33
  263. package/util/env.ts +0 -11
  264. package/util/eventer.ts +0 -108
  265. package/util/has-prop.ts +0 -4
  266. package/util/parse-color.ts +0 -42
  267. package/util/path.ts +0 -99
  268. package/util/styler.ts +0 -41
  269. package/util/uid.ts +0 -184
  270. package/util/user-state.ts +0 -68
  271. package/util/window-listeners.ts +0 -62
  272. package/webpack.config.js +0 -80
  273. /package/{docs/_media → dist}/index.html +0 -0
@@ -1,191 +0,0 @@
1
- [**Kabel Project Docs v1.0.6**](../README.md)
2
-
3
- ***
4
-
5
- [Kabel Project Docs](../globals.md) / Connection
6
-
7
- # Class: Connection
8
-
9
- Defined in: [src/connection.ts:12](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L12)
10
-
11
- Represents a connection between two connectable objects.
12
-
13
- ## Constructors
14
-
15
- ### Constructor
16
-
17
- > **new Connection**(`from`, `to`, `isPrevious`): `Connection`
18
-
19
- Defined in: [src/connection.ts:26](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L26)
20
-
21
- Creates a new Connection.
22
-
23
- #### Parameters
24
-
25
- ##### from
26
-
27
- [`Connectable`](../type-aliases/Connectable.md)
28
-
29
- The source NodeSvg or Field
30
-
31
- ##### to
32
-
33
- [`Connectable`](../type-aliases/Connectable.md)
34
-
35
- The target NodeSvg or Field
36
-
37
- ##### isPrevious
38
-
39
- `boolean` = `false`
40
-
41
- True if this connection is a previous connection
42
-
43
- #### Returns
44
-
45
- `Connection`
46
-
47
- ## Properties
48
-
49
- ### from
50
-
51
- > **from**: [`Connectable`](../type-aliases/Connectable.md)
52
-
53
- Defined in: [src/connection.ts:14](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L14)
54
-
55
- The source of the connection
56
-
57
- ***
58
-
59
- ### isPrevious
60
-
61
- > **isPrevious**: `boolean`
62
-
63
- Defined in: [src/connection.ts:18](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L18)
64
-
65
- Whether this connection represents a previous connection (affects rendering/logic)
66
-
67
- ***
68
-
69
- ### to
70
-
71
- > **to**: [`Connectable`](../type-aliases/Connectable.md)
72
-
73
- Defined in: [src/connection.ts:16](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L16)
74
-
75
- The target of the connection
76
-
77
- ## Methods
78
-
79
- ### disconnectFrom()
80
-
81
- > **disconnectFrom**(): `void`
82
-
83
- Defined in: [src/connection.ts:71](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L71)
84
-
85
- Disconnects this connection from its source.
86
- Safely handles NodeSvg chains and ConnectableFields.
87
-
88
- #### Returns
89
-
90
- `void`
91
-
92
- ***
93
-
94
- ### disconnectTo()
95
-
96
- > **disconnectTo**(): `void`
97
-
98
- Defined in: [src/connection.ts:46](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L46)
99
-
100
- Disconnects this connection from its target.
101
- Safely handles NodeSvg chains and ConnectableFields.
102
-
103
- #### Returns
104
-
105
- `void`
106
-
107
- ***
108
-
109
- ### getFrom()
110
-
111
- > **getFrom**(): [`Connectable`](../type-aliases/Connectable.md)
112
-
113
- Defined in: [src/connection.ts:38](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L38)
114
-
115
- Returns the source of the connection
116
-
117
- #### Returns
118
-
119
- [`Connectable`](../type-aliases/Connectable.md)
120
-
121
- ***
122
-
123
- ### getTo()
124
-
125
- > **getTo**(): [`Connectable`](../type-aliases/Connectable.md)
126
-
127
- Defined in: [src/connection.ts:33](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L33)
128
-
129
- Returns the target of the connection
130
-
131
- #### Returns
132
-
133
- [`Connectable`](../type-aliases/Connectable.md)
134
-
135
- ***
136
-
137
- ### isolate()
138
-
139
- > **isolate**(): `void`
140
-
141
- Defined in: [src/connection.ts:108](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L108)
142
-
143
- Completely isolates this connection, clearing both ends
144
-
145
- #### Returns
146
-
147
- `void`
148
-
149
- ***
150
-
151
- ### setFrom()
152
-
153
- > **setFrom**(`source`): `void`
154
-
155
- Defined in: [src/connection.ts:103](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L103)
156
-
157
- Sets the source of this connection (used during deserialization)
158
-
159
- #### Parameters
160
-
161
- ##### source
162
-
163
- [`Connectable`](../type-aliases/Connectable.md)
164
-
165
- New connection source
166
-
167
- #### Returns
168
-
169
- `void`
170
-
171
- ***
172
-
173
- ### setTo()
174
-
175
- > **setTo**(`target`): `void`
176
-
177
- Defined in: [src/connection.ts:95](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L95)
178
-
179
- Sets the target of this connection (used during deserialization)
180
-
181
- #### Parameters
182
-
183
- ##### target
184
-
185
- [`Connectable`](../type-aliases/Connectable.md)
186
-
187
- New connection target
188
-
189
- #### Returns
190
-
191
- `void`
@@ -1,163 +0,0 @@
1
- [**Kabel Project Docs v1.0.6**](../README.md)
2
-
3
- ***
4
-
5
- [Kabel Project Docs](../globals.md) / ContextMenuHTML
6
-
7
- # Class: ContextMenuHTML
8
-
9
- Defined in: [src/context-menu.ts:37](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L37)
10
-
11
- HTML context menu rendered on workspace right-click.
12
-
13
- ## Constructors
14
-
15
- ### Constructor
16
-
17
- > **new ContextMenuHTML**(`workspace`): `ContextMenuHTML`
18
-
19
- Defined in: [src/context-menu.ts:59](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L59)
20
-
21
- Create a new context menu for a workspace.
22
-
23
- #### Parameters
24
-
25
- ##### workspace
26
-
27
- [`WorkspaceSvg`](WorkspaceSvg.md)
28
-
29
- Workspace to attach the context menu to
30
-
31
- #### Returns
32
-
33
- `ContextMenuHTML`
34
-
35
- ## Properties
36
-
37
- ### controller
38
-
39
- > **controller**: [`WorkspaceController`](WorkspaceController.md)
40
-
41
- Defined in: [src/context-menu.ts:45](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L45)
42
-
43
- The workspace's controller
44
-
45
- ***
46
-
47
- ### options
48
-
49
- > **options**: `ContextMenuOpts`[]
50
-
51
- Defined in: [src/context-menu.ts:53](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L53)
52
-
53
- Options for the context menu.
54
-
55
- ***
56
-
57
- ### widget
58
-
59
- > **widget**: [`Widget`](Widget.md)
60
-
61
- Defined in: [src/context-menu.ts:49](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L49)
62
-
63
- The widget in the workspace to display the menu on.
64
-
65
- ***
66
-
67
- ### workspace
68
-
69
- > **workspace**: [`WorkspaceSvg`](WorkspaceSvg.md)
70
-
71
- Defined in: [src/context-menu.ts:41](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L41)
72
-
73
- The workspace.
74
-
75
- ## Accessors
76
-
77
- ### mousePos
78
-
79
- #### Get Signature
80
-
81
- > **get** **mousePos**(): `object`
82
-
83
- Defined in: [src/context-menu.ts:154](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L154)
84
-
85
- Returns the current mouse position in workspace coordinates
86
-
87
- ##### Returns
88
-
89
- `object`
90
-
91
- ###### x
92
-
93
- > **x**: `number`
94
-
95
- ###### y
96
-
97
- > **y**: `number`
98
-
99
- ***
100
-
101
- ### target
102
-
103
- #### Get Signature
104
-
105
- > **get** **target**(): [`NodeSvg`](NodeSvg.md) \| [`WorkspaceSvg`](WorkspaceSvg.md) \| `HTMLElement` \| [`CommentModel`](CommentModel.md) \| `null`
106
-
107
- Defined in: [src/context-menu.ts:161](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L161)
108
-
109
- Returns the target element under the mouse for context menu.
110
-
111
- ##### Returns
112
-
113
- [`NodeSvg`](NodeSvg.md) \| [`WorkspaceSvg`](WorkspaceSvg.md) \| `HTMLElement` \| [`CommentModel`](CommentModel.md) \| `null`
114
-
115
- ## Methods
116
-
117
- ### hide()
118
-
119
- > **hide**(): `void`
120
-
121
- Defined in: [src/context-menu.ts:149](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L149)
122
-
123
- Hides the context menu
124
-
125
- #### Returns
126
-
127
- `void`
128
-
129
- ***
130
-
131
- ### initListeners()
132
-
133
- > **initListeners**(): `void`
134
-
135
- Defined in: [src/context-menu.ts:125](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L125)
136
-
137
- Initializes event listeners for showing/hiding the menu.
138
-
139
- #### Returns
140
-
141
- `void`
142
-
143
- ***
144
-
145
- ### renderOptions()
146
-
147
- > **renderOptions**(`target`): `void`
148
-
149
- Defined in: [src/context-menu.ts:91](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/context-menu.ts#L91)
150
-
151
- Renders context menu options for a given target.
152
-
153
- #### Parameters
154
-
155
- ##### target
156
-
157
- The object the context menu is for
158
-
159
- [`NodeSvg`](NodeSvg.md) | [`WorkspaceSvg`](WorkspaceSvg.md) | `HTMLElement` | [`CommentModel`](CommentModel.md) | `null`
160
-
161
- #### Returns
162
-
163
- `void`
@@ -1,187 +0,0 @@
1
- [**Kabel Project Docs v1.0.6**](../README.md)
2
-
3
- ***
4
-
5
- [Kabel Project Docs](../globals.md) / Coordinates
6
-
7
- # Class: Coordinates
8
-
9
- Defined in: [src/coordinates.ts:4](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L4)
10
-
11
- Represents a 2D coordinate in space.
12
-
13
- ## Extended by
14
-
15
- - [`WorkspaceCoords`](WorkspaceCoords.md)
16
-
17
- ## Constructors
18
-
19
- ### Constructor
20
-
21
- > **new Coordinates**(`x`, `y`): `Coordinates`
22
-
23
- Defined in: [src/coordinates.ts:15](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L15)
24
-
25
- Creates a new Coordinates instance
26
-
27
- #### Parameters
28
-
29
- ##### x
30
-
31
- `number` = `0`
32
-
33
- The x value (default 0)
34
-
35
- ##### y
36
-
37
- `number` = `0`
38
-
39
- The y value (default 0)
40
-
41
- #### Returns
42
-
43
- `Coordinates`
44
-
45
- ## Properties
46
-
47
- ### x
48
-
49
- > **x**: `number`
50
-
51
- Defined in: [src/coordinates.ts:6](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L6)
52
-
53
- X position
54
-
55
- ***
56
-
57
- ### y
58
-
59
- > **y**: `number`
60
-
61
- Defined in: [src/coordinates.ts:8](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L8)
62
-
63
- Y position
64
-
65
- ## Methods
66
-
67
- ### clone()
68
-
69
- > **clone**(): `Coordinates`
70
-
71
- Defined in: [src/coordinates.ts:34](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L34)
72
-
73
- Returns a copy of this coordinate
74
-
75
- #### Returns
76
-
77
- `Coordinates`
78
-
79
- A new Coordinates instance with the same x and y
80
-
81
- ***
82
-
83
- ### distanceTo()
84
-
85
- > **distanceTo**(`other`): `number`
86
-
87
- Defined in: [src/coordinates.ts:43](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L43)
88
-
89
- Calculate the Euclidean distance to another coordinate
90
-
91
- #### Parameters
92
-
93
- ##### other
94
-
95
- `Coordinates`
96
-
97
- The target coordinate
98
-
99
- #### Returns
100
-
101
- `number`
102
-
103
- The distance as a number
104
-
105
- ***
106
-
107
- ### set()
108
-
109
- > **set**(`x`, `y`): `void`
110
-
111
- Defined in: [src/coordinates.ts:25](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L25)
112
-
113
- Set the coordinates to new values
114
-
115
- #### Parameters
116
-
117
- ##### x
118
-
119
- `number`
120
-
121
- The new x value
122
-
123
- ##### y
124
-
125
- `number`
126
-
127
- The new y value
128
-
129
- #### Returns
130
-
131
- `void`
132
-
133
- ***
134
-
135
- ### toArray()
136
-
137
- > **toArray**(): \[`number`, `number`\]
138
-
139
- Defined in: [src/coordinates.ts:61](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L61)
140
-
141
- Convert the coordinate to an array [x, y]
142
-
143
- #### Returns
144
-
145
- \[`number`, `number`\]
146
-
147
- Tuple of numbers [x, y]
148
-
149
- ***
150
-
151
- ### toObject()
152
-
153
- > **toObject**(): `object`
154
-
155
- Defined in: [src/coordinates.ts:69](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L69)
156
-
157
- Convert the coordinate to an object { x, y }
158
-
159
- #### Returns
160
-
161
- `object`
162
-
163
- Object with x and y properties
164
-
165
- ##### x
166
-
167
- > **x**: `number`
168
-
169
- ##### y
170
-
171
- > **y**: `number`
172
-
173
- ***
174
-
175
- ### toString()
176
-
177
- > **toString**(): `string`
178
-
179
- Defined in: [src/coordinates.ts:53](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/coordinates.ts#L53)
180
-
181
- Convert the coordinate to a string representation
182
-
183
- #### Returns
184
-
185
- `string`
186
-
187
- A string like "(x, y)"