@raydeck/flowpoints

Template for making easy-to-work-with tempates

Usage no npm install needed!

<script type="module">
  import raydeckFlowpoints from 'https://cdn.skypack.dev/@raydeck/flowpoints';
</script>

README

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

Table of contents

Properties

Properties

offsetX

• offsetX: number

Defined in

Helpers.tsx:6

offsetY

• offsetY: number

Defined in

Helpers.tsx:7

x

• x: number

Defined in

Helpers.tsx:4

y

• y: number

Defined in

Helpers.tsx:5

@raydeck/flowpoints - v1.1.1 / Helpers / Position

Interface: Position

Helpers.Position

Hierarchy

Table of contents

Properties

Properties

height

• height: number

Defined in

Helpers.tsx:10

offsetX

• offsetX: number

Inherited from

Point.offsetX

Defined in

Helpers.tsx:6

offsetY

• offsetY: number

Inherited from

Point.offsetY

Defined in

Helpers.tsx:7

width

• width: number

Defined in

Helpers.tsx:11

x

• x: number

Inherited from

Point.x

Defined in

Helpers.tsx:4

y

• y: number

Inherited from

Point.y

Defined in

Helpers.tsx:5

@raydeck/flowpoints - v1.1.1 / Flowpoint

Module: Flowpoint

Table of contents

Variables

Variables

default

• Const default: FC<FlowpointProps>

Defined in

Flowpoint.tsx:63

@raydeck/flowpoints - v1.1.1 / Flowspace

Module: Flowspace

Table of contents

Variables

Functions

Variables

default

• Const default: FC<Object>

Defined in

Flowspace.tsx:90

Functions

useFlowspace

▸ useFlowspace(): Object

Returns

Object

Name Type
deleteFlowpoint DeleteFlowpoint
scale number
selected string[]
spaceColor ColorSet
theme ValidColor
updateFlowpoint UpdateFlowpoint
variant Variant

Defined in

Flowspace.tsx:61

@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

Helpers.tsx:171

FlowpointInfo

Ƭ FlowpointInfo: Object

Type declaration

Name Type
event? string
outputs Record<string, Output>
position Position

Defined in

Helpers.tsx:26

Location

Ƭ Location: "top" | "bottom" | "left" | "right" | "auto"

Defined in

Helpers.tsx:13

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

Helpers.tsx:14

ValidColor

Ƭ ValidColor: keyof typeof colors

Defined in

Helpers.tsx:178

Variant

Ƭ Variant: "paper" | "outlined" | "filled"

Defined in

Helpers.tsx:31

Variables

colors

• Const colors: Object

Index signature

▪ [key: string]: ColorSet

Defined in

Helpers.tsx:36

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

Helpers.tsx:303

CalcPos

▸ CalcPos(pos, snap, minimum): number

Parameters

Name Type
pos number
snap number
minimum number

Returns

number

Defined in

Helpers.tsx:32

getColor

▸ getColor(color?): ColorSet

Parameters

Name Type
color? ValidColor

Returns

ColorSet

Defined in

Helpers.tsx:180

@raydeck/flowpoints - v1.1.1 / index

Module: index

Table of contents

References

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