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