Sprotty
Toggle Dark/Light/Auto modeToggle Dark/Light/Auto modeToggle Dark/Light/Auto modeBack to homepage

Interface. Foreign Object Element

sprotty-protocol / ForeignObjectElement

Interface: ForeignObjectElement

Defined in: model.ts:337

A foreignObject element to be transferred to the DOM within the SVG.

This can be useful to to benefit from e.g. HTML rendering features, such as line wrapping, inside of the SVG diagram. Note that foreignObject is not supported by all browsers and SVG viewers may not support rendering the foreignObject content.

If no dimensions are specified in the schema element, this element will obtain the dimension of its parent to fill the entire available room. Thus, this element requires specified bounds itself or bounds to be available for its parent.

Extends

Properties

children?

optional children: SModelElement[]

Defined in: model.ts:27

Inherited from

ShapedPreRenderedElement.children


code

code: string

Defined in: model.ts:315

Inherited from

ShapedPreRenderedElement.code


cssClasses?

optional cssClasses: string[]

Defined in: model.ts:28

Inherited from

ShapedPreRenderedElement.cssClasses


id

id: string

Defined in: model.ts:26

Inherited from

ShapedPreRenderedElement.id


namespace

namespace: string

Defined in: model.ts:339

The namespace to be assigned to the elements inside of the foreignObject.


position?

optional position: Point

Defined in: model.ts:322

Inherited from

ShapedPreRenderedElement.position


size?

optional size: Dimension

Defined in: model.ts:323

Inherited from

ShapedPreRenderedElement.size


type

type: string

Defined in: model.ts:25

Inherited from

ShapedPreRenderedElement.type