Skip to main content

%ZEN.Template.ZENChartWizard

class %ZEN.Template.ZENChartWizard extends %ZEN.Template.studioTemplate

Studio Template:
Inserts a new chart definition within an XData definition.

Method Inventory

Parameters

parameter DOMAIN = %ZEN;
Domain used for localization.
parameter HELPID = GZEN_chart_wizard;
Inherited description: DOCBOOK Topic Id that offers help for this template.
parameter TEMPLATEDESCRIPTION = Inserts a Zen chart definition within a Contents document.;
Inherited description: Short description of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATEMODE = template;
What type of template.
parameter TEMPLATENAME = Zen Chart Wizard;
Inherited description: Name of the template to show in Studio.
If DOMAIN is defined this will be localized.
parameter TEMPLATETITLE = Zen Chart Wizard;
Inherited description: Title of the template to show in the template window.
parameter TEMPLATETYPE = cls;
Inherited description: Comma separated list of 'CSP', 'CSR', 'MAC', 'INT', 'INC', 'BAS', 'CLS' to say what type of code this template generates; CSP, CSR, Routine, or Class code. You can also specify '*' for all types.

Methods

method %GetDescHTML(pSeed As %String) as %Status
Provide contents of description component.
method %GetDescHTML2(pSeed As %String) as %Status
Provide contents of description component.
method %OnAfterCreatePage() as %Status
Inherited description: This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnTemplateAction() as %Status
This method is called when the template is complete. Any output to the principal device is returned to the Studio.
classmethod SerializeChart(pChart As %ZEN.SVGComponent.chart) as %String [ ZenMethod ]
Convert chart to xml representation.
clientmethod canGoBack() [ Language = javascript ]
Return true if this template can go to the previous page (i.e., enable the Back button).
clientmethod canGoNext() [ Language = javascript ]
Return true if this template can go to the next page (i.e., enable the Next button).
clientmethod changeChart(chartType) [ Language = javascript ]
Create and display the specified chart type.
clientmethod chartTypeChange(cb) [ Language = javascript ]
Notification that the chart type has changed.
clientmethod editProperty() [ Language = javascript ]
User has pressed edit button in the objectInspector.
clientmethod formValidationHandler() [ Language = javascript ]
Validation handler for form built-into template.
clientmethod getChartData(series) [ Language = javascript ]
Callback to provide random data for chart.
clientmethod hasMultiplePages() [ Language = javascript ]
Inherited description: Return true if this template has more than one "page". This will display Back and Next buttons. This is implemented by subclasses.
clientmethod inspectElement(name) [ Language = javascript ]
Point object inspector to given component.
clientmethod nextPage() [ Language = javascript ]
Go to the next page of the template (if there is one).
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
clientmethod onfinishHandler() [ Language = javascript ]
This is called when the template is finished;
clientmethod onlayoutHandler(load) [ Language = javascript ]
This client event, if present, is fired when the page is first loaded or whenever it is resized.
clientmethod onstartHandler() [ Language = javascript ]
This is called when the template is first displayed; This provides a chance to set focus etc.
clientmethod previousPage() [ Language = javascript ]
Go to the previous page of the template (if there is one).
clientmethod tabChange(tabGroup) [ Language = javascript ]
Notification that a new tab was selected.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab