Class LinkModel<Attributes>

The link class @joint/react registers and uses by default for every link you add to the graph. Its markup has two paths, a wide transparent wrapper that widens the pointer hit area and the visible line, and it mounts the experimental RenderLink output into the link's root <g>. Extend it to customize the markup or default attributes, or supply any dia.Link subclass that implements PortalHostCell to host React content yourself.

Example

import { LinkModel } from '@joint/react';

const link = new LinkModel({
  id: 'link-1',
  source: { id: '1' },
  target: { id: '2' },
});

Type Parameters

Attributes extends dia.Link.Attributes = dia.Link.Attributes

Hierarchy

Link<Attributes>
- LinkModel

Implements

PortalHostCell

Index

Constructors

constructor

new LinkModel<Attributes extends Attributes<Selectors> = Attributes<Selectors>>(
attributes?: _DeepPartial<_DeepRequired<Attributes>>,
opt?: ConstructorOptions,
): LinkModel<Attributes>
Type Parameters
- Attributes extends Attributes<Selectors> = Attributes<Selectors>
Parameters
- Optionalattributes: _DeepPartial<_DeepRequired<Attributes>>
- Optionalopt: ConstructorOptions
Returns LinkModel<Attributes>
Inherited from dia.Link<Attributes>.constructor
- Defined in joint-core/types/dia.d.ts:692

Methods

addTo

addTo(graph: Graph, opt?: Options): this
Parameters
- graph: Graph
- Optionalopt: Options
Returns this
Inherited from dia.Link.addTo
- Defined in joint-core/types/dia.d.ts:753

angle

angle(): number
Returns number
Inherited from dia.Link.angle
- Defined in joint-core/types/dia.d.ts:772

appendLabel

appendLabel(label: Label, opt?: ModelSetOptions): Label[]
Parameters
- label: Label
- Optionalopt: ModelSetOptions
Returns Label[]
Inherited from dia.Link.appendLabel
- Defined in joint-core/types/dia.d.ts:1084

applyToPoints

applyToPoints(fn: (p: PlainPoint) => PlainPoint, opt?: ModelSetOptions): this
Parameters
- fn: (p: PlainPoint) => PlainPoint
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.applyToPoints
- Defined in joint-core/types/dia.d.ts:1122

attr

attr(key?: Path): any
Parameters
- Optionalkey: Path
Returns any
Inherited from dia.Link.attr
- Defined in joint-core/types/dia.d.ts:731
attr(object: Selectors, opt?: Options): this
Parameters
- object: Selectors
- Optionalopt: Options
Returns this
Inherited from dia.Link.attr
- Defined in joint-core/types/dia.d.ts:732
attr(key: Path, value: any, opt?: Options): this
Parameters
- key: Path
- value: any
- Optionalopt: Options
Returns this
Inherited from dia.Link.attr
- Defined in joint-core/types/dia.d.ts:733

bind

bind(eventName: string, callback: EventHandler, context?: any): this
Parameters
- eventName: string
- callback: EventHandler
- Optionalcontext: any
Returns this
Inherited from dia.Link.bind
- Defined in joint-core/types/mvc.d.ts:210
bind(eventMap: EventMap, context?: any): this
Parameters
- eventMap: EventMap
- Optionalcontext: any
Returns this
Inherited from dia.Link.bind
- Defined in joint-core/types/mvc.d.ts:211

canEmbed

canEmbed(
    cell:
        | Cell<Attributes<Selectors>, ModelSetOptions>
        | Cell<Attributes<Selectors>, ModelSetOptions>[],
): boolean
Parameters
- cell:
  | Cell<Attributes<Selectors>, ModelSetOptions>
  | Cell<Attributes<Selectors>, ModelSetOptions>[]
Returns boolean
Inherited from dia.Link.canEmbed
- Defined in joint-core/types/dia.d.ts:751

changedAttributes

changedAttributes(attributes?: Partial<Attributes>): false | Partial<Attributes>
Return an object containing all the attributes that have changed, or false if there are no changed attributes. Useful for determining what parts of a view need to be updated and/or what attributes need to be persisted to the server. Unset attributes will be set to undefined. You can also pass an attributes object to diff against the model, determining if there would be a change.
Parameters
- Optionalattributes: Partial<Attributes>
Returns false | Partial<Attributes>
Inherited from dia.Link.changedAttributes
- Defined in joint-core/types/mvc.d.ts:296

