Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%ZEN] >  [ComponentEx] >  [svgImageProvider]
Private  Storage   

deprecatedclass %ZEN.ComponentEx.svgImageProvider extends %ZEN.Component.component

SVGImageProvider These utilities are built upon the java .jar libraries in the FOP distribution included with modern releases of InterSystems IRIS

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 31


Summary

Properties
%condition %import %includeFiles %page
%resource align aux composite
containerStyle dragEnabled dropEnabled enclosingClass
enclosingStyle error height hidden
hint hintClass hintStyle id
index label labelClass labelDisabledClass
labelStyle name onafterdrag onbeforedrag
ondrag ondrop onhide onrefresh
onshow onupdate parent showLabel
slice title tuple valign
visible width window

Methods
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GetEventHandlers %GetParameter %GetXMLName
%IsA %IsModified %MakeId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnDrawEnclosingDiv %OnDrawObjectProperties %OnObjectSynch %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %Self %SerializeObject %SetModified
%ValidateObject ConvertXSLToPDF GenerateRootName GenerateTempName
GetSystemHomeDir GetSystemTempDir ReceiveFragment RemoveFile
ScopeFileName XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType buildFOBlock buildFOStyleString buildFOTable
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler dumpSVGNode dumpSVGStyle
exposeComponent extractSVGSource extractXSLFOSource findElement
fireOnUpdateEvent getEnclosingDiv getHidden getHintElement
getLabelElement getPageSetupDefaults getProperty getSVGDOMRoot
getSettings getType invokeSuper isOfType
isWhiteSpace makeId makeSVGFileName onCreate
onDelete onDisplayHandler onEndModalHandler onPopupAction
onRefreshContents onSerialize onStartModalHandler onloadHandler
onunloadHandler onupdateHandler reconcileDefaults refreshContents
render renderContents renderSVG saveDOMToSVGFile
saveDOMToSVGStream saveDOMToXSLFOFile saveDOMToXSLFOStream saveDOMToXSLFile
saveToSVGFile saveToServer saveToXSLFOSnippet saveToXSLFile
setHidden setOverlayMode setProperty startProgressBar
stopProgressBar

Subclasses
%DeepSee.Component.deepseeSvgImageProvider

Parameters

• parameter INCLUDEFILES = "zenCSLM.js";
CSV list of additional include files (either .js or .css) that should be included when this component is used on a page.
By default, the file extension (.js or .css) is used to determine whether an item in the list is a script include or a style include. You can override this behavior by adding the terms "script:" or "style:" to the beginning of the file name or names. This prefix is not used as part of the include filename.

Methods

