Skip to main content
Version: 4.3

ElementRecord

type ElementRecord<ElementData, Type> = ElementJSONInit & WithType<Type> & WithData<ElementData>;

Plain-object description of one element: your custom data plus the visual fields JointJS understands (position, size, angle, attrs, ports, and the portMap/portStyle preset extras). Use it for initialCells entries and when adding or updating cells; reading hooks hand back its Computed<ElementRecord> form (fields the store always populates are required).

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

Type Parameters

Type ParameterDefault typeDescription
ElementDataunknownshape of the custom data payload carried on the element
Type extends stringtypeof ELEMENT_MODEL_TYPEthe type discriminator literal

Stay in the know

Be where thousands of diagramming enthusiasts meet

Star us on GitHub