clear

clear(options?: Silenceable): this
Parameters
- Optionaloptions: Silenceable
Returns this
Inherited from dia.Link.clear
- Defined in joint-core/types/mvc.d.ts:297

clone

clone(): this
Returns this
Inherited from dia.Link.clone
- Defined in joint-core/types/dia.d.ts:735
clone(opt: EmbeddableOptions<false>): this
Parameters
- opt: EmbeddableOptions<false>
Returns this
Inherited from dia.Link.clone
- Defined in joint-core/types/dia.d.ts:736
clone(
opt: EmbeddableOptions<true>,
): Cell<Attributes<Selectors>, ModelSetOptions>[]
Parameters
- opt: EmbeddableOptions<true>
Returns Cell<Attributes<Selectors>, ModelSetOptions>[]
Inherited from dia.Link.clone
- Defined in joint-core/types/dia.d.ts:737

connector

connector(): Connector | ConnectorJSON | null
Returns Connector | ConnectorJSON | null
Inherited from dia.Link.connector
- Defined in joint-core/types/dia.d.ts:1070
connector(connector: Connector | ConnectorJSON, opt?: ModelSetOptions): this
Parameters
- connector: Connector | ConnectorJSON
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.connector
- Defined in joint-core/types/dia.d.ts:1071
connector(
    name: keyof ConnectorArgumentsMap,
    args?: { [key: string]: any },
    opt?: ModelSetOptions,
): this
Parameters
- name: keyof ConnectorArgumentsMap
- Optionalargs: { [key: string]: any }
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.connector
- Defined in joint-core/types/dia.d.ts:1072

defaults

defaults(): Attributes
Default attributes for every LinkModel: the 'link' type, the default link styling, and an empty data object. The styling sets connection: true on the line/wrapper paths, which JointJS needs to compute the link path.

Returns Attributes
The default attributes.
Overrides dia.Link.defaults
- Defined in joint-react/src/mvc/link-model.ts:79

disconnect

disconnect(): this
Returns this
Inherited from dia.Link.disconnect
- Defined in joint-core/types/dia.d.ts:1056

embed

embed(
    cell:
        | Cell<Attributes<Selectors>, ModelSetOptions>
        | Cell<Attributes<Selectors>, ModelSetOptions>[],
    opt?: EmbedOptions,
): this
Parameters
- cell:
  | Cell<Attributes<Selectors>, ModelSetOptions>
  | Cell<Attributes<Selectors>, ModelSetOptions>[]
- Optionalopt: EmbedOptions
Returns this
Inherited from dia.Link.embed
- Defined in joint-core/types/dia.d.ts:747

escape

escape(attribute: _StringKey<Attributes>): string
Parameters
- attribute: _StringKey<Attributes>
Returns string
Inherited from dia.Link.escape
- Defined in joint-core/types/mvc.d.ts:299

findView

findView(paper: Paper): CellView
Parameters
- paper: Paper
Returns CellView
Inherited from dia.Link.findView
- Defined in joint-core/types/dia.d.ts:755

get

get<A extends string>(attributeName: A): Attributes[A] | undefined
For strongly-typed access to attributes, use the get method only privately in public getter properties.
Type Parameters
- A extends string
Parameters
- attributeName: A
Returns Attributes[A] | undefined
Example
```
get name(): string {
   return super.get("name");
}
```
Inherited from dia.Link.get
- Defined in joint-core/types/mvc.d.ts:275

getAbsolutePointFromRelative

getAbsolutePointFromRelative(x: number, y: number): Point
Parameters
- x: number
- y: number
Returns Point
Inherited from dia.Link.getAbsolutePointFromRelative
- Defined in joint-core/types/dia.d.ts:786
getAbsolutePointFromRelative(relativePoint: PlainPoint): Point
Parameters
- relativePoint: PlainPoint
Returns Point
Inherited from dia.Link.getAbsolutePointFromRelative
- Defined in joint-core/types/dia.d.ts:787

getAncestors

getAncestors(): Cell<Attributes<Selectors>, ModelSetOptions>[]
Returns Cell<Attributes<Selectors>, ModelSetOptions>[]
Inherited from dia.Link.getAncestors
- Defined in joint-core/types/dia.d.ts:717

getBBox

getBBox(): Rect
Returns Rect
Inherited from dia.Link.getBBox
- Defined in joint-core/types/dia.d.ts:1114

getCenter

getCenter(): Point
Returns Point
Inherited from dia.Link.getCenter
- Defined in joint-core/types/dia.d.ts:776

getChangeFlag

getChangeFlag(attributes: { [key: string]: number }): number
Parameters
- attributes: { [key: string]: number }
Returns number
Inherited from dia.Link.getChangeFlag
- Defined in joint-core/types/dia.d.ts:789

getEmbeddedCells

getEmbeddedCells(
opt?: GetEmbeddedCellsOptions,
): Cell<Attributes<Selectors>, ModelSetOptions>[]
Parameters
- Optionalopt: GetEmbeddedCellsOptions
Returns Cell<Attributes<Selectors>, ModelSetOptions>[]
Inherited from dia.Link.getEmbeddedCells
- Defined in joint-core/types/dia.d.ts:719

getParentCell

getParentCell(): Cell<Attributes<Selectors>, ModelSetOptions> | null
Returns Cell<Attributes<Selectors>, ModelSetOptions> | null
Inherited from dia.Link.getParentCell
- Defined in joint-core/types/dia.d.ts:715

getPointFromConnectedLink

getPointFromConnectedLink(link: Link, endType: LinkEnd): Point
Parameters
- link: Link
- endType: LinkEnd
Returns Point
Inherited from dia.Link.getPointFromConnectedLink
- Defined in joint-core/types/dia.d.ts:778

getPointRotatedAroundCenter

getPointRotatedAroundCenter(angle: number, x: number, y: number): Point
Parameters
- angle: number
- x: number
- y: number
Returns Point
Inherited from dia.Link.getPointRotatedAroundCenter
- Defined in joint-core/types/dia.d.ts:780
getPointRotatedAroundCenter(angle: number, point: PlainPoint): Point
Parameters
- angle: number
- point: PlainPoint
Returns Point
Inherited from dia.Link.getPointRotatedAroundCenter
- Defined in joint-core/types/dia.d.ts:781

getPolyline

getPolyline(): Polyline
Returns Polyline
Inherited from dia.Link.getPolyline
- Defined in joint-core/types/dia.d.ts:1108

getRelationshipAncestor

getRelationshipAncestor(): | Element<Attributes<Selectors>, ModelSetOptions>
| undefined
Returns Element<Attributes<Selectors>, ModelSetOptions> | undefined
Inherited from dia.Link.getRelationshipAncestor
- Defined in joint-core/types/dia.d.ts:1118

getRelativePointFromAbsolute

getRelativePointFromAbsolute(x: number, y: number): Point
Parameters
- x: number
- y: number
Returns Point
Inherited from dia.Link.getRelativePointFromAbsolute
- Defined in joint-core/types/dia.d.ts:783
getRelativePointFromAbsolute(absolutePoint: PlainPoint): Point
Parameters
- absolutePoint: PlainPoint
Returns Point
Inherited from dia.Link.getRelativePointFromAbsolute
- Defined in joint-core/types/dia.d.ts:784

getSourceCell

getSourceCell(): Cell<Attributes<Selectors>, ModelSetOptions> | null
Returns Cell<Attributes<Selectors>, ModelSetOptions> | null
Inherited from dia.Link.getSourceCell
- Defined in joint-core/types/dia.d.ts:1104

getSourceElement

getSourceElement(): Element<Attributes<Selectors>, ModelSetOptions> | null
Returns Element<Attributes<Selectors>, ModelSetOptions> | null
Inherited from dia.Link.getSourceElement
- Defined in joint-core/types/dia.d.ts:1100

getSourcePoint

getSourcePoint(): Point
Returns Point
Inherited from dia.Link.getSourcePoint
- Defined in joint-core/types/dia.d.ts:1110

getTargetCell

getTargetCell(): Cell<Attributes<Selectors>, ModelSetOptions> | null
Returns Cell<Attributes<Selectors>, ModelSetOptions> | null
Inherited from dia.Link.getTargetCell
- Defined in joint-core/types/dia.d.ts:1106

getTargetElement

getTargetElement(): Element<Attributes<Selectors>, ModelSetOptions> | null
Returns Element<Attributes<Selectors>, ModelSetOptions> | null
Inherited from dia.Link.getTargetElement
- Defined in joint-core/types/dia.d.ts:1102

getTargetPoint

getTargetPoint(): Point
Returns Point
Inherited from dia.Link.getTargetPoint
- Defined in joint-core/types/dia.d.ts:1112

getTransitions

getTransitions(): string[]
Returns string[]
Inherited from dia.Link.getTransitions
- Defined in joint-core/types/dia.d.ts:743

has

has(attribute: _StringKey<Attributes>): boolean
Parameters
- attribute: _StringKey<Attributes>
Returns boolean
Inherited from dia.Link.has
- Defined in joint-core/types/mvc.d.ts:300

hasChanged

hasChanged(attribute?: _StringKey<Attributes>): boolean
Parameters
- Optionalattribute: _StringKey<Attributes>
Returns boolean
Inherited from dia.Link.hasChanged
- Defined in joint-core/types/mvc.d.ts:301

hasLabels

hasLabels(): boolean
Returns boolean
Inherited from dia.Link.hasLabels
- Defined in joint-core/types/dia.d.ts:1080

hasLoop

hasLoop(opt?: EmbeddableOptions<boolean>): boolean
Parameters
- Optionalopt: EmbeddableOptions<boolean>
Returns boolean
Inherited from dia.Link.hasLoop
- Defined in joint-core/types/dia.d.ts:1116

initialize

initialize(attributes?: Attributes, options?: any): void
Parameters
- Optionalattributes: Attributes
- Optionaloptions: any
Returns void
Inherited from dia.Link.initialize
- Defined in joint-core/types/mvc.d.ts:265

insertLabel

insertLabel(index: number, label: Label, opt?: ModelSetOptions): Label[]
Parameters
- index: number
- label: Label
- Optionalopt: ModelSetOptions
Returns Label[]
Inherited from dia.Link.insertLabel
- Defined in joint-core/types/dia.d.ts:1082

insertVertex

insertVertex(index: number, vertex: Vertex, opt?: ModelSetOptions): Vertex[]
Parameters
- index: number
- vertex: Vertex
- Optionalopt: ModelSetOptions
Returns Vertex[]
Inherited from dia.Link.insertVertex
- Defined in joint-core/types/dia.d.ts:1094

isElement

isElement(): this is Element<Attributes<Selectors>, ModelSetOptions>
Returns this is Element<Attributes<Selectors>, ModelSetOptions>
Inherited from dia.Link.isElement
- Defined in joint-core/types/dia.d.ts:759

isEmbedded

isEmbedded(): boolean
Returns boolean
Inherited from dia.Link.isEmbedded
- Defined in joint-core/types/dia.d.ts:723

isEmbeddedIn

isEmbeddedIn(cell: Cell, opt?: EmbeddableOptions<boolean>): boolean
Parameters
- cell: Cell
- Optionalopt: EmbeddableOptions<boolean>
Returns boolean
Inherited from dia.Link.isEmbeddedIn
- Defined in joint-core/types/dia.d.ts:721

isLink

isLink(): this is Link<Attributes<Selectors>, ModelSetOptions>
Returns this is Link<Attributes<Selectors>, ModelSetOptions>
Inherited from dia.Link.isLink
- Defined in joint-core/types/dia.d.ts:757

isRelationshipEmbeddedIn

isRelationshipEmbeddedIn(cell: Cell): boolean
Parameters
- cell: Cell
Returns boolean
Inherited from dia.Link.isRelationshipEmbeddedIn
- Defined in joint-core/types/dia.d.ts:1120

isValid

isValid(options?: any): boolean
Parameters
- Optionaloptions: any
Returns boolean
Inherited from dia.Link.isValid
- Defined in joint-core/types/mvc.d.ts:302

label

label(index?: number): Label
Parameters
- Optionalindex: number
Returns Label
Inherited from dia.Link.label
- Defined in joint-core/types/dia.d.ts:1074
label(index: number, label: Label, opt?: ModelSetOptions): this
Parameters
- index: number
- label: Label
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.label
- Defined in joint-core/types/dia.d.ts:1075

labels

labels(): Label[]
Returns Label[]
Inherited from dia.Link.labels
- Defined in joint-core/types/dia.d.ts:1077
labels(labels: Label[], opt?: ModelSetOptions): this
Parameters
- labels: Label[]
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.labels
- Defined in joint-core/types/dia.d.ts:1078

layer

layer(): string | null
Returns string | null
Inherited from dia.Link.layer
- Defined in joint-core/types/dia.d.ts:769
layer(id: string | null, opt?: Options): this
Parameters
- id: string | null
- Optionalopt: Options
Returns this
Inherited from dia.Link.layer
- Defined in joint-core/types/dia.d.ts:770

listenTo

listenTo(object: any, events: string, callback: EventHandler): this
Parameters
- object: any
- events: string
- callback: EventHandler
Returns this
Inherited from dia.Link.listenTo
- Defined in joint-core/types/mvc.d.ts:216
listenTo(object: any, eventMap: EventMap): this
Parameters
- object: any
- eventMap: EventMap
Returns this
Inherited from dia.Link.listenTo
- Defined in joint-core/types/mvc.d.ts:217

listenToOnce

listenToOnce(object: any, events: string, callback: EventHandler): this
Parameters
- object: any
- events: string
- callback: EventHandler
Returns this
Inherited from dia.Link.listenToOnce
- Defined in joint-core/types/mvc.d.ts:218
listenToOnce(object: any, eventMap: EventMap): this
Parameters
- object: any
- eventMap: EventMap
Returns this
Inherited from dia.Link.listenToOnce
- Defined in joint-core/types/mvc.d.ts:219

off

off(
    eventName?: string | null,
    callback?: EventHandler | null,
    context?: any,
): this
Parameters
- OptionaleventName: string | null
- Optionalcallback: EventHandler | null
- Optionalcontext: any
Returns this
Inherited from dia.Link.off
- Defined in joint-core/types/mvc.d.ts:208

on

on(eventName: string, callback: EventHandler, context?: any): this
Parameters
- eventName: string
- callback: EventHandler
- Optionalcontext: any
Returns this
Inherited from dia.Link.on
- Defined in joint-core/types/mvc.d.ts:206
on(eventMap: EventMap, context?: any): this
Parameters
- eventMap: EventMap
- Optionalcontext: any
Returns this
Inherited from dia.Link.on
- Defined in joint-core/types/mvc.d.ts:207

once

once(events: string, callback: EventHandler, context?: any): this
Parameters
- events: string
- callback: EventHandler
- Optionalcontext: any
Returns this
Inherited from dia.Link.once
- Defined in joint-core/types/mvc.d.ts:214
once(eventMap: EventMap, context?: any): this
Parameters
- eventMap: EventMap
- Optionalcontext: any
Returns this
Inherited from dia.Link.once
- Defined in joint-core/types/mvc.d.ts:215

parent

parent(): string
Returns string
Inherited from dia.Link.parent
- Defined in joint-core/types/dia.d.ts:713

position

position(): Point
Returns Point
Inherited from dia.Link.position
- Defined in joint-core/types/dia.d.ts:765

preinitialize

preinitialize(attributes?: Attributes, options?: any): void
For use with models as ES classes. If you define a preinitialize method, it will be invoked when the Model is first created, before any instantiation logic is run for the Model.
Parameters
- Optionalattributes: Attributes
- Optionaloptions: any
Returns void
Inherited from dia.Link.preinitialize
- Defined in joint-core/types/mvc.d.ts:262

previous<A extends string>(attribute: A): Attributes[A] | null | undefined
Type Parameters
- A extends string
Parameters
- attribute: A
Returns Attributes[A] | null | undefined
Inherited from dia.Link.previous
- Defined in joint-core/types/mvc.d.ts:303

previousAttributes

previousAttributes(): Partial<T>
Returns Partial<T>
Inherited from dia.Link.previousAttributes
- Defined in joint-core/types/mvc.d.ts:304

prop

prop(key: Path): any
Parameters
- key: Path
Returns any
Inherited from dia.Link.prop
- Defined in joint-core/types/dia.d.ts:725
prop(object: DeepPartial<A>, opt?: Options): this
Parameters
- object: DeepPartial<A>
- Optionalopt: Options
Returns this
Inherited from dia.Link.prop
- Defined in joint-core/types/dia.d.ts:726
prop(key: Path, value: any, opt?: Options): this
Parameters
- key: Path
- value: any
- Optionalopt: Options
Returns this
Inherited from dia.Link.prop
- Defined in joint-core/types/dia.d.ts:727

remove

remove(opt?: RemoveCellOptions): this
Parameters
- Optionalopt: RemoveCellOptions
Returns this
Inherited from dia.Link.remove
- Defined in joint-core/types/dia.d.ts:707

removeAttr

