Skip to main content


class %ZEN.SVGComponent.sprite extends %ZEN.SVGComponent.svgComponent

Base class for SVG sprites.
A sprite is a shape that can be placed on an svgCanvas and connected to other sprites. Sprites form the basis of an svg-based graphical editor.

Property Inventory

Method Inventory


property caption as %ZEN.Datatype.caption;
Text displayed in center of the sprite.
Property methods: captionDisplayToLogical(), captionGet(), captionIsValid(), captionLogicalToDisplay(), captionLogicalToOdbc(), captionNormalize(), captionSet()
property ports as list of port (XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE");
List of input/output ports. Each port is the terminator of a connection to another sprite.
Property methods: portsBuildValueArray(), portsCollectionToDisplay(), portsCollectionToOdbc(), portsDisplayToCollection(), portsGet(), portsGetObject(), portsGetObjectId(), portsGetSwizzled(), portsIsValid(), portsOdbcToCollection(), portsSet(), portsSetObject(), portsSetObjectId()
property rx as %ZEN.Datatype.integer (MINVAL = 0) [ InitialExpression = 0 ];
Radius of sprite corners.
Property methods: rxDisplayToLogical(), rxGet(), rxIsValid(), rxLogicalToDisplay(), rxLogicalToOdbc(), rxNormalize(), rxSet()
property style as %ZEN.Datatype.svgStyle;
Additional style to apply to the primary sprite shape.
Property methods: styleDisplayToLogical(), styleGet(), styleIsValid(), styleLogicalToDisplay(), styleLogicalToOdbc(), styleNormalize(), styleSet()


clientmethod createPort(type, x, y) [ Language = javascript ]
Create a port for this sprite.
clientmethod createPorts() [ Language = javascript ]
Create the set of ports for this sprite.
clientmethod getPort(portno) [ Language = javascript ]
Get the specificied port by port number (0-based).
clientmethod renderContents() [ Language = javascript ]
Render the inner SVG contents of this sprite.
clientmethod setPositionHandler() [ Language = javascript ]
Notification that this component has been moved.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod setSizeHandler() [ Language = javascript ]
Notification that this component has been resized.
clientmethod updateConnectors() [ Language = javascript ]
Internal method: update position of all connectors attached to this sprite.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab