This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).


class %ZEN.Mojo.Plugin.dojoGridX130Helper extends %ZEN.Mojo.Plugin.baseHelperPlugin

This plugin adds support for the dojo library. It was developed and tested with dojo version 1.9 1.0.7 - NAN026 - add support for $hide and $show to dojo plugin 1.0.6 - add support for $ignoreSelect 1.0.5 - implement $refresh logic 1.0.4 - introducing library version in the classname 1.0.3 - decoupled documentation from plugin 1.0.2 - updated documentation to reflect current state

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter XMLNAME = dojoGridX-1.3.0-Helper;
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties (Including Private)

property pluginName as %String (XMLPROJECTION = "NONE") [ InitialExpression = "dojoGridX-1.3.0-Helper" ];
The unique name of the Plugin. All features of this plugin will be registered using this identifier.
Property methods: pluginNameDisplayToLogical(), pluginNameGet(), pluginNameIsValid(), pluginNameLogicalToDisplay(), pluginNameLogicalToOdbc(), pluginNameNormalize(), pluginNameSet()
property version as %String (XMLPROJECTION = "NONE") [ InitialExpression = "1.0.7" ];
A version string of the base helper plugin. Major/Minor/Build
Property methods: versionDisplayToLogical(), versionGet(), versionIsValid(), versionLogicalToDisplay(), versionLogicalToOdbc(), versionNormalize(), versionSet()

Methods (Including Private)

clientmethod clone(obj) [ Language = javascript ]
helper function, adapted from clones object, arrays, dates, strings, numbers and booleans other types are not supported
clientmethod createLayoutObjects(type, instance) [ Language = javascript ]
Create a layout object for a document item. These objects form the layout graph used to render the document. Each layout object contains the context and code needed to render itself.
clientmethod getDojoTypes() [ Language = javascript ]
clientmethod getFeatures() [ Language = javascript ]
This method returns an array containing objects which describe all layout elements the plugin supports. Each object in the list has to set the property 'identifier' in order to register this layout element for this plugin. In case multiple plugins register for the same feature the documentView component will indicate this conflict. Use the getPluginConflicts method in order to retrieve the conflicts. The first plugin which registers a features will be used for dispatching in case there is a conflict. If you want to change preference use the setPluginMapping method of the documentView
clientmethod linkDojoItem() [ Language = javascript ]
clientmethod onCheckLibraries() [ Language = javascript ]
This method is supposed to check that all required libraries have been loaded. Returns true for success, false otherwise.
clientmethod refreshGridx() [ Language = javascript ]
Picks up any changes from the store and updates the body of the table.
clientmethod registerDojoType(instance) [ Language = javascript ]
Register a dojo type for the require call by specifying the instance
clientmethod registerDojoTypeByType(type) [ Language = javascript ]
Register a dojo type for the require call by specifying the type as string
clientmethod renderGridx() [ Language = javascript ]
clientmethod setupGridx() [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window