removeAttr(path: Path, opt?: Options): this
Parameters
- path: Path
- Optionalopt: Options
Returns this
Inherited from dia.Link.removeAttr
- Defined in joint-core/types/dia.d.ts:739

removeLabel

removeLabel(index?: number, opt?: ModelSetOptions): Label[]
Parameters
- Optionalindex: number
- Optionalopt: ModelSetOptions
Returns Label[]
Inherited from dia.Link.removeLabel
- Defined in joint-core/types/dia.d.ts:1086

removeProp

removeProp(path: Path, opt?: Options): this
Parameters
- path: Path
- Optionalopt: Options
Returns this
Inherited from dia.Link.removeProp
- Defined in joint-core/types/dia.d.ts:729

removeVertex

removeVertex(index?: number, opt?: ModelSetOptions): Vertex[]
Parameters
- Optionalindex: number
- Optionalopt: ModelSetOptions
Returns Vertex[]
Inherited from dia.Link.removeVertex
- Defined in joint-core/types/dia.d.ts:1096

reparent

reparent(opt?: ModelSetOptions): Element
Parameters
- Optionalopt: ModelSetOptions
Returns Element
Inherited from dia.Link.reparent
- Defined in joint-core/types/dia.d.ts:1098

router

router(): Router | RouterJSON | null
Returns Router | RouterJSON | null
Inherited from dia.Link.router
- Defined in joint-core/types/dia.d.ts:1066
router(router: Router | RouterJSON, opt?: ModelSetOptions): this
Parameters
- router: Router | RouterJSON
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.router
- Defined in joint-core/types/dia.d.ts:1067
router(
    name: keyof RouterArgumentsMap,
    args?: { [key: string]: any },
    opt?: ModelSetOptions,
): this
Parameters
- name: keyof RouterArgumentsMap
- Optionalargs: { [key: string]: any }
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.router
- Defined in joint-core/types/dia.d.ts:1068

scale

scale(sx: number, sy: number, origin?: PlainPoint, opt?: ModelSetOptions): this
Parameters
- sx: number
- sy: number
- Optionalorigin: PlainPoint
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.scale
- Defined in joint-core/types/dia.d.ts:1124

set

set<A extends string>(
    attributeName: A,
    value?: Attributes[A],
    options?: ModelSetOptions,
): this
For strongly-typed assignment of attributes, use the set method only privately in public setter properties.
Type Parameters
- A extends string
Parameters
- attributeName: A
- Optionalvalue: Attributes[A]
- Optionaloptions: ModelSetOptions
Returns this
Example
```
set name(value: string) {
   super.set("name", value);
}
```
Inherited from dia.Link.set
- Defined in joint-core/types/mvc.d.ts:284
set(attributeName: Partial<T>, options?: ModelSetOptions): this
For strongly-typed assignment of attributes, use the set method only privately in public setter properties.
Parameters
- attributeName: Partial<T>
- Optionaloptions: ModelSetOptions
Returns this
Example
```
set name(value: string) {
   super.set("name", value);
}
```
Inherited from dia.Link.set
- Defined in joint-core/types/mvc.d.ts:285
set<A extends string>(
    attributeName: Partial<Attributes> | A,
    value?: ModelSetOptions | Attributes[A],
    options?: ModelSetOptions,
): this
For strongly-typed assignment of attributes, use the set method only privately in public setter properties.
Type Parameters
- A extends string
Parameters
- attributeName: Partial<Attributes> | A
- Optionalvalue: ModelSetOptions | Attributes[A]
- Optionaloptions: ModelSetOptions
Returns this
Example
```
set name(value: string) {
   super.set("name", value);
}
```
Inherited from dia.Link.set
- Defined in joint-core/types/mvc.d.ts:286

source

source(): EndJSON
Returns EndJSON
Inherited from dia.Link.source
- Defined in joint-core/types/dia.d.ts:1058
source(source: EndJSON, opt?: ModelSetOptions): this
Parameters
- source: EndJSON
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.source
- Defined in joint-core/types/dia.d.ts:1059
source(source: Cell, args?: EndCellArgs, opt?: ModelSetOptions): this
Parameters
- source: Cell
- Optionalargs: EndCellArgs
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.source
- Defined in joint-core/types/dia.d.ts:1060

startBatch

startBatch(name: string, opt?: Options): this
Parameters
- name: string
- Optionalopt: Options
Returns this
Inherited from dia.Link.startBatch
- Defined in joint-core/types/dia.d.ts:761

stopBatch

stopBatch(name: string, opt?: Options): this
Parameters
- name: string
- Optionalopt: Options
Returns this
Inherited from dia.Link.stopBatch
- Defined in joint-core/types/dia.d.ts:763

stopListening

stopListening(object?: any, events?: string, callback?: EventHandler): this
Parameters
- Optionalobject: any
- Optionalevents: string
- Optionalcallback: EventHandler
Returns this
Inherited from dia.Link.stopListening
- Defined in joint-core/types/mvc.d.ts:220

stopTransitions

stopTransitions(path?: Path, delim?: string): this
Parameters
- Optionalpath: Path
- Optionaldelim: string
Returns this
Inherited from dia.Link.stopTransitions
- Defined in joint-core/types/dia.d.ts:745

target

target(): EndJSON
Returns EndJSON
Inherited from dia.Link.target
- Defined in joint-core/types/dia.d.ts:1062
target(target: EndJSON, opt?: ModelSetOptions): this
Parameters
- target: EndJSON
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.target
- Defined in joint-core/types/dia.d.ts:1063
target(target: Cell, args?: EndCellArgs, opt?: ModelSetOptions): this
Parameters
- target: Cell
- Optionalargs: EndCellArgs
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.target
- Defined in joint-core/types/dia.d.ts:1064

toBack

toBack(opt?: ToFrontAndBackOptions): this
Parameters
- Optionalopt: ToFrontAndBackOptions
Returns this
Inherited from dia.Link.toBack
- Defined in joint-core/types/dia.d.ts:711

toFront

toFront(opt?: ToFrontAndBackOptions): this
Parameters
- Optionalopt: ToFrontAndBackOptions
Returns this
Inherited from dia.Link.toFront
- Defined in joint-core/types/dia.d.ts:709

toJSON

toJSON(opt?: ExportOptions): JSON<any, Attributes>
Parameters
- Optionalopt: ExportOptions
Returns JSON<any, Attributes>
Inherited from dia.Link.toJSON
- Defined in joint-core/types/dia.d.ts:705

transition

transition(
    path: Path,
    value?: any,
    opt?: TransitionOptions,
    delim?: string,
): number
Parameters
- path: Path
- Optionalvalue: any
- Optionalopt: TransitionOptions
- Optionaldelim: string
Returns number
Inherited from dia.Link.transition
- Defined in joint-core/types/dia.d.ts:741

translate

translate(tx: number, ty: number, opt?: ModelSetOptions): this
Parameters
- tx: number
- ty: number
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.translate
- Defined in joint-core/types/dia.d.ts:1126

trigger

trigger(eventName: string, ...args: any[]): this
Parameters
- eventName: string
- ...args: any[]
Returns this
Inherited from dia.Link.trigger
- Defined in joint-core/types/mvc.d.ts:209

unbind

unbind(eventName?: string, callback?: EventHandler, context?: any): this
Parameters
- OptionaleventName: string
- Optionalcallback: EventHandler
- Optionalcontext: any
Returns this
Inherited from dia.Link.unbind
- Defined in joint-core/types/mvc.d.ts:212

unembed

unembed(
    cell:
        | Cell<Attributes<Selectors>, ModelSetOptions>
        | Cell<Attributes<Selectors>, ModelSetOptions>[],
    opt?: Options,
): this
Parameters
- cell:
  | Cell<Attributes<Selectors>, ModelSetOptions>
  | Cell<Attributes<Selectors>, ModelSetOptions>[]
- Optionalopt: Options
Returns this
Inherited from dia.Link.unembed
- Defined in joint-core/types/dia.d.ts:749

unset

unset(attribute: _StringKey<Attributes>, options?: Silenceable): this
Parameters
- attribute: _StringKey<Attributes>
- Optionaloptions: Silenceable
Returns this
Inherited from dia.Link.unset
- Defined in joint-core/types/mvc.d.ts:305

validate

validate(attributes: Partial<T>, options?: any): any
Parameters
- attributes: Partial<T>
- Optionaloptions: any
Returns any
Inherited from dia.Link.validate
- Defined in joint-core/types/mvc.d.ts:306

vertex

