Skip to main content
Version: 4.3

LinkRecord

type LinkRecord<LinkData, Type> = LinkJSONInit & WithType<Type> & WithData<LinkData>;

Plain-object description of one link: your custom data plus the visual fields JointJS understands (source, target, attrs, labels, and the style/labelMap/labelStyle preset extras). Use it for initialCells entries and when adding or updating cells; reading hooks hand back its Computed<LinkRecord> form (fields the store always populates are required).

Type defaults to 'link' so cell.type === 'link' narrows the CellRecord union; set it to a shape name (e.g. 'standard.Link') for a built-in or custom shape.

Type Parameters

Type ParameterDefault typeDescription
LinkDataunknownshape of the custom data payload carried on the link
Type extends stringtypeof LINK_MODEL_TYPEthe type discriminator literal

Stay in the know

Be where thousands of diagramming enthusiasts meet

Star us on GitHub