Skip to main content

%ZEN.SVGComponent.svgPage

Class %ZEN.SVGComponent.svgPage Extends (%RegisteredObject, %CSP.Page) [ Deprecated, Inheritance = right, PropertyClass = %ZEN.pageParameters, System = 4 ]

This is a specialized CSP page that serves SVG content for a ZEN svgFrame.
This is an instantiable CSP page.

Parameters​

CONTENTTYPE​

Parameter CONTENTTYPE = "image/svg+xml";

USERSVGPACKAGES​

Parameter USERSVGPACKAGES As STRING;

Comma-separated list of component packages whose style definitions are in pre-generated include files. This is merged with the list provided by the parent page.

RESOURCE​

Parameter RESOURCE As STRING;

This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

JSINCLUDES​

Parameter JSINCLUDES As STRING;

Comma-separated list of additional JS include files. These are included within the inner SVG page served by this class only.

CSSINCLUDES​

Parameter CSSINCLUDES As STRING;

Additional set of CSS style files to include.

Properties​

%SystemSVGPackageList​

Property %SystemSVGPackageList As %String(XMLPROJECTION = "none") [ Internal ];

Internal property.
Comma-delimited list of user-defined packages that are included by this page. This list is created by combining the parameter from this class, the parent page, and the application.

%UserSVGPackageList​

Property %UserSVGPackageList As %String(XMLPROJECTION = "none") [ Internal ];

Internal property.
Comma-delimited list of user-defined packages that are included by this page. This list is created by combining the parameter from this class, the parent page, and the application.

XDatas​

SVGStyle​

XData SVGStyle

Default style for ZEN SVG pages

SVGDef​

XData SVGDef

Set of standard svg defs shared by all svg components.

Methods​

%ApplyURLParms​

Method %ApplyURLParms() As %Status [ CodeMode = objectgenerator, Final ]

Copy URL parameters supplied to this page into the appropriate properties of this page.

%DrawClassDefinition​

ClassMethod %DrawClassDefinition() As %Status [ CodeMode = objectgenerator, Final ]

Draw JavaScript needed to define client-side class for this page (if any).

%DrawObjectProperties​

Method %DrawObjectProperties() As %Status [ CodeMode = objectgenerator, Final ]

Draw JavaScript needed to initialize properties for client side of this object

%DrawJSSerialize​

ClassMethod %DrawJSSerialize() As %Status [ CodeMode = objectgenerator, Final, GenerateAfter = %DrawClassDefinition, Internal ]

Internal method.
Draw JavaScript serialize method for this component.

%DrawJSGetSettings​

ClassMethod %DrawJSGetSettings() As %Status [ CodeMode = objectgenerator, Final, GenerateAfter = %DrawClassDefinition, Internal ]

Internal method.
Draw JavaScript getSettings method for this component.

OnPreHTTP​

ClassMethod OnPreHTTP() As %Boolean [ ServerOnly = 1 ]

OnPage​

ClassMethod OnPage() As %Status

%DrawSVGPage​

Method %DrawSVGPage() [ Final ]

Draw standard SVG wrapper

%DrawSVGDocument​

Method %DrawSVGDocument(ByRef pAttrs As %String, pInline As %Boolean) [ Final, Internal ]

This does the actual work of writing out the SVG document definition. It can be called for inline or standard SVG.

%InvokeCallback​

Method %InvokeCallback(pMethod As %String) As %Status

Internal Method.
This is used to invoke callback methods and trap for errors.

%DrawClassDefinitions​

Method %DrawClassDefinitions() [ Final ]

Draw out client-side class definitions for components on this page. Caller is responsible for drawing enclosing script tags.

%GetSuperClassList​

ClassMethod %GetSuperClassList(ByRef pList) As %String [ CodeMode = objectgenerator, Final ]

Construct a list of component super classes of this class as csv list (include this class as well).
This is used at page render-time to build the list of classes needed by the client page.

%DrawObjectDefinitions​

Method %DrawObjectDefinitions() [ Final ]

Write out client-side object definitions for components on this page.
Caller is responsible for drawing enclosing script tags.

%OnDrawSVGPage​

Method %OnDrawSVGPage() As %Status [ CodeMode = expression ]

Callback method. If defined, this provides a way for a subclass to add static SVG content to the svgPage.

%LinkCSS​

ClassMethod %LinkCSS(pFile As %String) As %String [ CodeMode = expression ]

Return string used to include a CSS file [Previously private]

%LinkScript​

ClassMethod %LinkScript(pFile As %String) As %String [ CodeMode = expression ]

Return string used to include a script file [Previously private]

%StartScript​

ClassMethod %StartScript() As %String [ CodeMode = expression ]

Write string used to introduce client-side script code [Previously private]

%EndScript​

ClassMethod %EndScript() As %String [ CodeMode = expression ]

Write string used to end client-side script code [Previously private]

%DrawSVGDefs​

ClassMethod %DrawSVGDefs() [ CodeMode = objectgenerator ]

This method writes out all SVG Defs defined by ZEN library components.

%DrawStyleSVG​

ClassMethod %DrawStyleSVG() [ CodeMode = objectgenerator, GenerateAfter = %OnDrawStyleSVG ]

Write out SVG/CSS style sheet defined for this component
This is based on the XData block, SVGStyle.

%DrawSVGDef​

ClassMethod %DrawSVGDef() [ CodeMode = objectgenerator, GenerateAfter = %OnDrawSVGDef ]

Write out SVG defs defined for this component
This is based on the XData block, SVGDef.

%OnDrawStyleSVG​

ClassMethod %OnDrawStyleSVG() As %Status [ Abstract ]

Callback method called when drawing the SVG CSS style for this page.

%OnDrawSVGDef​

ClassMethod %OnDrawSVGDef() As %Status [ Abstract ]

Callback method called when drawing the SVG defs for this page.

%OnDrawSVGScript​

ClassMethod %OnDrawSVGScript() As %Status

Callback for adding scripts to this SVG page.

onSVGLoad​

ClientMethod onSVGLoad() [ Language = javascript ]

This method is called when this svgPage is loaded.

%GetClassCRC​

ClassMethod %GetClassCRC() As %Status [ CodeMode = objectgenerator, Final, GenerateAfter = %DrawClassDefinition, Internal ]

Internal method.
Get the CRC for this class. This is used to test for client/server mismatch issues. This needs to be a method to avoid class compiler issues.