Class ElementModel<Attributes>

The element class @joint/react registers and uses by default for every element you add to the graph. Its markup carries a dedicated <g> group (the '__portal__' selector) where your RenderElement output is mounted, so React content renders beneath the element's ports and highlighters. Extend it to customize the markup or default attributes, or supply any dia.Element subclass that implements PortalHostCell to host React content yourself.

Example

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

const element = new ElementModel({
  id: '1',
  position: { x: 10, y: 20 },
  size: { width: 100, height: 50 },
});

Type Parameters

Attributes extends dia.Element.Attributes = dia.Element.Attributes

Hierarchy

Element<Attributes>
- ElementModel

Implements

PortalHostCell

Index

Constructors

constructor

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

Methods

addPort

addPort(port: Port, opt?: ModelSetOptions): this
Parameters
- port: Port
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Element.addPort
- Defined in joint-core/types/dia.d.ts:945

addPorts

addPorts(ports: Port[], opt?: ModelSetOptions): this
Parameters
- ports: Port[]
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Element.addPorts
- Defined in joint-core/types/dia.d.ts:947

addTo

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

angle

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

attr

attr(key?: Path): any
Parameters
- Optionalkey: Path
Returns any
Inherited from dia.Element.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.Element.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.Element.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.Element.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.Element.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.Element.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.Element.changedAttributes
- Defined in joint-core/types/mvc.d.ts:296

clear

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

clone

clone(): this
Returns this
Inherited from dia.Element.clone
- Defined in joint-core/types/dia.d.ts:735
clone(opt: EmbeddableOptions<false>): this
Parameters
- opt: EmbeddableOptions<false>
Returns this
Inherited from dia.Element.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.Element.clone
- Defined in joint-core/types/dia.d.ts:737

defaults

defaults(): Attributes
Default attributes applied to every ElementModel: the 'element' type, a 0x0 size, and an empty data object.

Returns Attributes
The default attributes.
Overrides dia.Element.defaults
- Defined in joint-react/src/mvc/element-model.tsx:64

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.Element.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.Element.escape
- Defined in joint-core/types/mvc.d.ts:299

findView

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

fitEmbeds

fitEmbeds(opt?: FitToChildrenOptions): this
Parameters
- Optionalopt: FitToChildrenOptions
Returns this
Inherited from dia.Element.fitEmbeds
- Defined in joint-core/types/dia.d.ts:938

fitParent

fitParent(opt?: FitParentOptions): this
Parameters
- Optionalopt: FitParentOptions
Returns this
Inherited from dia.Element.fitParent
- Defined in joint-core/types/dia.d.ts:941

fitToChildren

fitToChildren(opt?: FitToChildrenOptions): this
Parameters
- Optionalopt: FitToChildrenOptions
Returns this
Inherited from dia.Element.fitToChildren
- Defined in joint-core/types/dia.d.ts:939

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.Element.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.Element.getAbsolutePointFromRelative
- Defined in joint-core/types/dia.d.ts:786
getAbsolutePointFromRelative(relativePoint: PlainPoint): Point
Parameters
- relativePoint: PlainPoint
Returns Point
Inherited from dia.Element.getAbsolutePointFromRelative
- Defined in joint-core/types/dia.d.ts:787

getAncestors

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

getBBox

getBBox(opt?: BBoxOptions): Rect
Parameters
- Optionalopt: BBoxOptions
Returns Rect
Inherited from dia.Element.getBBox
- Defined in joint-core/types/dia.d.ts:943

getCenter

getCenter(): Point
Returns Point
Inherited from dia.Element.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.Element.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.Element.getEmbeddedCells
- Defined in joint-core/types/dia.d.ts:719

getGroupPorts

getGroupPorts(groupName: string): Port[]
Parameters
- groupName: string
Returns Port[]
Inherited from dia.Element.getGroupPorts
- Defined in joint-core/types/dia.d.ts:962

getParentCell

getParentCell(): Cell<Attributes<Selectors>, ModelSetOptions> | null
Returns Cell<Attributes<Selectors>, ModelSetOptions> | null
Inherited from dia.Element.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.Element.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.Element.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.Element.getPointRotatedAroundCenter
- Defined in joint-core/types/dia.d.ts:781

getPort

getPort(id: string): Port
Parameters
- id: string
Returns Port
Inherited from dia.Element.getPort
- Defined in joint-core/types/dia.d.ts:964

getPortBBox

getPortBBox(portId: string, opt?: RotateOptions): Rect
Parameters
- portId: string
- Optionalopt: RotateOptions
Returns Rect
Inherited from dia.Element.getPortBBox
- Defined in joint-core/types/dia.d.ts:974

