Home > Class Reference > %SYS namespace > %ZEN.SVGComponent.svgComponent

%ZEN.SVGComponent.svgComponent

abstract class %ZEN.SVGComponent.svgComponent extends %ZEN.Component.object

Base class for SVG components.
Unlike HTML components, SVG components are completely dynamic; all rendering is done using client-side JavaScript.
Every component is rendered within its own enclosing group (g) element.

Property Inventory

Method Inventory

Parameters

parameter DEFAULTASPECT;
Subclasses can set this to change the default value for the preserveAspectRatio/ property for a component.
parameter DEFAULTBOUNDLESS = 0;
Subclasses can set this to change the default value for the boundless property for a component.
parameter DEFAULTHEIGHT = 100;
Default height of this component.
parameter DEFAULTHIDDEN = 0;
Subclasses can set this to change the default value for the hidden property for a component.
parameter DEFAULTVIEWBOXHEIGHT;
Default viewBoxHeight of this component.
parameter DEFAULTVIEWBOXWIDTH;
Default viewBoxWidth of this component.
parameter DEFAULTVISIBLE = 1;
Subclasses can set this to change default visibilty for a component.
parameter DEFAULTWIDTH = 100;
Default width of this component.
parameter POSTCOMPILEACTIONS = schema,SVG;
Internal parameter.

Properties

