Skip to main content

Interface: StandardRelationProps

Defined in: templates/standardLink.tsx:48

Props for StandardRelation component.

See

StandardRelation

Extends

Extended by

Properties

PropertyTypeDescriptionInherited from

children?

ReactNode

Additional children for the component.

className?

string

Additional CSS class for the component.

getPathPosition

(offset) => Vector

Provides paper position along the link at the specified offset.

Offset of 0.0 corresponds to the source and 1.0 corresponds to the target of the link.

LinkTemplateProps.getPathPosition

link

Link

Target link to render.

LinkTemplateProps.link

markerSource

string

SVG path marker for the link source.

LinkTemplateProps.markerSource

markerTarget

string

SVG path marker for the link target.

LinkTemplateProps.markerTarget

path

string

SVG path for the link geometry.

LinkTemplateProps.path

pathProps?

SVGAttributes<SVGPathElement>

Additional attributes for SVG path rendering of the link geometry.

prependLabels?

ReactNode

Additional labels to display for the link.

When prepending labels for a relational link it is useful to specify propertyLabelStartLine to avoid overlapping prepended and data labels.

primaryLabelProps?

StandardRelationLabelStyle

Additional props for the primary link label.

See

LinkLabelProps.primary

propertyLabelProps?

StandardRelationLabelStyle

Additional props for each label displaying a property from a relation link data.

propertyLabelStartLine?

number

Starting row shift when displaying relation link data properties.

Default

1

See

LinkLabelProps.line

route?

RoutedLink

Route data (geometry) for the link.

LinkTemplateProps.route