getPortCenter

getPortCenter(portId: string): Point
Parameters
- portId: string
Returns Point
Inherited from dia.Element.getPortCenter
- Defined in joint-core/types/dia.d.ts:972

getPortGroupNames

getPortGroupNames(): string[]
Returns string[]
Inherited from dia.Element.getPortGroupNames
- Defined in joint-core/types/dia.d.ts:978

getPortIndex

getPortIndex(port: string | Port): number
Parameters
- port: string | Port
Returns number
Inherited from dia.Element.getPortIndex
- Defined in joint-core/types/dia.d.ts:976

getPortRelativePosition

getPortRelativePosition(portId: string): PortPosition
Parameters
- portId: string
Returns PortPosition
Inherited from dia.Element.getPortRelativePosition
- Defined in joint-core/types/dia.d.ts:968

getPortRelativeRect

getPortRelativeRect(portId: string): PortRect
Parameters
- portId: string
Returns PortRect
Inherited from dia.Element.getPortRelativeRect
- Defined in joint-core/types/dia.d.ts:970

getPorts

getPorts(): Port[]
Returns Port[]
Inherited from dia.Element.getPorts
- Defined in joint-core/types/dia.d.ts:960

getPortsPositions

getPortsPositions(groupName: string): { [id: string]: PortPosition }
Parameters
- groupName: string
Returns { [id: string]: PortPosition }
Inherited from dia.Element.getPortsPositions
- Defined in joint-core/types/dia.d.ts:966

getRelativePointFromAbsolute

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

getTransitions

getTransitions(): string[]
Returns string[]
Inherited from dia.Element.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.Element.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.Element.hasChanged
- Defined in joint-core/types/mvc.d.ts:301

hasPort

hasPort(id: string): boolean
Parameters
- id: string
Returns boolean
Inherited from dia.Element.hasPort
- Defined in joint-core/types/dia.d.ts:958

hasPorts

hasPorts(): boolean
Returns boolean
Inherited from dia.Element.hasPorts
- Defined in joint-core/types/dia.d.ts:956

initialize

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

insertPort

insertPort(
    before: string | number | Port,
    port: Port,
    opt?: ModelSetOptions,
): this
Parameters
- before: string | number | Port
- port: Port
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Element.insertPort
- Defined in joint-core/types/dia.d.ts:949

isElement

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

isEmbedded

isEmbedded(): boolean
Returns boolean
Inherited from dia.Element.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.Element.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.Element.isLink
- Defined in joint-core/types/dia.d.ts:757

isValid

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

layer

layer(): string | null
Returns string | null
Inherited from dia.Element.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.Element.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.Element.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.Element.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.Element.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.Element.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.Element.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.Element.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.Element.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.Element.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.Element.once
- Defined in joint-core/types/mvc.d.ts:215

parent

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

portProp

portProp(portId: string, path: Path): any
Parameters
- portId: string
- path: Path
Returns any
Inherited from dia.Element.portProp
- Defined in joint-core/types/dia.d.ts:980
portProp(
    portId: string,
    path: Path,
    value?: any,
    opt?: ModelSetOptions,
): Element
Parameters
- portId: string
- path: Path
- Optionalvalue: any
- Optionalopt: ModelSetOptions
Returns Element
Inherited from dia.Element.portProp
- Defined in joint-core/types/dia.d.ts:982

position

position(opt?: PositionOptions): Point
Parameters
- Optionalopt: PositionOptions
Returns Point
Inherited from dia.Element.position
- Defined in joint-core/types/dia.d.ts:923
position(x: number, y: number, opt?: PositionOptions): this
Parameters
- x: number
- y: number
- Optionalopt: PositionOptions
Returns this
Inherited from dia.Element.position
- Defined in joint-core/types/dia.d.ts:924

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.Element.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.Element.previous
- Defined in joint-core/types/mvc.d.ts:303

previousAttributes

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

prop

prop(key: Path): any
Parameters
- key: Path
Returns any
Inherited from dia.Element.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.Element.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.Element.prop
- Defined in joint-core/types/dia.d.ts:727

remove

remove(opt?: RemoveCellOptions): this
Parameters
- Optionalopt: RemoveCellOptions
Returns this
Inherited from dia.Element.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.Element.removeAttr
- Defined in joint-core/types/dia.d.ts:739

removePort

removePort(port: string | Port, opt?: ModelSetOptions): this
Parameters
- port: string | Port
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Element.removePort
- Defined in joint-core/types/dia.d.ts:951

removePorts

