Skip to main content

Interface: StandardRelationProps

Defined in: src/templates/standardLink.tsx:49

Props for StandardRelation component.

See

StandardRelation

Extends

Extended by

Properties

PropertyModifierTypeDescriptionInherited from

children?

public

ReactNode

Additional children for the component.

className?

public

string

Additional CSS class for the component.

getPathPosition

readonly

(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

readonly

Link

Target link to render.

LinkTemplateProps.link

markerSource

readonly

string

SVG path marker for the link source.

LinkTemplateProps.markerSource

markerTarget

readonly

string

SVG path marker for the link target.

LinkTemplateProps.markerTarget

onlySelected

readonly

boolean

Whether the link is the only selected cell on the canvas.

See

DiagramModel.selection

LinkTemplateProps.onlySelected

path

readonly

string

SVG path for the link geometry.

LinkTemplateProps.path

pathProps?

public

SVGAttributes<SVGPathElement>

Additional attributes for SVG path rendering of the link geometry.

prependLabels?

public

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?

public

StandardRelationLabelStyle

Additional props for the primary link label.

See

LinkLabelProps.primary

propertyLabelProps?

public

StandardRelationLabelStyle | (propertyIri) => undefined | null | StandardRelationLabelStyle

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

If specified function returns null, the property will be hidden.

See

LinkLabelProps

propertyLabelStartLine?

public

number

Starting row shift when displaying relation link data properties.

Default

1

See

LinkLabelProps.line

route?

readonly

RoutedLink

Route data (geometry) for the link.

LinkTemplateProps.route