This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).


class %ZEN.Component.canvas extends %ZEN.Component.component

HTML5 Canvas Element.
This is a wrapper around the HTML5 Canvas element.
This only works with an HTML5 browser that supports the Canvas element.

Property Inventory (Including Private)

Method Inventory (Including Private)


property content as %ZEN.Datatype.html (CONTENT = "MIXED", ESCAPE = "HTML", XMLPROJECTION = "content");
Fallback HTML content to display. This is diplayed in browsers that do not support the Canvas element.
Property methods: contentDisplayToLogical(), contentGet(), contentIsValid(), contentLogicalToDisplay(), contentLogicalToOdbc(), contentNormalize(), contentSet()
property onrender as %ZEN.Datatype.eventHandler;
onrender event handler: This event is fired by the render method and can supply the content displayed by this component. As a convenience, the event is passed an argument, context, which is the graphic context of the canvas element.
Property methods: onrenderDisplayToLogical(), onrenderGet(), onrenderIsValid(), onrenderLogicalToDisplay(), onrenderLogicalToOdbc(), onrenderNormalize(), onrenderSet()


method %DrawHTML()
Inherited description: Static HTML display method: draw the BODY of this component as HTML.
Subclasses implement this in order to render the static HTML contents of a component.
clientmethod getContext() [ Language = javascript ]
Return the 2D drawing context for this canvas element.
Returns null if the browser does not support the canvas element.
clientmethod renderContents() [ Language = javascript ]
Render the contents of this component's canvas.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)