Class ReactElement<Attributes>

addPort

• addPort(port: Port, opt?: ModelSetOptions): this

  Parameters

  • port: Port
  • Optionalopt: ModelSetOptions

  Returns this

addPorts

• addPorts(ports: Port[], opt?: ModelSetOptions): this

  Parameters

  • ports: Port[]
  • Optionalopt: ModelSetOptions

  Returns this

addTo

• addTo(graph: Graph, opt?: Options): this

  Parameters

  • graph: Graph
  • Optionalopt: Options

  Returns this

angle

• angle(): number

  Returns number

attr

• attr(key?: Path): any

  Parameters

  • Optionalkey: Path

  Returns any

• attr(object: Selectors, opt?: Options): this

  Parameters

  • object: Selectors
  • Optionalopt: Options

  Returns this

• attr(key: Path, value: any, opt?: Options): this

  Parameters

  • key: Path
  • value: any
  • Optionalopt: Options

  Returns this

bind

• bind(eventName: string, callback: EventHandler, context?: any): this

  Parameters

  • eventName: string
  • callback: EventHandler
  • Optionalcontext: any

  Returns this

• bind(eventMap: EventMap, context?: any): this

  Parameters

  • eventMap: EventMap
  • Optionalcontext: any

  Returns this

canEmbed

• canEmbed(
      cell:
          | Cell<Attributes, ModelSetOptions>
          | Cell<Attributes, ModelSetOptions>[],
  ): boolean

  Parameters

  • cell: Cell<Attributes, ModelSetOptions> | Cell<Attributes, ModelSetOptions>[]

  Returns boolean

changedAttributes

• changedAttributes(
      attributes?: Partial<Attributes & Attributes>,
  ): false | Partial<Attributes & 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 & Attributes>

  Returns false | Partial<Attributes & Attributes>

clear

• clear(options?: Silenceable): this

  Parameters

  • Optionaloptions: Silenceable

  Returns this

clone

• clone(): this

  Returns this

• clone(opt: EmbeddableOptions<false>): this

  Parameters

  • opt: EmbeddableOptions<false>

  Returns this

• clone(opt: EmbeddableOptions<true>): Cell<Attributes, ModelSetOptions>[]

  Parameters

  • opt: EmbeddableOptions<true>

  Returns Cell<Attributes, ModelSetOptions>[]

embed

• embed(
      cell:
          | Cell<Attributes, ModelSetOptions>
          | Cell<Attributes, ModelSetOptions>[],
      opt?: EmbedOptions,
  ): this

  Parameters

  • cell: Cell<Attributes, ModelSetOptions> | Cell<Attributes, ModelSetOptions>[]
  • Optionalopt: EmbedOptions

  Returns this

escape

• escape(attribute: _StringKey<Attributes & Attributes>): string

  Parameters

  • attribute: _StringKey<Attributes & Attributes>

  Returns string

findView

• findView(paper: Paper): CellView

  Parameters

  • paper: Paper

  Returns CellView

fitEmbeds

• fitEmbeds(opt?: FitToChildrenOptions): this

  Parameters

  • Optionalopt: FitToChildrenOptions

  Returns this

fitParent

• fitParent(opt?: FitParentOptions): this

  Parameters

  • Optionalopt: FitParentOptions

  Returns this

fitToChildren

• fitToChildren(opt?: FitToChildrenOptions): this

  Parameters

  • Optionalopt: FitToChildrenOptions

  Returns this

get

• get<A extends string>(
      attributeName: A,
  ): undefined | (Attributes & Attributes)[A]

  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 undefined | (Attributes & Attributes)[A]

  Example

  get name(): string {
     return super.get("name");
  }
  Copy

getAbsolutePointFromRelative

• getAbsolutePointFromRelative(x: number, y: number): Point

  Parameters

  • x: number
  • y: number

  Returns Point

• getAbsolutePointFromRelative(relativePoint: PlainPoint): Point

  Parameters

  • relativePoint: PlainPoint

  Returns Point

getAncestors

• getAncestors(): Cell<Attributes, ModelSetOptions>[]

  Returns Cell<Attributes, ModelSetOptions>[]

getBBox

• getBBox(opt?: BBoxOptions): Rect

  Parameters

  • Optionalopt: BBoxOptions

  Returns Rect

getCenter

• getCenter(): Point

  Returns Point

getChangeFlag