• method %DrawHTML()
This class does not project HTML into its containing document
• classmethod ConvertXSLToPDF(pInFile As %String, pOutFile As %String) [ ZenMethod ]
• classmethod GenerateRootName(dir As %String) as %String [ ZenMethod ]
Return a random and unique name in the given directory with an 'svg' extention for the creation of temp files during processing
• classmethod GenerateTempName() as %String [ ZenMethod ]
Return a random and unique name in the temp directory with an 'svg' extention for the creation of temp files during processing
• classmethod GetSystemHomeDir() as %String [ ZenMethod ]
Return the install directory of this instance
• classmethod GetSystemTempDir() as %String [ ZenMethod ]
Return the temp directory for this system.
• classmethod ReceiveFragment(outputFile As %String, src As %ZEN.proxyObject) as %Status [ ZenMethod ]
Mechanism for receiving fragmants of large data streams headed upstream from client to server. This work in conjunction with the saveToServer() method.
• classmethod RemoveFile(pFileName) as %Status [ ZenMethod ]
Remove a file from the mgr/Temp directory
• classmethod ScopeFileName(rawName As %String) as %String [ ZenMethod ]
Given a user specified file name clip it to ensure that it only refers to files in the mgr/temp space
• method buildFOBlock(jsDesc) [ Language = javascript ]
• method buildFOStyleString(jsDesc) [ Language = javascript ]
• method buildFOTable(jsDesc) [ Language = javascript ]
• method dumpSVGNode(e, svgDoc, src, intro, coda, NSPrefix, maxWidth, maxHeight) [ Language = javascript ]
Given an element, an active SVG DOM, a syntax buffer, and optional introduction and coda strings, recursively extract all of the descendant node information from the DOM and copy it to the syntax buffer adding appropriate lexical and syntactic elements as needed.
If intro and coda values have been provided, inject the contents of these strings into the syntax buffer immediately after the opening of the first encountered tag and immediately before the close of that same tag, respectively.
• method dumpSVGStyle(svgDoc, src, NSPrefix) [ Language = javascript ]
Given an active SVG DOM and a syntax buffer, extract all embedded stylesheets and copy them to the buffer adding appropriate lexical and syntactic elements as needed
• method extractSVGSource(svg, intro, coda) [ Language = javascript ]
Given an SVG DOM and (optional) introduction and coda strings containing SVG code snippets, walk the DOM extracting relavent rendering information and store the result in an array of strings
• method extractXSLFOSource(svg, intro, coda, maxWidth, maxHeight) [ Language = javascript ]
Given an SVG DOM and (optional) introduction and coda strings containing SVG code snippets, walk the DOM extracting relavent rendering information and store the result in an array of strings
• method getPageSetupDefaults() [ Language = javascript ]
Return a javascript object that contains the various default values for page set-up and meta data rendering. Users can get this object, modify its values as desired and then pass it to the actual renderer methods
• method getSVGDOMRoot(image) [ Language = javascript ]
Given some form of zen SVGComponent, return a pointer to the root of the embedded SVG document model
• method isWhiteSpace(str) [ Language = javascript ]
Quick check to test for embedded whitespace and control characters
• method makeSVGFileName(name) [ Language = javascript ]
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method reconcileDefaults(metaDataJS) [ Language = javascript ]
Set up a default page setup object, incorporating user overrides, if defined
• method saveDOMToSVGFile(svg, fileName, intro, coda) [ Language = javascript ]
Given an SVG DOM, the name of a server side file to create/overwrite, and (optional) introduction and coda strings containing SVG code snippets, walk the DOM extracting relavent rendering information and store the result in a stand-alone file on the server.
• method saveDOMToSVGStream(svg, intro, coda) [ Language = javascript ]
Given an SVG DOM and (optional) introduction and coda strings containing SVG code snippets, walk the DOM extracting relavent rendering information and return the result in one big string.
• method saveDOMToXSLFOFile(svg, fileName, intro, coda) [ Language = javascript ]
Given an SVG DOM, the name of a server side file to create/overwrite, and (optional) introduction and coda strings containing SVG code snippets, walk the DOM extracting XSLFO rendering information and store the result in a stand-alone file on the server.
• method saveDOMToXSLFOStream(svg, intro, coda) [ Language = javascript ]
Given an SVG DOM and (optional) introduction and coda strings containing SVG code snippets, walk the DOM extracting FO rendering information and return the result in one big string.
• method saveDOMToXSLFile(svg, metaDataJS) [ Language = javascript ]
Given an SVG DOM, the name of a server side file to create/overwrite, and (optional) introduction and coda strings containing SVG code snippets, walk the DOM extracting XSLFO rendering information and store the result as a full XSL-FO document on the server.
• method saveToSVGFile(image, name, intro, coda) [ Language = javascript ]
• method saveToServer(src, fileName) [ Language = javascript ]
Client-side utility to send large data streams up to the server for external file storage Normally small data streams can simply be sent up to the host using simple POST requests but we have encountered issues with data loss using very large packets. To avoid this issue, this method breaks large data streams into universally 'safe' packet lengths and streams the parts up to the server where they are reassembled in the external file with the given fileName
• method saveToXSLFOSnippet(image, name, intro, coda) [ Language = javascript ]
• method saveToXSLFile(image, metaDataJS) [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.