vertex(index?: number): Vertex
Parameters
- Optionalindex: number
Returns Vertex
Inherited from dia.Link.vertex
- Defined in joint-core/types/dia.d.ts:1088
vertex(index: number, vertex: Vertex, opt?: ModelSetOptions): this
Parameters
- index: number
- vertex: Vertex
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.vertex
- Defined in joint-core/types/dia.d.ts:1089

vertices

vertices(): Vertex[]
Returns Vertex[]
Inherited from dia.Link.vertices
- Defined in joint-core/types/dia.d.ts:1091
vertices(vertices: Vertex[], opt?: ModelSetOptions): this
Parameters
- vertices: Vertex[]
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Link.vertices
- Defined in joint-core/types/dia.d.ts:1092

z

z(): number
Returns number
Inherited from dia.Link.z
- Defined in joint-core/types/dia.d.ts:767

`Static`define

define(
    type: string,
    defaults?: any,
    protoProps?: any,
    staticProps?: any,
): Constructor<Link<Attributes<Selectors>, ModelSetOptions>>
Parameters
- type: string
- Optionaldefaults: any
- OptionalprotoProps: any
- OptionalstaticProps: any
Returns Constructor<Link<Attributes<Selectors>, ModelSetOptions>>
Inherited from dia.Link.define
- Defined in joint-core/types/dia.d.ts:1128

`Static`extend

extend(properties: any, classProperties?: any): any
Do not use, prefer TypeScript's extend functionality.
Parameters
- properties: any
- OptionalclassProperties: any
Returns any
Inherited from dia.Link.extend
- Defined in joint-core/types/mvc.d.ts:235

`Static`getAttributeDefinition

getAttributeDefinition(
attrName: string,
): PresentationAttributeDefinition<CellView> | null
Parameters
- attrName: string
Returns PresentationAttributeDefinition<CellView> | null
Inherited from dia.Link.getAttributeDefinition
- Defined in joint-core/types/dia.d.ts:793

Properties

arrowHeadMarkup

arrowHeadMarkup: string

attributes

attributes: Partial<T>

changed

changed: Partial<T>

cid

cid: string

cidPrefix

cidPrefix: string

collection

collection: Collection<LinkModel<Attributes>>

`Optional`defaultLabel

defaultLabel?: Label

`Optional`doubleToolMarkup

doubleToolMarkup?: string

graph

graph: Graph

id

id: ID

idAttribute

idAttribute: string

`Optional`labelMarkup

labelMarkup?: string | MarkupJSON

Deprecated

use defaultLabel.markup instead

markup

markup: MarkupJSON = ...

Markup with two paths: a wide, transparent wrapper that widens the pointer hit area, and the visible line. React content (if any) mounts into the link's root <g> via RenderLink.

portalSelector

portalSelector: string = 'root'

Selector of the node in this cell's view where @joint/react mounts React content, the link's root <g> ('root'). The markup keeps no dedicated portal group so React-less links stay lean; the experimental RenderLink mounts here when enabled.

toolMarkup

toolMarkup: string

useCSSSelectors

useCSSSelectors: boolean

validationError

validationError: any

vertexMarkup

vertexMarkup: string

`Static`attributes

attributes: {
    [attributeName: string]: PresentationAttributeDefinition<
        LinkView<Link<Attributes<Selectors>, ModelSetOptions>>,
    >;
}

Class LinkModel<Attributes>

Example

Type Parameters

Hierarchy

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Type Parameters

Parameters

Returns LinkModel<Attributes>

Methods

addTo

Parameters

Returns this

angle

Returns number

appendLabel

Parameters

Returns Label[]

applyToPoints

Parameters

Returns this

attr

Parameters

Returns any

Parameters

Returns this

Parameters

Returns this

bind

Parameters

Returns this

Parameters

Returns this

canEmbed

Parameters

Returns boolean

changedAttributes

Parameters

Returns false | Partial<Attributes>

clear

Parameters

Returns this

clone

Returns this

Parameters

Returns this

Parameters

Returns Cell<Attributes<Selectors>, ModelSetOptions>[]

connector

Returns Connector | ConnectorJSON | null

Parameters

Returns this

Parameters

Returns this

defaults

Returns Attributes

disconnect

Returns this

embed

Parameters

Returns this

escape

Parameters

Returns string

findView

Parameters

Returns CellView

get

Type Parameters

Parameters

Returns Attributes[A] | undefined

Example

getAbsolutePointFromRelative

Parameters

Returns Point