property boundless as %ZEN.Datatype.boolean (ZENSETTING = 0) [ InitialExpression = ..#DEFAULTBOUNDLESS ];
If true, this component is boundless. That is, it's enclosing svg element is a simple group (g) instead of the usual svg element.
Property methods: boundlessDisplayToLogical(), boundlessGet(), boundlessIsValid(), boundlessLogicalToDisplay(), boundlessLogicalToOdbc(), boundlessLogicalToXSD(), boundlessNormalize(), boundlessSet(), boundlessXSDToLogical()
property document as %ZEN.Datatype.string (XMLPROJECTION = "none", ZENCLIENTONLY = 1, ZENSETTING = 0);
Client-side property that points to SVG document this component is rendered on.
Property methods: documentDisplayToLogical(), documentGet(), documentIsValid(), documentLogicalToDisplay(), documentLogicalToOdbc(), documentNormalize(), documentSet()
property height as %ZEN.Datatype.length [ InitialExpression = ..#DEFAULTHEIGHT ];
Width of this component.
This value is used for layout purposes. The actual effect of setting this is up the specific component implementation.
Property methods: heightDisplayToLogical(), heightGet(), heightIsValid(), heightLogicalToDisplay(), heightLogicalToOdbc(), heightNormalize(), heightSet()
property hidden as %ZEN.Datatype.boolean [ InitialExpression = ..#DEFAULTHIDDEN ];
If true, this component is hidden. That is, it's enclosing group's display style is set to "none".
Property methods: hiddenDisplayToLogical(), hiddenGet(), hiddenIsValid(), hiddenLogicalToDisplay(), hiddenLogicalToOdbc(), hiddenLogicalToXSD(), hiddenNormalize(), hiddenSet(), hiddenXSDToLogical()
property onclick as %ZEN.Datatype.eventHandler;
onclick event handler: This event is fired when the mouse is clicked on the shape. This is the default onclick event for svg components; subclasses may implement more specialized events (such as click on a specific part of the component).
Property methods: onclickDisplayToLogical(), onclickGet(), onclickIsValid(), onclickLogicalToDisplay(), onclickLogicalToOdbc(), onclickNormalize(), onclickSet()
property position as %ZEN.Datatype.string (VALUELIST = ",fixed,relative", ZENSETTING = 0) [ InitialExpression = "relative" ];
If position is "fixed", then this shape will not scroll with its canvas nor can it be dragged with the mouse.
This is used for placing fixed controller over the rest of an SVG canvas.
Property methods: positionDisplayToLogical(), positionGet(), positionIsValid(), positionLogicalToDisplay(), positionLogicalToOdbc(), positionNormalize(), positionSet()
property preserveAspectRatio as %ZEN.Datatype.string [ InitialExpression = ..#DEFAULTASPECT ];
Value to apply for this component's enclosing svg element's preserveAspectRatio attribute.
Set this to "none" if you do not want the SVG Engine to preserve the aspect ratio (height relative to width) for this component.
Property methods: preserveAspectRatioDisplayToLogical(), preserveAspectRatioGet(), preserveAspectRatioIsValid(), preserveAspectRatioLogicalToDisplay(), preserveAspectRatioLogicalToOdbc(), preserveAspectRatioNormalize(), preserveAspectRatioSet()
property svgComponent as %ZEN.Datatype.boolean (XMLPROJECTION = "none", ZENCLIENTONLY = 1, ZENSETTING = 0) [ InitialExpression = 1 ];
Client-side property used to determine if a component is an SVG component.
Property methods: svgComponentDisplayToLogical(), svgComponentGet(), svgComponentIsValid(), svgComponentLogicalToDisplay(), svgComponentLogicalToOdbc(), svgComponentLogicalToXSD(), svgComponentNormalize(), svgComponentSet(), svgComponentXSDToLogical()
property svgGroup as %ZEN.Datatype.string (XMLPROJECTION = "none", ZENCLIENTONLY = 1, ZENSETTING = 0);
Client-side property that points to the enclosing SVG group element for this component.
Property methods: svgGroupDisplayToLogical(), svgGroupGet(), svgGroupIsValid(), svgGroupLogicalToDisplay(), svgGroupLogicalToOdbc(), svgGroupNormalize(), svgGroupSet()
property viewBoxHeight as %ZEN.Datatype.integer [ InitialExpression = ..#DEFAULTVIEWBOXHEIGHT ];
If defined, this is used to calculate the height of the viewBox attribute of the enclosing svg element.
Property methods: viewBoxHeightDisplayToLogical(), viewBoxHeightGet(), viewBoxHeightIsValid(), viewBoxHeightLogicalToDisplay(), viewBoxHeightLogicalToOdbc(), viewBoxHeightNormalize(), viewBoxHeightSet()
property viewBoxWidth as %ZEN.Datatype.integer [ InitialExpression = ..#DEFAULTVIEWBOXWIDTH ];
If defined, this is used to calculate the width of the viewBox attribute of the enclosing svg element.
Property methods: viewBoxWidthDisplayToLogical(), viewBoxWidthGet(), viewBoxWidthIsValid(), viewBoxWidthLogicalToDisplay(), viewBoxWidthLogicalToOdbc(), viewBoxWidthNormalize(), viewBoxWidthSet()
property width as %ZEN.Datatype.length [ InitialExpression = ..#DEFAULTWIDTH ];
Width of this component.
This value is used for layout purposes. The actual effect of setting this is up the specific component implementation.
Property methods: widthDisplayToLogical(), widthGet(), widthIsValid(), widthLogicalToDisplay(), widthLogicalToOdbc(), widthNormalize(), widthSet()
property x as %ZEN.Datatype.length [ InitialExpression = 0 ];
x position of this component's enclosing group.
The actual position of the component depends on the layout applied by its containing svgGroup.
Property methods: xDisplayToLogical(), xGet(), xIsValid(), xLogicalToDisplay(), xLogicalToOdbc(), xNormalize(), xSet()
property y as %ZEN.Datatype.length [ InitialExpression = 0 ];
y position of this component's enclosing group.
The actual position of the component depends on the layout applied by its containing svgGroup.
Property methods: yDisplayToLogical(), yGet(), yIsValid(), yLogicalToDisplay(), yLogicalToOdbc(), yNormalize(), ySet()

Methods

final method %DrawHTML()
Do not allow HTML methods for SVG components.
clientmethod beginWaitState() [ Language = javascript ]
Begin a wait state for this component. This will display a waiting graphic in the center of this component. The wait state is ended with a call to endWaitState().
clientmethod calculateViewBox() [ Language = javascript ]
Calculate the value of the viewBox attribute of this component's enclosing svg element.
Subclasses can override this, should they need to provide a different behavior. The default behavior is to use the width and height of this component to come up with a 1 to 1 coordinate mapping; If the component provides values for the viewboxWidth and viewboxHeight properties, then these are used to calculate the viewBox (and thus define a fixed coordinate system for the component).
clientmethod clickHandler(evt) [ Language = javascript ]
Default mouse click handler.
clientmethod endWaitState() [ Language = javascript ]
End the current wait state for this component.
final clientmethod findSVGElement(subid) [ Language = javascript ]
Client-side utility method that finds an SVG element with a component-specific id.
clientmethod getFrame() [ Language = javascript ]
Return the svgFrame object this component belongs to.
clientmethod getSizeAbsolute() [ Language = javascript ]
Return an object containing (as x,y,width, and height properties) the absolute size and position (relative to the svg canvas) of this component.
final clientmethod refreshContents() [ Language = javascript ]
This is not supported for SVG components
clientmethod renderContents() [ Language = javascript ]
Render the inner SVG contents of this component. This is implemented by subclasses.
final clientmethod renderSVG(document, parent) [ Language = javascript ]
Render the outer SVG enclosing group for this component as well as its inner contents.
This is called by the svgFrame when the component is first loaded or created.
parent is the parent SVG object this component should be added to.
clientmethod setOverlayMode(mode) [ Language = javascript ]
Display an overlay for this component to trap mouse events and/or support dragging/resizing with the mouse.
mode is the overlay mode:
0: turn off overlay.
1: turn on overlay.
2: turn on overlay, show indication that this component is selected. 3: turn on overlay, show indication that this component can be dragged.
clientmethod setPosition(x, y) [ Language = javascript ]
Set the x,y position of this component.
Applications should not call this method.
abstract clientmethod setPositionHandler() [ Language = javascript ]
Notification that this component has been moved. This can be implemented by subclasses.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod setSize(w, h) [ Language = javascript ]
Set the size (width and height) of this component.
Applications should not call this method.
abstract clientmethod setSizeHandler() [ Language = javascript ]
Notification that this component has been resized. This can be implemented by subclasses.
clientmethod setTextNode(id, str) [ Language = javascript ]
Utility method: Find the svg text element with id id and replace its text with str.
clientmethod sizingMouseDownHandler(evt, which) [ Language = javascript ]
Internal: sizing handle mouse down handler.
clientmethod unrender() [ Language = javascript ]
Remove the inner SVG for this component.
clientmethod wrapMethod(methodName) [ Language = javascript ]
Utility method: Construct a wrapper around an instance method of this object that can be used as an event listener.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses