@kabel-project/kabel 1.0.7
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.
- package/(1.0.7)kabel.md +18 -0
- package/README.md +96 -0
- package/_READ_ME_MEDIA_/documentation/docs.md +293 -0
- package/_READ_ME_MEDIA_/workspace.png +0 -0
- package/comment-renderer/renderer.ts +228 -0
- package/controllers/base.ts +186 -0
- package/controllers/wasd.ts +132 -0
- package/docs/README.md +98 -0
- package/docs/_media/docs.md +289 -0
- package/docs/_media/index.html +168 -0
- package/docs/_media/workspace.png +0 -0
- package/docs/classes/CommentModel.md +271 -0
- package/docs/classes/CommentRenderer.md +457 -0
- package/docs/classes/ConnectableField.md +597 -0
- package/docs/classes/Connection.md +191 -0
- package/docs/classes/ContextMenuHTML.md +163 -0
- package/docs/classes/Coordinates.md +187 -0
- package/docs/classes/DropdownContainer.md +300 -0
- package/docs/classes/DummyField.md +393 -0
- package/docs/classes/Eventer.md +185 -0
- package/docs/classes/Field.md +461 -0
- package/docs/classes/InjectMsg.md +85 -0
- package/docs/classes/NodeSvg.md +1011 -0
- package/docs/classes/NumberField.md +559 -0
- package/docs/classes/OptConnectField.md +624 -0
- package/docs/classes/Renderer.md +1636 -0
- package/docs/classes/RendererConstants.md +343 -0
- package/docs/classes/Representer.md +95 -0
- package/docs/classes/RepresenterNode.md +175 -0
- package/docs/classes/TextField.md +559 -0
- package/docs/classes/Toolbox.md +172 -0
- package/docs/classes/WASDController.md +616 -0
- package/docs/classes/Widget.md +195 -0
- package/docs/classes/WorkspaceController.md +385 -0
- package/docs/classes/WorkspaceCoords.md +218 -0
- package/docs/classes/WorkspaceSvg.md +1380 -0
- package/docs/functions/clearMainWorkspace.md +20 -0
- package/docs/functions/getMainWorkspace.md +19 -0
- package/docs/functions/inject.md +35 -0
- package/docs/functions/setMainWorkspace.md +28 -0
- package/docs/globals.md +95 -0
- package/docs/interfaces/ColorStyle.md +43 -0
- package/docs/interfaces/ConnectorToFrom.md +57 -0
- package/docs/interfaces/DrawState.md +81 -0
- package/docs/interfaces/FieldConnectionData.md +25 -0
- package/docs/interfaces/FieldOptions.md +63 -0
- package/docs/interfaces/FieldRawBoxData.md +25 -0
- package/docs/interfaces/FieldVisualInfo.md +65 -0
- package/docs/interfaces/GridOptions.md +61 -0
- package/docs/interfaces/InjectOptions.md +133 -0
- package/docs/interfaces/InputFieldJson.md +50 -0
- package/docs/interfaces/KabelCommentRendering.md +31 -0
- package/docs/interfaces/KabelInterface.md +469 -0
- package/docs/interfaces/KabelNodeRendering.md +77 -0
- package/docs/interfaces/KabelUIX.md +105 -0
- package/docs/interfaces/KabelUtils.md +215 -0
- package/docs/interfaces/NodeEvents.md +42 -0
- package/docs/interfaces/NodeJson.md +104 -0
- package/docs/interfaces/NodePrototype.md +82 -0
- package/docs/interfaces/RegisteredEl.md +53 -0
- package/docs/interfaces/SerializedNode.md +128 -0
- package/docs/interfaces/TblxCategoryStruct.md +41 -0
- package/docs/interfaces/TblxFieldStruct.md +28 -0
- package/docs/interfaces/TblxNodeStruct.md +35 -0
- package/docs/interfaces/WidgetOptions.md +115 -0
- package/docs/interfaces/WidgetPrototypeList.md +15 -0
- package/docs/type-aliases/AnyField.md +13 -0
- package/docs/type-aliases/AnyFieldCls.md +13 -0
- package/docs/type-aliases/Color.md +13 -0
- package/docs/type-aliases/Connectable.md +13 -0
- package/docs/type-aliases/EventArgs.md +11 -0
- package/docs/type-aliases/EventSetupFn.md +25 -0
- package/docs/type-aliases/Hex.md +13 -0
- package/docs/type-aliases/RGBObject.md +37 -0
- package/docs/type-aliases/RGBString.md +13 -0
- package/docs/type-aliases/RGBTuple.md +13 -0
- package/docs/type-aliases/TblxObjStruct.md +52 -0
- package/docs/variables/CategoryColors.md +29 -0
- package/docs/variables/FieldMap.md +41 -0
- package/docs/variables/NodePrototypes.md +18 -0
- package/docs/variables/default.md +11 -0
- package/events/comment-drag-handle.ts +61 -0
- package/events/comment-input.ts +291 -0
- package/events/connection-line.ts +68 -0
- package/events/connector.ts +116 -0
- package/events/draggable.ts +119 -0
- package/events/events.ts +7 -0
- package/events/input-box.ts +213 -0
- package/events/node-x-btn.ts +25 -0
- package/index.d.ts +4 -0
- package/package.json +49 -0
- package/renderers/apollo/apollo.ts +21 -0
- package/renderers/apollo/constants.ts +40 -0
- package/renderers/apollo/renderer.ts +331 -0
- package/renderers/atlas/atlas.ts +15 -0
- package/renderers/constants.ts +87 -0
- package/renderers/renderer.ts +1288 -0
- package/renderers/representer-node.ts +52 -0
- package/renderers/representer.ts +25 -0
- package/src/category.ts +107 -0
- package/src/colors.ts +20 -0
- package/src/comment.ts +142 -0
- package/src/connection.ts +114 -0
- package/src/context-menu.ts +194 -0
- package/src/coordinates.ts +74 -0
- package/src/core.ts +202 -0
- package/src/ctx-menu-registry.ts +143 -0
- package/src/dropdown-menu.ts +215 -0
- package/src/field.ts +595 -0
- package/src/flyout.ts +165 -0
- package/src/fonts-manager.ts +38 -0
- package/src/grid.ts +162 -0
- package/src/headless-node.ts +27 -0
- package/src/index.ts +115 -0
- package/src/inject-headless.ts +18 -0
- package/src/inject.ts +213 -0
- package/src/main-workspace.ts +51 -0
- package/src/mutator.ts +40 -0
- package/src/node-types.ts +27 -0
- package/src/nodesvg.ts +756 -0
- package/src/prototypes.ts +9 -0
- package/src/renderer-map.ts +86 -0
- package/src/styles.css +224 -0
- package/src/toolbox.ts +125 -0
- package/src/types.ts +205 -0
- package/src/undo-redo.ts +87 -0
- package/src/visual-types.ts +29 -0
- package/src/widget-prototypes.ts +11 -0
- package/src/widget.ts +139 -0
- package/src/workspace-coords.ts +14 -0
- package/src/workspace-svg.ts +736 -0
- package/src/workspace.ts +155 -0
- package/test-server.js +61 -0
- package/themes/dark.ts +32 -0
- package/themes/default.ts +28 -0
- package/themes/themes.ts +9 -0
- package/tsconfig.json +25 -0
- package/typedoc.json +10 -0
- package/util/emitter.ts +33 -0
- package/util/env.ts +11 -0
- package/util/escape-html.ts +22 -0
- package/util/eventer.ts +108 -0
- package/util/has-prop.ts +4 -0
- package/util/parse-color.ts +42 -0
- package/util/path.ts +99 -0
- package/util/styler.ts +41 -0
- package/util/uid.ts +184 -0
- package/util/unescape-html.ts +22 -0
- package/util/user-state.ts +68 -0
- package/util/wait-anim-frames.ts +24 -0
- package/util/window-listeners.ts +62 -0
- package/webpack.config.js +80 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / clearMainWorkspace
|
|
6
|
+
|
|
7
|
+
# Function: clearMainWorkspace()
|
|
8
|
+
|
|
9
|
+
> **clearMainWorkspace**(): `null`
|
|
10
|
+
|
|
11
|
+
Defined in: [src/main-workspace.ts:36](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/main-workspace.ts#L36)
|
|
12
|
+
|
|
13
|
+
Clears the main workspace reference.
|
|
14
|
+
After calling, getMainWorkspace() will return null.
|
|
15
|
+
|
|
16
|
+
## Returns
|
|
17
|
+
|
|
18
|
+
`null`
|
|
19
|
+
|
|
20
|
+
Always returns null.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / getMainWorkspace
|
|
6
|
+
|
|
7
|
+
# Function: getMainWorkspace()
|
|
8
|
+
|
|
9
|
+
> **getMainWorkspace**(): [`WorkspaceSvg`](../classes/WorkspaceSvg.md) \| `Workspace` \| `null`
|
|
10
|
+
|
|
11
|
+
Defined in: [src/main-workspace.ts:15](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/main-workspace.ts#L15)
|
|
12
|
+
|
|
13
|
+
Returns the current main workspace instance.
|
|
14
|
+
|
|
15
|
+
## Returns
|
|
16
|
+
|
|
17
|
+
[`WorkspaceSvg`](../classes/WorkspaceSvg.md) \| `Workspace` \| `null`
|
|
18
|
+
|
|
19
|
+
The main WorkspaceSvg or null if none is set.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / inject
|
|
6
|
+
|
|
7
|
+
# Function: inject()
|
|
8
|
+
|
|
9
|
+
> **inject**(`element`, `options`): [`WorkspaceSvg`](../classes/WorkspaceSvg.md) \| `undefined`
|
|
10
|
+
|
|
11
|
+
Defined in: [src/inject.ts:175](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L175)
|
|
12
|
+
|
|
13
|
+
Injects a new Kabel workspace into the document.
|
|
14
|
+
Appends the workspace container to the given element (or element ID) and
|
|
15
|
+
sets it as the main workspace.
|
|
16
|
+
|
|
17
|
+
## Parameters
|
|
18
|
+
|
|
19
|
+
### element
|
|
20
|
+
|
|
21
|
+
HTMLElement or string ID to attach the workspace to
|
|
22
|
+
|
|
23
|
+
`string` | `HTMLElement`
|
|
24
|
+
|
|
25
|
+
### options
|
|
26
|
+
|
|
27
|
+
[`InjectOptions`](../interfaces/InjectOptions.md) = `{}`
|
|
28
|
+
|
|
29
|
+
Optional InjectOptions to configure the workspace
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
[`WorkspaceSvg`](../classes/WorkspaceSvg.md) \| `undefined`
|
|
34
|
+
|
|
35
|
+
The newly created WorkspaceSvg instance, or undefined if injection failed
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / setMainWorkspace
|
|
6
|
+
|
|
7
|
+
# Function: setMainWorkspace()
|
|
8
|
+
|
|
9
|
+
> **setMainWorkspace**(`ws`): [`WorkspaceSvg`](../classes/WorkspaceSvg.md) \| `Workspace` \| `null`
|
|
10
|
+
|
|
11
|
+
Defined in: [src/main-workspace.ts:26](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/main-workspace.ts#L26)
|
|
12
|
+
|
|
13
|
+
Sets the main workspace reference.
|
|
14
|
+
Calling this updates the global "main workspace" for Kabel.
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
### ws
|
|
19
|
+
|
|
20
|
+
The WorkspaceSvg instance to set as main, or null to clear.
|
|
21
|
+
|
|
22
|
+
[`WorkspaceSvg`](../classes/WorkspaceSvg.md) | `Workspace` | `null`
|
|
23
|
+
|
|
24
|
+
## Returns
|
|
25
|
+
|
|
26
|
+
[`WorkspaceSvg`](../classes/WorkspaceSvg.md) \| `Workspace` \| `null`
|
|
27
|
+
|
|
28
|
+
The workspace that was set.
|
package/docs/globals.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
# Kabel Project Docs v1.0.6
|
|
6
|
+
|
|
7
|
+
## Classes
|
|
8
|
+
|
|
9
|
+
- [CommentModel](classes/CommentModel.md)
|
|
10
|
+
- [CommentRenderer](classes/CommentRenderer.md)
|
|
11
|
+
- [ConnectableField](classes/ConnectableField.md)
|
|
12
|
+
- [Connection](classes/Connection.md)
|
|
13
|
+
- [ContextMenuHTML](classes/ContextMenuHTML.md)
|
|
14
|
+
- [Coordinates](classes/Coordinates.md)
|
|
15
|
+
- [DropdownContainer](classes/DropdownContainer.md)
|
|
16
|
+
- [DummyField](classes/DummyField.md)
|
|
17
|
+
- [Eventer](classes/Eventer.md)
|
|
18
|
+
- [Field](classes/Field.md)
|
|
19
|
+
- [InjectMsg](classes/InjectMsg.md)
|
|
20
|
+
- [NodeSvg](classes/NodeSvg.md)
|
|
21
|
+
- [NumberField](classes/NumberField.md)
|
|
22
|
+
- [OptConnectField](classes/OptConnectField.md)
|
|
23
|
+
- [Renderer](classes/Renderer.md)
|
|
24
|
+
- [RendererConstants](classes/RendererConstants.md)
|
|
25
|
+
- [Representer](classes/Representer.md)
|
|
26
|
+
- [RepresenterNode](classes/RepresenterNode.md)
|
|
27
|
+
- [TextField](classes/TextField.md)
|
|
28
|
+
- [Toolbox](classes/Toolbox.md)
|
|
29
|
+
- [WASDController](classes/WASDController.md)
|
|
30
|
+
- [Widget](classes/Widget.md)
|
|
31
|
+
- [WorkspaceController](classes/WorkspaceController.md)
|
|
32
|
+
- [WorkspaceCoords](classes/WorkspaceCoords.md)
|
|
33
|
+
- [WorkspaceSvg](classes/WorkspaceSvg.md)
|
|
34
|
+
|
|
35
|
+
## Interfaces
|
|
36
|
+
|
|
37
|
+
- [ColorStyle](interfaces/ColorStyle.md)
|
|
38
|
+
- [ConnectorToFrom](interfaces/ConnectorToFrom.md)
|
|
39
|
+
- [DrawState](interfaces/DrawState.md)
|
|
40
|
+
- [FieldConnectionData](interfaces/FieldConnectionData.md)
|
|
41
|
+
- [FieldOptions](interfaces/FieldOptions.md)
|
|
42
|
+
- [FieldRawBoxData](interfaces/FieldRawBoxData.md)
|
|
43
|
+
- [FieldVisualInfo](interfaces/FieldVisualInfo.md)
|
|
44
|
+
- [GridOptions](interfaces/GridOptions.md)
|
|
45
|
+
- [InjectOptions](interfaces/InjectOptions.md)
|
|
46
|
+
- [InputFieldJson](interfaces/InputFieldJson.md)
|
|
47
|
+
- [KabelCommentRendering](interfaces/KabelCommentRendering.md)
|
|
48
|
+
- [KabelInterface](interfaces/KabelInterface.md)
|
|
49
|
+
- [KabelNodeRendering](interfaces/KabelNodeRendering.md)
|
|
50
|
+
- [KabelUIX](interfaces/KabelUIX.md)
|
|
51
|
+
- [KabelUtils](interfaces/KabelUtils.md)
|
|
52
|
+
- [NodeEvents](interfaces/NodeEvents.md)
|
|
53
|
+
- [NodeJson](interfaces/NodeJson.md)
|
|
54
|
+
- [NodePrototype](interfaces/NodePrototype.md)
|
|
55
|
+
- [RegisteredEl](interfaces/RegisteredEl.md)
|
|
56
|
+
- [SerializedNode](interfaces/SerializedNode.md)
|
|
57
|
+
- [TblxCategoryStruct](interfaces/TblxCategoryStruct.md)
|
|
58
|
+
- [TblxFieldStruct](interfaces/TblxFieldStruct.md)
|
|
59
|
+
- [TblxNodeStruct](interfaces/TblxNodeStruct.md)
|
|
60
|
+
- [WidgetOptions](interfaces/WidgetOptions.md)
|
|
61
|
+
- [WidgetPrototypeList](interfaces/WidgetPrototypeList.md)
|
|
62
|
+
|
|
63
|
+
## Type Aliases
|
|
64
|
+
|
|
65
|
+
- [AnyField](type-aliases/AnyField.md)
|
|
66
|
+
- [AnyFieldCls](type-aliases/AnyFieldCls.md)
|
|
67
|
+
- [Color](type-aliases/Color.md)
|
|
68
|
+
- [Connectable](type-aliases/Connectable.md)
|
|
69
|
+
- [EventArgs](type-aliases/EventArgs.md)
|
|
70
|
+
- [EventSetupFn](type-aliases/EventSetupFn.md)
|
|
71
|
+
- [Hex](type-aliases/Hex.md)
|
|
72
|
+
- [RGBObject](type-aliases/RGBObject.md)
|
|
73
|
+
- [RGBString](type-aliases/RGBString.md)
|
|
74
|
+
- [RGBTuple](type-aliases/RGBTuple.md)
|
|
75
|
+
- [TblxObjStruct](type-aliases/TblxObjStruct.md)
|
|
76
|
+
|
|
77
|
+
## Variables
|
|
78
|
+
|
|
79
|
+
- [CategoryColors](variables/CategoryColors.md)
|
|
80
|
+
- [default](variables/default.md)
|
|
81
|
+
- [FieldMap](variables/FieldMap.md)
|
|
82
|
+
- [NodePrototypes](variables/NodePrototypes.md)
|
|
83
|
+
|
|
84
|
+
## Functions
|
|
85
|
+
|
|
86
|
+
- [clearMainWorkspace](functions/clearMainWorkspace.md)
|
|
87
|
+
- [getMainWorkspace](functions/getMainWorkspace.md)
|
|
88
|
+
- [inject](functions/inject.md)
|
|
89
|
+
- [setMainWorkspace](functions/setMainWorkspace.md)
|
|
90
|
+
|
|
91
|
+
## References
|
|
92
|
+
|
|
93
|
+
### Showable
|
|
94
|
+
|
|
95
|
+
Renames and re-exports [KabelInterface](interfaces/KabelInterface.md)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / ColorStyle
|
|
6
|
+
|
|
7
|
+
# Interface: ColorStyle
|
|
8
|
+
|
|
9
|
+
Defined in: [src/visual-types.ts:24](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L24)
|
|
10
|
+
|
|
11
|
+
Stores color data for a visual element on screen.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### category?
|
|
16
|
+
|
|
17
|
+
> `optional` **category**: `string`
|
|
18
|
+
|
|
19
|
+
Defined in: [src/visual-types.ts:28](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L28)
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### primary
|
|
24
|
+
|
|
25
|
+
> **primary**: [`Color`](../type-aliases/Color.md)
|
|
26
|
+
|
|
27
|
+
Defined in: [src/visual-types.ts:25](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L25)
|
|
28
|
+
|
|
29
|
+
***
|
|
30
|
+
|
|
31
|
+
### secondary
|
|
32
|
+
|
|
33
|
+
> **secondary**: [`Color`](../type-aliases/Color.md)
|
|
34
|
+
|
|
35
|
+
Defined in: [src/visual-types.ts:26](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L26)
|
|
36
|
+
|
|
37
|
+
***
|
|
38
|
+
|
|
39
|
+
### tertiary
|
|
40
|
+
|
|
41
|
+
> **tertiary**: [`Color`](../type-aliases/Color.md)
|
|
42
|
+
|
|
43
|
+
Defined in: [src/visual-types.ts:27](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L27)
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / ConnectorToFrom
|
|
6
|
+
|
|
7
|
+
# Interface: ConnectorToFrom
|
|
8
|
+
|
|
9
|
+
Defined in: [renderers/renderer.ts:18](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L18)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### from
|
|
14
|
+
|
|
15
|
+
> **from**: [`Connection`](../classes/Connection.md)
|
|
16
|
+
|
|
17
|
+
Defined in: [renderers/renderer.ts:20](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L20)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### fromCircle?
|
|
22
|
+
|
|
23
|
+
> `optional` **fromCircle**: `Path`
|
|
24
|
+
|
|
25
|
+
Defined in: [renderers/renderer.ts:21](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L21)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### originCircle
|
|
30
|
+
|
|
31
|
+
> **originCircle**: `Path`
|
|
32
|
+
|
|
33
|
+
Defined in: [renderers/renderer.ts:24](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L24)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### originConn
|
|
38
|
+
|
|
39
|
+
> **originConn**: [`Connection`](../classes/Connection.md)
|
|
40
|
+
|
|
41
|
+
Defined in: [renderers/renderer.ts:23](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L23)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### to
|
|
46
|
+
|
|
47
|
+
> **to**: [`Connection`](../classes/Connection.md)
|
|
48
|
+
|
|
49
|
+
Defined in: [renderers/renderer.ts:19](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L19)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### toCircle?
|
|
54
|
+
|
|
55
|
+
> `optional` **toCircle**: `Path`
|
|
56
|
+
|
|
57
|
+
Defined in: [renderers/renderer.ts:22](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L22)
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / DrawState
|
|
6
|
+
|
|
7
|
+
# Interface: DrawState
|
|
8
|
+
|
|
9
|
+
Defined in: [renderers/renderer.ts:26](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L26)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### bg?
|
|
14
|
+
|
|
15
|
+
> `optional` **bg**: `Path` \| `null`
|
|
16
|
+
|
|
17
|
+
Defined in: [renderers/renderer.ts:30](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L30)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### fieldCol?
|
|
22
|
+
|
|
23
|
+
> `optional` **fieldCol**: `G` \| `null`
|
|
24
|
+
|
|
25
|
+
Defined in: [renderers/renderer.ts:32](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L32)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### fieldPosY?
|
|
30
|
+
|
|
31
|
+
> `optional` **fieldPosY**: `number` \| `null`
|
|
32
|
+
|
|
33
|
+
Defined in: [renderers/renderer.ts:33](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L33)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### group?
|
|
38
|
+
|
|
39
|
+
> `optional` **group**: `G` \| `null`
|
|
40
|
+
|
|
41
|
+
Defined in: [renderers/renderer.ts:31](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L31)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### id
|
|
46
|
+
|
|
47
|
+
> **id**: `string`
|
|
48
|
+
|
|
49
|
+
Defined in: [renderers/renderer.ts:27](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L27)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### pendingConnections
|
|
54
|
+
|
|
55
|
+
> **pendingConnections**: [`ConnectorToFrom`](ConnectorToFrom.md)[]
|
|
56
|
+
|
|
57
|
+
Defined in: [renderers/renderer.ts:35](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L35)
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### shadow?
|
|
62
|
+
|
|
63
|
+
> `optional` **shadow**: `Path`
|
|
64
|
+
|
|
65
|
+
Defined in: [renderers/renderer.ts:28](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L28)
|
|
66
|
+
|
|
67
|
+
***
|
|
68
|
+
|
|
69
|
+
### topbar?
|
|
70
|
+
|
|
71
|
+
> `optional` **topbar**: `Path` \| `null`
|
|
72
|
+
|
|
73
|
+
Defined in: [renderers/renderer.ts:29](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L29)
|
|
74
|
+
|
|
75
|
+
***
|
|
76
|
+
|
|
77
|
+
### xButton?
|
|
78
|
+
|
|
79
|
+
> `optional` **xButton**: `G`
|
|
80
|
+
|
|
81
|
+
Defined in: [renderers/renderer.ts:34](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/renderers/renderer.ts#L34)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / FieldConnectionData
|
|
6
|
+
|
|
7
|
+
# Interface: FieldConnectionData
|
|
8
|
+
|
|
9
|
+
Defined in: [src/field.ts:36](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L36)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### connector
|
|
14
|
+
|
|
15
|
+
> **connector**: `Path`
|
|
16
|
+
|
|
17
|
+
Defined in: [src/field.ts:37](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L37)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### connState
|
|
22
|
+
|
|
23
|
+
> **connState**: [`ConnectorToFrom`](ConnectorToFrom.md)
|
|
24
|
+
|
|
25
|
+
Defined in: [src/field.ts:38](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L38)
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / FieldOptions
|
|
6
|
+
|
|
7
|
+
# Interface: FieldOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [src/field.ts:10](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L10)
|
|
10
|
+
|
|
11
|
+
Options used to initialize a Field.
|
|
12
|
+
|
|
13
|
+
## Indexable
|
|
14
|
+
|
|
15
|
+
\[`key`: `string`\]: `any`
|
|
16
|
+
|
|
17
|
+
## Properties
|
|
18
|
+
|
|
19
|
+
### fld\_type?
|
|
20
|
+
|
|
21
|
+
> `optional` **fld\_type**: `"string"` \| `"number"`
|
|
22
|
+
|
|
23
|
+
Defined in: [src/field.ts:19](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L19)
|
|
24
|
+
|
|
25
|
+
Only used by OptConnectField to determine internal value type
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### label
|
|
30
|
+
|
|
31
|
+
> **label**: `string`
|
|
32
|
+
|
|
33
|
+
Defined in: [src/field.ts:13](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L13)
|
|
34
|
+
|
|
35
|
+
Human-readable label for the field
|
|
36
|
+
|
|
37
|
+
***
|
|
38
|
+
|
|
39
|
+
### name
|
|
40
|
+
|
|
41
|
+
> **name**: `string`
|
|
42
|
+
|
|
43
|
+
Defined in: [src/field.ts:11](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L11)
|
|
44
|
+
|
|
45
|
+
***
|
|
46
|
+
|
|
47
|
+
### type
|
|
48
|
+
|
|
49
|
+
> **type**: `string`
|
|
50
|
+
|
|
51
|
+
Defined in: [src/field.ts:15](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L15)
|
|
52
|
+
|
|
53
|
+
Key used to identify the field type in FieldTypesMap
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
57
|
+
### value?
|
|
58
|
+
|
|
59
|
+
> `optional` **value**: `any`
|
|
60
|
+
|
|
61
|
+
Defined in: [src/field.ts:17](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L17)
|
|
62
|
+
|
|
63
|
+
Field value (optional)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / FieldRawBoxData
|
|
6
|
+
|
|
7
|
+
# Interface: FieldRawBoxData
|
|
8
|
+
|
|
9
|
+
Defined in: [src/field.ts:32](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L32)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### box
|
|
14
|
+
|
|
15
|
+
> **box**: `Rect`
|
|
16
|
+
|
|
17
|
+
Defined in: [src/field.ts:33](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L33)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### txt
|
|
22
|
+
|
|
23
|
+
> **txt**: `Text`
|
|
24
|
+
|
|
25
|
+
Defined in: [src/field.ts:34](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L34)
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / FieldVisualInfo
|
|
6
|
+
|
|
7
|
+
# Interface: FieldVisualInfo
|
|
8
|
+
|
|
9
|
+
Defined in: [src/field.ts:23](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L23)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### background
|
|
14
|
+
|
|
15
|
+
> **background**: `Rect`
|
|
16
|
+
|
|
17
|
+
Defined in: [src/field.ts:26](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L26)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### fieldGroup
|
|
22
|
+
|
|
23
|
+
> **fieldGroup**: `G`
|
|
24
|
+
|
|
25
|
+
Defined in: [src/field.ts:29](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L29)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### measuredHeight
|
|
30
|
+
|
|
31
|
+
> **measuredHeight**: `number`
|
|
32
|
+
|
|
33
|
+
Defined in: [src/field.ts:25](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L25)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### measuredWidth
|
|
38
|
+
|
|
39
|
+
> **measuredWidth**: `number`
|
|
40
|
+
|
|
41
|
+
Defined in: [src/field.ts:24](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L24)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### nodeGroup
|
|
46
|
+
|
|
47
|
+
> **nodeGroup**: `G`
|
|
48
|
+
|
|
49
|
+
Defined in: [src/field.ts:28](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L28)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### svg
|
|
54
|
+
|
|
55
|
+
> **svg**: `Svg`
|
|
56
|
+
|
|
57
|
+
Defined in: [src/field.ts:27](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L27)
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### xUsed
|
|
62
|
+
|
|
63
|
+
> **xUsed**: `number`
|
|
64
|
+
|
|
65
|
+
Defined in: [src/field.ts:30](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L30)
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / GridOptions
|
|
6
|
+
|
|
7
|
+
# Interface: GridOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [src/inject.ts:74](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L74)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### color?
|
|
14
|
+
|
|
15
|
+
> `optional` **color**: `` `#${string}` ``
|
|
16
|
+
|
|
17
|
+
Defined in: [src/inject.ts:96](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L96)
|
|
18
|
+
|
|
19
|
+
Option color for any grid type. Color is #bebebeff by default.
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### dotSize?
|
|
24
|
+
|
|
25
|
+
> `optional` **dotSize**: `number`
|
|
26
|
+
|
|
27
|
+
Defined in: [src/inject.ts:88](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L88)
|
|
28
|
+
|
|
29
|
+
Dot size for 'dotted' grid type.
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### spacing?
|
|
34
|
+
|
|
35
|
+
> `optional` **spacing**: `number`
|
|
36
|
+
|
|
37
|
+
Defined in: [src/inject.ts:84](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L84)
|
|
38
|
+
|
|
39
|
+
Spacing, optional. Default is 40.
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### strokeWidth?
|
|
44
|
+
|
|
45
|
+
> `optional` **strokeWidth**: `number`
|
|
46
|
+
|
|
47
|
+
Defined in: [src/inject.ts:92](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L92)
|
|
48
|
+
|
|
49
|
+
stroke width for 'celled' grid type.
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### type
|
|
54
|
+
|
|
55
|
+
> **type**: `"dotted"` \| `"celled"`
|
|
56
|
+
|
|
57
|
+
Defined in: [src/inject.ts:80](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L80)
|
|
58
|
+
|
|
59
|
+
The grid's type.
|
|
60
|
+
'celled' - The grid is celled.
|
|
61
|
+
'dotted' - The grid is dotted.
|