Home > Class Reference > ENSLIB 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 (Including Private)

Method Inventory (Including Private)

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 (Including Private)

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