@kabel-project/kabel 1.0.7 → 1.0.8

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 +4 -1
  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,624 +0,0 @@
1
- [**Kabel Project Docs v1.0.6**](../README.md)
2
-
3
- ***
4
-
5
- [Kabel Project Docs](../globals.md) / OptConnectField
6
-
7
- # Class: OptConnectField
8
-
9
- Defined in: [src/field.ts:382](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L382)
10
-
11
- Optional connectable field.
12
- Can store either a number or string depending on fld_type.
13
-
14
- ## Extends
15
-
16
- - [`ConnectableField`](ConnectableField.md)\<`number` \| `string` \| [`NodeSvg`](NodeSvg.md)\>
17
-
18
- ## Constructors
19
-
20
- ### Constructor
21
-
22
- > **new OptConnectField**(): `OptConnectField`
23
-
24
- Defined in: [src/field.ts:385](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L385)
25
-
26
- #### Returns
27
-
28
- `OptConnectField`
29
-
30
- #### Overrides
31
-
32
- [`ConnectableField`](ConnectableField.md).[`constructor`](ConnectableField.md#constructor)
33
-
34
- ## Properties
35
-
36
- ### connection
37
-
38
- > **connection**: [`Connection`](Connection.md)
39
-
40
- Defined in: [src/field.ts:298](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L298)
41
-
42
- #### Inherited from
43
-
44
- [`ConnectableField`](ConnectableField.md).[`connection`](ConnectableField.md#connection)
45
-
46
- ***
47
-
48
- ### editable
49
-
50
- > **editable**: `boolean`
51
-
52
- Defined in: [src/field.ts:49](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L49)
53
-
54
- #### Inherited from
55
-
56
- [`ConnectableField`](ConnectableField.md).[`editable`](ConnectableField.md#editable)
57
-
58
- ***
59
-
60
- ### fldType
61
-
62
- > **fldType**: `"string"` \| `"number"`
63
-
64
- Defined in: [src/field.ts:383](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L383)
65
-
66
- ***
67
-
68
- ### label
69
-
70
- > **label**: `string`
71
-
72
- Defined in: [src/field.ts:45](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L45)
73
-
74
- #### Inherited from
75
-
76
- [`ConnectableField`](ConnectableField.md).[`label`](ConnectableField.md#label)
77
-
78
- ***
79
-
80
- ### name
81
-
82
- > **name**: `string`
83
-
84
- Defined in: [src/field.ts:46](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L46)
85
-
86
- #### Inherited from
87
-
88
- [`ConnectableField`](ConnectableField.md).[`name`](ConnectableField.md#name)
89
-
90
- ***
91
-
92
- ### node?
93
-
94
- > `optional` **node**: [`NodeSvg`](NodeSvg.md)
95
-
96
- Defined in: [src/field.ts:48](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L48)
97
-
98
- #### Inherited from
99
-
100
- [`ConnectableField`](ConnectableField.md).[`node`](ConnectableField.md#node)
101
-
102
- ***
103
-
104
- ### svgGroup?
105
-
106
- > `optional` **svgGroup**: `G`
107
-
108
- Defined in: [src/field.ts:50](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L50)
109
-
110
- #### Inherited from
111
-
112
- [`ConnectableField`](ConnectableField.md).[`svgGroup`](ConnectableField.md#svggroup)
113
-
114
- ***
115
-
116
- ### type
117
-
118
- > **type**: `string`
119
-
120
- Defined in: [src/field.ts:47](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L47)
121
-
122
- #### Inherited from
123
-
124
- [`ConnectableField`](ConnectableField.md).[`type`](ConnectableField.md#type)
125
-
126
- ***
127
-
128
- ### value
129
-
130
- > `protected` **value**: `string` \| `number` \| [`NodeSvg`](NodeSvg.md) \| `null`
131
-
132
- Defined in: [src/field.ts:51](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L51)
133
-
134
- #### Inherited from
135
-
136
- [`ConnectableField`](ConnectableField.md).[`value`](ConnectableField.md#value)
137
-
138
- ## Methods
139
-
140
- ### canEdit()
141
-
142
- > **canEdit**(): `boolean`
143
-
144
- Defined in: [src/field.ts:392](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L392)
145
-
146
- Ask whether or not we can edit this field.
147
-
148
- #### Returns
149
-
150
- `boolean`
151
-
152
- #### Overrides
153
-
154
- [`ConnectableField`](ConnectableField.md).[`canEdit`](ConnectableField.md#canedit)
155
-
156
- ***
157
-
158
- ### canEditConnector()
159
-
160
- > **canEditConnector**(): `boolean`
161
-
162
- Defined in: [src/field.ts:389](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L389)
163
-
164
- #### Returns
165
-
166
- `boolean`
167
-
168
- #### Overrides
169
-
170
- [`ConnectableField`](ConnectableField.md).[`canEditConnector`](ConnectableField.md#caneditconnector)
171
-
172
- ***
173
-
174
- ### disconnect()
175
-
176
- > **disconnect**(): `void`
177
-
178
- Defined in: [src/field.ts:314](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L314)
179
-
180
- Disconnect this field from any connected Connectable
181
-
182
- #### Returns
183
-
184
- `void`
185
-
186
- #### Inherited from
187
-
188
- [`ConnectableField`](ConnectableField.md).[`disconnect`](ConnectableField.md#disconnect)
189
-
190
- ***
191
-
192
- ### drawMyself()
193
-
194
- > **drawMyself**(`fieldVisualInfo`): `void`
195
-
196
- Defined in: [src/field.ts:139](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L139)
197
-
198
- Make the input's custom look.
199
-
200
- #### Parameters
201
-
202
- ##### fieldVisualInfo
203
-
204
- [`FieldVisualInfo`](../interfaces/FieldVisualInfo.md)
205
-
206
- The visual info of the field, mutate this if needed.
207
-
208
- #### Returns
209
-
210
- `void`
211
-
212
- #### Inherited from
213
-
214
- [`ConnectableField`](ConnectableField.md).[`drawMyself`](ConnectableField.md#drawmyself)
215
-
216
- ***
217
-
218
- ### fromJson()
219
-
220
- > **fromJson**(`json`, `workspace?`): `OptConnectField`
221
-
222
- Defined in: [src/field.ts:422](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L422)
223
-
224
- Initialize from JSON, respecting fld_type
225
-
226
- #### Parameters
227
-
228
- ##### json
229
-
230
- [`FieldOptions`](../interfaces/FieldOptions.md)
231
-
232
- FieldOptions
233
-
234
- ##### workspace?
235
-
236
- [`WorkspaceSvg`](WorkspaceSvg.md)
237
-
238
- #### Returns
239
-
240
- `OptConnectField`
241
-
242
- #### Overrides
243
-
244
- [`ConnectableField`](ConnectableField.md).[`fromJson`](ConnectableField.md#fromjson)
245
-
246
- ***
247
-
248
- ### getDisplayValue()
249
-
250
- > **getDisplayValue**(): `string`
251
-
252
- Defined in: [src/field.ts:443](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L443)
253
-
254
- #### Returns
255
-
256
- `string`
257
-
258
- Display value for UI purposes (never null)
259
-
260
- #### Overrides
261
-
262
- [`ConnectableField`](ConnectableField.md).[`getDisplayValue`](ConnectableField.md#getdisplayvalue)
263
-
264
- ***
265
-
266
- ### getLabel()
267
-
268
- > **getLabel**(): `string`
269
-
270
- Defined in: [src/field.ts:109](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L109)
271
-
272
- #### Returns
273
-
274
- `string`
275
-
276
- The human-readable label
277
-
278
- #### Inherited from
279
-
280
- [`ConnectableField`](ConnectableField.md).[`getLabel`](ConnectableField.md#getlabel)
281
-
282
- ***
283
-
284
- ### getName()
285
-
286
- > **getName**(): `string`
287
-
288
- Defined in: [src/field.ts:104](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L104)
289
-
290
- #### Returns
291
-
292
- `string`
293
-
294
- The field's name/key
295
-
296
- #### Inherited from
297
-
298
- [`ConnectableField`](ConnectableField.md).[`getName`](ConnectableField.md#getname)
299
-
300
- ***
301
-
302
- ### getValue()
303
-
304
- > **getValue**(): `string` \| `number` \| [`NodeSvg`](NodeSvg.md) \| `null`
305
-
306
- Defined in: [src/field.ts:398](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L398)
307
-
308
- #### Returns
309
-
310
- `string` \| `number` \| [`NodeSvg`](NodeSvg.md) \| `null`
311
-
312
- The stored value
313
-
314
- #### Overrides
315
-
316
- [`ConnectableField`](ConnectableField.md).[`getValue`](ConnectableField.md#getvalue)
317
-
318
- ***
319
-
320
- ### hasConnectable()
321
-
322
- > **hasConnectable**(): `boolean`
323
-
324
- Defined in: [src/field.ts:408](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L408)
325
-
326
- #### Returns
327
-
328
- `boolean`
329
-
330
- Whether this field supports connections
331
-
332
- #### Overrides
333
-
334
- [`ConnectableField`](ConnectableField.md).[`hasConnectable`](ConnectableField.md#hasconnectable)
335
-
336
- ***
337
-
338
- ### hasRaw()
339
-
340
- > **hasRaw**(): `boolean`
341
-
342
- Defined in: [src/field.ts:405](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L405)
343
-
344
- #### Returns
345
-
346
- `boolean`
347
-
348
- Whether this field is a raw value field (text/number)
349
-
350
- #### Overrides
351
-
352
- [`ConnectableField`](ConnectableField.md).[`hasRaw`](ConnectableField.md#hasraw)
353
-
354
- ***
355
-
356
- ### isCustomEditor()
357
-
358
- > **isCustomEditor**(): `boolean`
359
-
360
- Defined in: [src/field.ts:132](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L132)
361
-
362
- #### Returns
363
-
364
- `boolean`
365
-
366
- Whether we have a custom editor/input look
367
-
368
- #### Inherited from
369
-
370
- [`ConnectableField`](ConnectableField.md).[`isCustomEditor`](ConnectableField.md#iscustomeditor)
371
-
372
- ***
373
-
374
- ### measureMyself()
375
-
376
- > **measureMyself**(): `object`
377
-
378
- Defined in: [src/field.ts:143](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L143)
379
-
380
- Return width & height of your field's custom editor
381
-
382
- #### Returns
383
-
384
- `object`
385
-
386
- ##### height
387
-
388
- > **height**: `null` = `null`
389
-
390
- ##### width
391
-
392
- > **width**: `null` = `null`
393
-
394
- #### Inherited from
395
-
396
- [`ConnectableField`](ConnectableField.md).[`measureMyself`](ConnectableField.md#measuremyself)
397
-
398
- ***
399
-
400
- ### onDraw()
401
-
402
- > **onDraw**(`rawBox?`, `connectionBubble?`): `void`
403
-
404
- Defined in: [src/field.ts:61](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L61)
405
-
406
- #### Parameters
407
-
408
- ##### rawBox?
409
-
410
- [`FieldRawBoxData`](../interfaces/FieldRawBoxData.md)
411
-
412
- ##### connectionBubble?
413
-
414
- [`FieldConnectionData`](../interfaces/FieldConnectionData.md)
415
-
416
- #### Returns
417
-
418
- `void`
419
-
420
- #### Inherited from
421
-
422
- [`ConnectableField`](ConnectableField.md).[`onDraw`](ConnectableField.md#ondraw)
423
-
424
- ***
425
-
426
- ### setEditable()
427
-
428
- > **setEditable**(`val`): `void`
429
-
430
- Defined in: [src/field.ts:71](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L71)
431
-
432
- Set whether or not you can edit this field.
433
-
434
- #### Parameters
435
-
436
- ##### val
437
-
438
- `boolean`
439
-
440
- The value to set to.
441
-
442
- #### Returns
443
-
444
- `void`
445
-
446
- #### Inherited from
447
-
448
- [`ConnectableField`](ConnectableField.md).[`setEditable`](ConnectableField.md#seteditable)
449
-
450
- ***
451
-
452
- ### setFieldType()
453
-
454
- > **setFieldType**(`type`): `void`
455
-
456
- Defined in: [src/field.ts:415](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L415)
457
-
458
- Set field type.
459
-
460
- #### Parameters
461
-
462
- ##### type
463
-
464
- "number"|"string"
465
-
466
- `"string"` | `"number"`
467
-
468
- #### Returns
469
-
470
- `void`
471
-
472
- ***
473
-
474
- ### setLabel()
475
-
476
- > **setLabel**(`label`): `string`
477
-
478
- Defined in: [src/field.ts:118](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L118)
479
-
480
- Set the human-readable label
481
-
482
- #### Parameters
483
-
484
- ##### label
485
-
486
- `string`
487
-
488
- New label
489
-
490
- #### Returns
491
-
492
- `string`
493
-
494
- The updated label
495
-
496
- #### Inherited from
497
-
498
- [`ConnectableField`](ConnectableField.md).[`setLabel`](ConnectableField.md#setlabel)
499
-
500
- ***
501
-
502
- ### setName()
503
-
504
- > **setName**(`name`): `string`
505
-
506
- Defined in: [src/field.ts:88](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L88)
507
-
508
- Set field name to something else.
509
-
510
- #### Parameters
511
-
512
- ##### name
513
-
514
- `string`
515
-
516
- string
517
-
518
- #### Returns
519
-
520
- `string`
521
-
522
- the new name.
523
-
524
- #### Inherited from
525
-
526
- [`ConnectableField`](ConnectableField.md).[`setName`](ConnectableField.md#setname)
527
-
528
- ***
529
-
530
- ### setValue()
531
-
532
- > **setValue**(`val`): `void`
533
-
534
- Defined in: [src/field.ts:435](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L435)
535
-
536
- Set the value, converting to number or string depending on fld_type
537
-
538
- #### Parameters
539
-
540
- ##### val
541
-
542
- The new value
543
-
544
- `string` | `number`
545
-
546
- #### Returns
547
-
548
- `void`
549
-
550
- #### Overrides
551
-
552
- [`ConnectableField`](ConnectableField.md).[`setValue`](ConnectableField.md#setvalue)
553
-
554
- ***
555
-
556
- ### toJson()
557
-
558
- > **toJson**(`deep`, `alreadyProcessed`): [`FieldOptions`](../interfaces/FieldOptions.md)
559
-
560
- Defined in: [src/field.ts:448](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L448)
561
-
562
- #### Parameters
563
-
564
- ##### deep
565
-
566
- `boolean`
567
-
568
- ##### alreadyProcessed
569
-
570
- #### Returns
571
-
572
- [`FieldOptions`](../interfaces/FieldOptions.md)
573
-
574
- #### Overrides
575
-
576
- [`ConnectableField`](ConnectableField.md).[`toJson`](ConnectableField.md#tojson)
577
-
578
- ***
579
-
580
- ### register()
581
-
582
- > `static` **register**(`name`, `cls`): `void`
583
-
584
- Defined in: [src/field.ts:52](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L52)
585
-
586
- #### Parameters
587
-
588
- ##### name
589
-
590
- `string`
591
-
592
- ##### cls
593
-
594
- `Function`
595
-
596
- #### Returns
597
-
598
- `void`
599
-
600
- #### Inherited from
601
-
602
- [`ConnectableField`](ConnectableField.md).[`register`](ConnectableField.md#register)
603
-
604
- ***
605
-
606
- ### unregister()
607
-
608
- > `static` **unregister**(`name`): `void`
609
-
610
- Defined in: [src/field.ts:53](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L53)
611
-
612
- #### Parameters
613
-
614
- ##### name
615
-
616
- `string`
617
-
618
- #### Returns
619
-
620
- `void`
621
-
622
- #### Inherited from
623
-
624
- [`ConnectableField`](ConnectableField.md).[`unregister`](ConnectableField.md#unregister)