API for rete-connection-reroute-plugin package

RerouteProduces

index.ts

Signal types produced by the plugin

ts
type RerouteProduces =
  | { data: Object; type: "pintranslated" }
  | { data: Object; type: "pinselected" }
  | { data: Object; type: "pinunselected" };

ReroutePlugin

index.ts

Reroute plugin

ts
class ReroutePlugin<Schemes extends BaseSchemes>

Extends Scope<RerouteProduces, Requires<Schemes>, BaseArea<Schemes> | RerouteExtra>

Emits pintranslated pinselected pinunselected

Listens rendered unmount reordered connectionpath pointerdown

add

index.ts

Add a new pin to the connection

ts
add(connectionId: string, position: Position, index: number): void

Returns void

remove

index.ts

Remove pin

ts
remove(pinId: string): Promise<void>

Returns Promise<void>

select

index.ts

Select pin

ts
select(pinId: string): Promise<void>

Returns Promise<void>

translate

index.ts

Translate pin

ts
translate(pinId: string, dx: number, dy: number): Promise<void>

Returns Promise<void>

unselect

index.ts

Unselect pin

ts
unselect(pinId: string): Promise<void>

Returns Promise<void>

update

index.ts

Update connection for the pin

ts
update(pin: string | PinStorageRecord): void

Returns void

RerouteExtensions

extensions/index.ts

Extensions for the connection reroute plugin

selectablePins

extensions/selectable.ts

Enables synchronization between pins and the selector

ts
selectablePins(reroutePlugin: ReroutePlugin<S>, selector: Selector<SelectorEntity>, accumulating: { active: unknown }): void

Listens pinselected pinunselected pintranslated

Returns void

RerouteExtra

index.ts

Signal types consumed by the plugin

ts
type RerouteExtra =
  | RenderSignal<"reroute-pins", { data: PinData }>
  | { data: Object; type: "unmount" };