• getChangeFlag(attributes: { [key: string]: number }): number

  Parameters

  • attributes: { [key: string]: number }

  Returns number

getEmbeddedCells

• getEmbeddedCells(
      opt?: GetEmbeddedCellsOptions,
  ): Cell<Attributes, ModelSetOptions>[]

  Parameters

  • Optionalopt: GetEmbeddedCellsOptions

  Returns Cell<Attributes, ModelSetOptions>[]

getGroupPorts

• getGroupPorts(groupName: string): Port[]

  Parameters

  • groupName: string

  Returns Port[]

getParentCell

• getParentCell(): null | Cell<Attributes, ModelSetOptions>

  Returns null | Cell<Attributes, ModelSetOptions>

getPointFromConnectedLink

• getPointFromConnectedLink(link: Link, endType: LinkEnd): Point

  Parameters

  • link: Link
  • endType: LinkEnd

  Returns Point

getPointRotatedAroundCenter

• getPointRotatedAroundCenter(angle: number, x: number, y: number): Point

  Parameters

  • angle: number
  • x: number
  • y: number

  Returns Point

• getPointRotatedAroundCenter(angle: number, point: PlainPoint): Point

  Parameters

  • angle: number
  • point: PlainPoint

  Returns Point

getPort

• getPort(id: string): Port

  Parameters

  • id: string

  Returns Port

getPortBBox

• getPortBBox(portId: string, opt?: RotateOptions): Rect

  Parameters

  • portId: string
  • Optionalopt: RotateOptions

  Returns Rect

getPortCenter

• getPortCenter(portId: string): Point

  Parameters

  • portId: string

  Returns Point

getPortGroupNames

• getPortGroupNames(): string[]

  Returns string[]

getPortIndex

• getPortIndex(port: string | Port): number

  Parameters

  • port: string | Port

  Returns number

getPortRelativePosition

• getPortRelativePosition(portId: string): PortPosition

  Parameters

  • portId: string

  Returns PortPosition

getPortRelativeRect

• getPortRelativeRect(portId: string): PortRect

  Parameters

  • portId: string

  Returns PortRect

getPorts

• getPorts(): Port[]

  Returns Port[]

getPortsPositions

• getPortsPositions(groupName: string): { [id: string]: PortPosition }

  Parameters

  • groupName: string

  Returns { [id: string]: PortPosition }

getRelativePointFromAbsolute

• getRelativePointFromAbsolute(x: number, y: number): Point

  Parameters

  • x: number
  • y: number

  Returns Point

• getRelativePointFromAbsolute(absolutePoint: PlainPoint): Point

  Parameters

  • absolutePoint: PlainPoint

  Returns Point

getTransitions

• getTransitions(): string[]

  Returns string[]

has

• has(attribute: _StringKey<Attributes & Attributes>): boolean

  Parameters

  • attribute: _StringKey<Attributes & Attributes>

  Returns boolean

hasChanged

• hasChanged(attribute?: _StringKey<Attributes & Attributes>): boolean

  Parameters

  • Optionalattribute: _StringKey<Attributes & Attributes>

  Returns boolean

hasPort

• hasPort(id: string): boolean

  Parameters

  • id: string

  Returns boolean

hasPorts

• hasPorts(): boolean

  Returns boolean

initialize

• initialize(attributes?: Attributes & Attributes, options?: any): void

  Parameters

  • Optionalattributes: Attributes & Attributes
  • Optionaloptions: any

  Returns void

insertPort

• insertPort(
      before: string | number | Port,
      port: Port,
      opt?: ModelSetOptions,
  ): this

  Parameters

  • before: string | number | Port
  • port: Port
  • Optionalopt: ModelSetOptions

  Returns this

isElement

• isElement(): this is Element<Attributes, ModelSetOptions>

  Returns this is Element<Attributes, ModelSetOptions>

isEmbedded

• isEmbedded(): boolean

  Returns boolean

isEmbeddedIn

• isEmbeddedIn(cell: Cell, opt?: EmbeddableOptions<boolean>): boolean

  Parameters

  • cell: Cell
  • Optionalopt: EmbeddableOptions<boolean>

  Returns boolean

isLink

• isLink(): this is Link<Attributes, ModelSetOptions>

  Returns this is Link<Attributes, ModelSetOptions>

isValid

• isValid(options?: any): boolean

  Parameters

  • Optionaloptions: any

  Returns boolean

