@raydeck/flowpoints v1.1.1
Template for making easy-to-work-with tempates
flowpoints
@raydeck/flowpoints - v1.1.1
@raydeck/flowpoints - v1.1.1
Table of contents
Modules
@raydeck/flowpoints - v1.1.1 / Helpers / Point
Interface: Point
Helpers.Point
Hierarchy
Point↳
Position
Table of contents
Properties
Properties
offsetX
• offsetX: number
Defined in
offsetY
• offsetY: number
Defined in
x
• x: number
Defined in
y
• y: number
Defined in
@raydeck/flowpoints - v1.1.1 / Helpers / Position
Interface: Position
Helpers.Position
Hierarchy
↳
Position
Table of contents
Properties
Properties
height
• height: number
Defined in
offsetX
• offsetX: number
Inherited from
Defined in
offsetY
• offsetY: number
Inherited from
Defined in
width
• width: number
Defined in
x
• x: number
Inherited from
Defined in
y
• y: number
Inherited from
Defined in
@raydeck/flowpoints - v1.1.1 / Flowpoint
Module: Flowpoint
Table of contents
Variables
Variables
default
• Const default: FC<FlowpointProps>
Defined in
@raydeck/flowpoints - v1.1.1 / Flowspace
Module: Flowspace
Table of contents
Variables
Functions
Variables
default
• Const default: FC<Object>
Defined in
Functions
useFlowspace
▸ useFlowspace(): Object
Returns
Object
| Name | Type |
|---|---|
deleteFlowpoint | DeleteFlowpoint |
scale | number |
selected | string[] |
spaceColor | ColorSet |
theme | ValidColor |
updateFlowpoint | UpdateFlowpoint |
variant | Variant |
Defined in
@raydeck/flowpoints - v1.1.1 / Helpers
Module: Helpers
Table of contents
Interfaces
Type aliases
Variables
Functions
Type aliases
ColorSet
Ƭ ColorSet: Object
Type declaration
| Name | Type |
|---|---|
a | string |
o | string |
p | string |
s | string |
t | "light" | "dark" |
Defined in
FlowpointInfo
Ƭ FlowpointInfo: Object
Type declaration
| Name | Type |
|---|---|
event? | string |
outputs | Record<string, Output> |
position | Position |
Defined in
Location
Ƭ Location: "top" | "bottom" | "left" | "right" | "auto"
Defined in
Output
Ƭ Output: Object
Type declaration
| Name | Type |
|---|---|
arrowEnd? | boolean |
arrowStart? | boolean |
dash? | number |
input? | Location |
inputColor? | string |
output? | Location |
outputColor? | string |
width? | number |
onClick? | (pointKey: string, outKey: string, e: MouseEvent<Element, MouseEvent>) => void |
Defined in
ValidColor
Ƭ ValidColor: keyof typeof colors
Defined in
Variant
Ƭ Variant: "paper" | "outlined" | "filled"
Defined in
Variables
colors
• Const colors: Object
Index signature
Defined in
Functions
AutoGetLoc
▸ AutoGetLoc(pa, pb, aLoc, bLoc, key1, key2, allPositions, avoidCollisions): Object
Parameters
| Name | Type |
|---|---|
pa | Position |
pb | Position |
aLoc | Location |
bLoc | Location |
key1 | string |
key2 | string |
allPositions | Object |
avoidCollisions | boolean |
Returns
Object
| Name | Type |
|---|---|
input | Position |
output | Position |
Defined in
CalcPos
▸ CalcPos(pos, snap, minimum): number
Parameters
| Name | Type |
|---|---|
pos | number |
snap | number |
minimum | number |
Returns
number
Defined in
getColor
▸ getColor(color?): ColorSet
Parameters
| Name | Type |
|---|---|
color? | ValidColor |
Returns
Defined in
@raydeck/flowpoints - v1.1.1 / index
Module: index
Table of contents
References
- Flowpoint
- Flowspace
- Flowspace_useFlowspace
- Helpers_AutoGetLoc
- Helpers_CalcPos
- Helpers_colors
- Helpers_getColor
References
Flowpoint
Renames and exports: default
Flowspace
Renames and exports: default
Flowspace_useFlowspace
Renames and exports: useFlowspace
Helpers_AutoGetLoc
Renames and exports: AutoGetLoc
Helpers_CalcPos
Renames and exports: CalcPos
Helpers_colors
Renames and exports: colors
Helpers_getColor
Renames and exports: getColor