API Reference

wireEdgeGroup()

Creates a wire edge group.

Import

import { wireEdgeGroup } from "@graphrefly/ts/adapters";

Signature

function wireEdgeGroup(
	graph: Graph,
	bridge: WireBridgeBundle<WireBridgeProtobufData, WireBridgeProtobufData>,
	opts: WireEdgeGroupOptions,
): WireEdgeGroupBundle

Parameters

Parameter	Type	Description
`graph`	`Graph`	Graph that owns the created nodes or projector.
`bridge`	`WireBridgeBundle<WireBridgeProtobufData, WireBridgeProtobufData>`	bridge value used by the helper.
`opts`	`WireEdgeGroupOptions`	Options that configure the helper.

Returns

The wire edge group result.

Example

import { wireEdgeGroup } from "@graphrefly/ts/adapters";

Source

packages/ts/src/adapters/bridge-wire-edge-group.ts