listenTo

• listenTo(object: any, events: string, callback: EventHandler): this

  Parameters

  • object: any
  • events: string
  • callback: EventHandler

  Returns this

• listenTo(object: any, eventMap: EventMap): this

  Parameters

  • object: any
  • eventMap: EventMap

  Returns this

listenToOnce

• listenToOnce(object: any, events: string, callback: EventHandler): this

  Parameters

  • object: any
  • events: string
  • callback: EventHandler

  Returns this

• listenToOnce(object: any, eventMap: EventMap): this

  Parameters

  • object: any
  • eventMap: EventMap

  Returns this

off

• off(
      eventName?: null | string,
      callback?: null | EventHandler,
      context?: any,
  ): this

  Parameters

  • OptionaleventName: null | string
  • Optionalcallback: null | EventHandler
  • Optionalcontext: any

  Returns this

on

• on(eventName: string, callback: EventHandler, context?: any): this

  Parameters

  • eventName: string
  • callback: EventHandler
  • Optionalcontext: any

  Returns this

• on(eventMap: EventMap, context?: any): this

  Parameters

  • eventMap: EventMap
  • Optionalcontext: any

  Returns this

once

• once(events: string, callback: EventHandler, context?: any): this

  Parameters

  • events: string
  • callback: EventHandler
  • Optionalcontext: any

  Returns this

• once(eventMap: EventMap, context?: any): this

  Parameters

  • eventMap: EventMap
  • Optionalcontext: any

  Returns this

parent

• parent(): string

  Returns string

portProp

• portProp(portId: string, path: Path): any

  Parameters

  • portId: string
  • path: Path

  Returns any

• portProp(
      portId: string,
      path: Path,
      value?: any,
      opt?: ModelSetOptions,
  ): Element

  Parameters

  • portId: string
  • path: Path
  • Optionalvalue: any
  • Optionalopt: ModelSetOptions

  Returns Element

position

• position(opt?: PositionOptions): Point

  Parameters

  • Optionalopt: PositionOptions

  Returns Point

• position(x: number, y: number, opt?: PositionOptions): this

  Parameters

  • x: number
  • y: number
  • Optionalopt: PositionOptions

  Returns this

preinitialize

• preinitialize(attributes?: 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 & Attributes
  • Optionaloptions: any

  Returns void

previous

• previous<A extends string>(
      attribute: A,
  ): undefined | null | (Attributes & Attributes)[A]

  Type Parameters

  • A extends string

  Parameters

  • attribute: A

  Returns undefined | null | (Attributes & Attributes)[A]

previousAttributes

• previousAttributes(): Partial<T>

  Returns Partial<T>

prop

• prop(key: Path): any

  Parameters

  • key: Path

  Returns any

• prop(object: DeepPartial<A>, opt?: Options): this

  Parameters

  • object: DeepPartial<A>
  • Optionalopt: Options

  Returns this

• prop(key: Path, value: any, opt?: Options): this

  Parameters

  • key: Path
  • value: any
  • Optionalopt: Options

  Returns this

remove

• remove(opt?: DisconnectableOptions): this

  Parameters

  • Optionalopt: DisconnectableOptions

  Returns this

removeAttr

• removeAttr(path: Path, opt?: Options): this

  Parameters

  • path: Path
  • Optionalopt: Options

  Returns this

removePort

• removePort(port: string | Port, opt?: ModelSetOptions): this

  Parameters

  • port: string | Port
  • Optionalopt: ModelSetOptions

  Returns this

removePorts

• removePorts(opt?: ModelSetOptions): this

  Parameters

  • Optionalopt: ModelSetOptions

  Returns this

• removePorts(ports: (string | Port)[], opt?: ModelSetOptions): this

  Parameters

  • ports: (string | Port)[]
  • Optionalopt: ModelSetOptions

  Returns this

removeProp

• removeProp(path: Path, opt?: Options): this

  Parameters

  • path: Path
  • Optionalopt: Options

  Returns this

resize

• resize(width: number, height: number, opt?: ResizeOptions): this

  Parameters

  • width: number
  • height: number
  • Optionalopt: ResizeOptions

  Returns this

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

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

set

• set<A extends string>(
      attributeName: A,
      value?: (Attributes & 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 & Attributes)[A]
  • Optionaloptions: ModelSetOptions

  Returns this

  Example

  set name(value: string) {
     super.set("name", value);
  }
  Copy

• 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);
  }
  Copy