removePorts(opt?: ModelSetOptions): this
Parameters
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Element.removePorts
- Defined in joint-core/types/dia.d.ts:953
removePorts(ports: (string | Port)[], opt?: ModelSetOptions): this
Parameters
- ports: (string | Port)[]
- Optionalopt: ModelSetOptions
Returns this
Inherited from dia.Element.removePorts
- Defined in joint-core/types/dia.d.ts:954

removeProp

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

resize

resize(width: number, height: number, opt?: ResizeOptions): this
Parameters
- width: number
- height: number
- Optionalopt: ResizeOptions
Returns this
Inherited from dia.Element.resize
- Defined in joint-core/types/dia.d.ts:930

rotate

rotate(
    deg: number,
    absolute?: boolean,
    origin?: PlainPoint,
    opt?: { [key: string]: any },
): this
Parameters
- deg: number
- Optionalabsolute: boolean
- Optionalorigin: PlainPoint
- Optionalopt: { [key: string]: any }
Returns this
Inherited from dia.Element.rotate
- Defined in joint-core/types/dia.d.ts:932

scale

scale(
    scaleX: number,
    scaleY: number,
    origin?: PlainPoint,
    opt?: { [key: string]: any },
): this
Parameters
- scaleX: number
- scaleY: number
- Optionalorigin: PlainPoint
- Optionalopt: { [key: string]: any }
Returns this
Inherited from dia.Element.scale
- Defined in joint-core/types/dia.d.ts:936

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.Element.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.Element.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.Element.set
- Defined in joint-core/types/mvc.d.ts:286

size

size(): Size
Returns Size
Inherited from dia.Element.size
- Defined in joint-core/types/dia.d.ts:926
size(size: Partial<Size>, opt?: ResizeOptions): this
Parameters
- size: Partial<Size>
- Optionalopt: ResizeOptions
Returns this
Inherited from dia.Element.size
- Defined in joint-core/types/dia.d.ts:927
size(width: number, height: number, opt?: ResizeOptions): this
Parameters
- width: number
- height: number
- Optionalopt: ResizeOptions
Returns this
Inherited from dia.Element.size
- Defined in joint-core/types/dia.d.ts:928

startBatch

startBatch(name: string, opt?: Options): this
Parameters
- name: string
- Optionalopt: Options
Returns this
Inherited from dia.Element.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.Element.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.Element.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.Element.stopTransitions
- Defined in joint-core/types/dia.d.ts:745

toBack

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

toFront

toFront(opt?: ToFrontAndBackOptions): this
Parameters
- Optionalopt: ToFrontAndBackOptions
Returns this
Inherited from dia.Element.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.Element.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.Element.transition
- Defined in joint-core/types/dia.d.ts:741

translate

translate(tx: number, ty?: number, opt?: TranslateOptions): this
Parameters
- tx: number
- Optionalty: number
- Optionalopt: TranslateOptions
Returns this
Inherited from dia.Element.translate
- Defined in joint-core/types/dia.d.ts:921

trigger

trigger(eventName: string, ...args: any[]): this
Parameters
- eventName: string
- ...args: any[]
Returns this
Inherited from dia.Element.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.Element.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.Element.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.Element.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.Element.validate
- Defined in joint-core/types/mvc.d.ts:306

z

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

`Static`define

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

`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.Element.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.Element.getAttributeDefinition
- Defined in joint-core/types/dia.d.ts:793

Properties

attributes

attributes: Partial<T>

changed

changed: Partial<T>

cid

cid: string

cidPrefix

cidPrefix: string

collection

collection: Collection<ElementModel<Attributes>>

graph

graph: Graph

id

id: ID

idAttribute

idAttribute: string

markup

markup: MarkupJSON = ...

Markup with a single <g> group ('__portal__') that hosts the React portal. JointJS appends ports and highlighters after this group, so they paint on top of your React content.

portalSelector

portalSelector: string = PORTAL_SELECTOR

Selector of the node in this cell's view where @joint/react mounts your RenderElement content, the '__portal__' <g> group.

useCSSSelectors

useCSSSelectors: boolean

validationError

validationError: any

`Static`attributes

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

Class ElementModel<Attributes>

Example

Type Parameters

Hierarchy

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Type Parameters

Parameters

Returns ElementModel<Attributes>

Methods

addPort

Parameters

Returns this

addPorts

Parameters

Returns this

addTo

Parameters

Returns this

angle

Returns number

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>[]

defaults

Returns Attributes

embed

Parameters

Returns this

escape

Parameters

Returns string

findView

Parameters

Returns CellView

fitEmbeds

Parameters

Returns this

fitParent

Parameters

Returns this

fitToChildren

Parameters

Returns this

get

Type Parameters

Parameters

Returns Attributes[A] | undefined

Example

getAbsolutePointFromRelative

Parameters