• set<A extends string>(
      attributeName: Partial<Attributes & Attributes> | A,
      value?: ModelSetOptions | (Attributes & 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 & Attributes> | A
  • Optionalvalue: ModelSetOptions | (Attributes & Attributes)[A]
  • Optionaloptions: ModelSetOptions

  Returns this

  Example

  set name(value: string) {
     super.set("name", value);
  }
  Copy

size

• size(): Size

  Returns Size

• size(size: Partial<Size>, opt?: ResizeOptions): this

  Parameters

  • size: Partial<Size>
  • Optionalopt: ResizeOptions

  Returns this

• size(width: number, height: number, opt?: ResizeOptions): this

  Parameters

  • width: number
  • height: number
  • Optionalopt: ResizeOptions

  Returns this

startBatch

• startBatch(name: string, opt?: Options): this

  Parameters

  • name: string
  • Optionalopt: Options

  Returns this

stopBatch

• stopBatch(name: string, opt?: Options): this

  Parameters

  • name: string
  • Optionalopt: Options

  Returns this

stopListening

• stopListening(object?: any, events?: string, callback?: EventHandler): this

  Parameters

  • Optionalobject: any
  • Optionalevents: string
  • Optionalcallback: EventHandler

  Returns this

stopTransitions

• stopTransitions(path?: string, delim?: string): this

  Parameters

  • Optionalpath: string
  • Optionaldelim: string

  Returns this

toBack

• toBack(opt?: ToFrontAndBackOptions): this

  Parameters

  • Optionalopt: ToFrontAndBackOptions

  Returns this

toFront

• toFront(opt?: ToFrontAndBackOptions): this

  Parameters

  • Optionalopt: ToFrontAndBackOptions

  Returns this

toJSON

• toJSON(opt?: ExportOptions): JSON<any, Attributes & Attributes>

  Parameters

  • Optionalopt: ExportOptions

  Returns JSON<any, Attributes & Attributes>

transition

• transition(
      path: string,
      value?: any,
      opt?: TransitionOptions,
      delim?: string,
  ): number

  Parameters

  • path: string
  • Optionalvalue: any
  • Optionalopt: TransitionOptions
  • Optionaldelim: string

  Returns number

translate

• translate(tx: number, ty?: number, opt?: TranslateOptions): this

  Parameters

  • tx: number
  • Optionalty: number
  • Optionalopt: TranslateOptions

  Returns this

trigger

• trigger(eventName: string, ...args: any[]): this

  Parameters

  • eventName: string
  • ...args: any[]

  Returns this

unbind

• unbind(eventName?: string, callback?: EventHandler, context?: any): this

  Parameters

  • OptionaleventName: string
  • Optionalcallback: EventHandler
  • Optionalcontext: any

  Returns this

unembed

• unembed(
      cell:
          | Cell<Attributes, ModelSetOptions>
          | Cell<Attributes, ModelSetOptions>[],
      opt?: Options,
  ): this

  Parameters

  • cell: Cell<Attributes, ModelSetOptions> | Cell<Attributes, ModelSetOptions>[]
  • Optionalopt: Options

  Returns this

unset

• unset(
      attribute: _StringKey<Attributes & Attributes>,
      options?: Silenceable,
  ): this

  Parameters

  • attribute: _StringKey<Attributes & Attributes>
  • Optionaloptions: Silenceable

  Returns this

validate

• validate(attributes: Partial<T>, options?: any): any

  Parameters

  • attributes: Partial<T>
  • Optionaloptions: any

  Returns any

z

• z(): number

  Returns number

Staticdefine

• define(
      type: string,
      defaults?: any,
      protoProps?: any,
      staticProps?: any,
  ): Constructor<Element<Attributes, ModelSetOptions>>

  Parameters

  • type: string
  • Optionaldefaults: any
  • OptionalprotoProps: any
  • OptionalstaticProps: any

  Returns Constructor<Element<Attributes, ModelSetOptions>>

Staticextend

• extend(properties: any, classProperties?: any): any

  Do not use, prefer TypeScript's extend functionality.

  Parameters

  • properties: any
  • OptionalclassProperties: any

  Returns any

attributes

changed

cid

cidPrefix

collection

graph

id

idAttribute

useCSSSelectors

validationError

Staticattributes