Class %DeepSee.UI.Dialog.WidgetWizard

class %DeepSee.UI.Dialog.WidgetWizard extends %DeepSee.UI.Dialog.standardDialog

This dialog creates a new widget for a dashboard.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	22	21

Summary

This is a Zen Page class.

Properties
%condition	%import	%includeFiles	%page
%resource	FirstFailed	InvalidParam	IsEMSReadOnly
ValidationErrorMsg	align	aux	backgroundTimerInterval
cellAlign	cellSize	cellStyle	cellVAlign
children	composite	containerStyle	controlDefs
cssLevel	dashboardName	dataLink	dataPropertyDefs
dataSeriesDefs	dataSource	dialogTitle	disabled
disabledStyle	dragAndDrop	dragEnabled	drillDownDataSource
dropEnabled	enclosingClass	enclosingStyle	error
groupClass	groupStyle	height	hidden
hideApplyButton	hideCancelButton	hint	hintClass
hintStyle	id	index	label
labelClass	labelDisabledClass	labelPosition	labelStyle
layout	localDataSource	name	onafterdrag
onbeforedrag	onclick	ondrag	ondrop
onhide	onrefresh	onshow	onupdate
parent	previewName	showLabel	showPreview
slice	title	tuple	useSVG
useSoftModals	valign	visible	widgetCount
widgetDescription	widgetKey	widgetKeywords	widgetName
widgetNames	widgetOwner	widgetPropertyArray	widgetResource
widgetSubtype	widgetTemplateName	widgetType	width
window	zenPersistentPopup

Methods
%AddChild	%AddChildAfter	%AddChildBefore	%AddComponent
%AddImportedComponents	%AddToSaveSet	%ApplyURLParms	%Attr
%BindExport	%ClassIsLatestVersion	%ClassName	%ConstructClone
%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty	%DispatchMethod
%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty	%DrawAutoLogout
%DrawClassDefinitions	%DrawComponentHTML	%DrawHTML	%DrawHTMLPage
%DrawJSStrings	%DrawObjectDefinitions	%DrawTitle	%EnclosingDivId
%EndBackgroundMethod	%EndScript	%Eval	%EvalC
%Extends	%ForceClientRender	%GetChildIndex	%GetComponent
%GetComponentById	%GetComponentByName	%GetEventHandlers	%GetLinks
%GetPageName	%GetParameter	%GetValueById	%GetValueByName
%GetXMLName	%IsA	%IsModified	%Link
%LinkCSS	%LinkScript	%MakeId	%New
%NormalizeObject	%ObjectModified	%OnAddToPageAfter	%OnAddToPageBefore
%OnAfterCreatePage	%OnBeforeCreatePage	%OnCreateApplication	%OnCreatePage
%OnDetermineCSSLevel	%OnDrawEnclosingDiv	%OnDrawHTMLBody	%OnDrawHTMLHead
%OnDrawHTMLMeta	%OnDrawObjectProperties	%OnFinishBackgroundTask	%OnGetSubtitle
%OnGetTitle	%OnMonitorBackgroundTask	%OnMutateChildren	%OnObjectSynch
%OnPreHTTP	%OnSubmit	%OnUseSoftModals	%OnZENDeserialize
%OriginalNamespace	%PackageName	%QuoteValue	%QuoteValueL10N
%RemoveChild	%RemoveChildren	%RemoveComponent	%RemoveFromSaveSet
%RunBackgroundMethod	%Self	%SerializeObject	%SetBackgroundMethodStatus
%SetErrorById	%SetErrorByName	%SetModified	%SetValueById
%SetValueByName	%SetValuesByName	%StartScript	%ValidateObject
%ZENVersion	AddWidgetToDashboard	ConvertParameter	Decrypt
Encrypt	EscapeHTML	EscapeURL	EvalResult
GetWidgetInfo	GetWidgetTypeList	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields	IsPrivate
JavaInstalled	Link	OnHTTPHeader	OnPage
OnPageError	OnPostHTTP	OnPostHyperEvent	OnPreHTTP
OnPreHyperEvent	Page	QuoteJS	RewriteURL
ShowError	StartTimer	StopTimer	ThrowError
UnescapeHTML	UnescapeURL	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	addChild	addChildAfter
addChildBefore	adjustSize	browseDataSources	browseDrillDataSources
btnApply	btnOK	cancelPopup	childrenMutated
chooseDataSource	clearDataSource	clearDrillDataSource	correctIELayering
createComponent	createComponentNS	ctrlKeyDown	dataSourceChange
deleteComponent	dialogApply	dialogCancel	dialogFinish
dialogTitleGet	disableButtons	dragFinishHandler	dragHandler
dragNotifyHandler	dragStartHandler	dropHandler	dropStartHandler
endModal	exposeComponent	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getDialogValue	getEnclosingDiv
getHidden	getHintElement	getLabelElement	getOpener
getProperty	getSettings	getType	gotoPage
invokeSuper	isOfType	launchPopupWindow	loadKPI
loadPivot	loadWorksheet	makeId	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onPopupAction
onRefreshContents	onSerialize	onServerMethodCall	onServerMethodError
onServerMethodReturn	onStartModalHandler	ondialogCancel	ondialogFinish
ondialogStart	ondisabledHandler	onhandleAutoLogoutWarn	onkeydownHandler
onkeyupHandler	onlayoutHandler	onloadHandler	onlogoutHandler
onoverlayHandler	onresizeHandler	onunloadHandler	onupdateHandler
popupActionHandler	refreshContents	removeChild	render
renderContents	renderSVG	resetMsg	selectWidgetType
setComponentId	setHidden	setOverlayMode	setProperty
setPropertyAll	setTraceOption	showMsg	startModal
startProgressBar	stopProgressBar	stripWhitespaces	validateRequired

Parameters

• parameter APPLYBUTTON = 0;

If true, then this dialog displays an Apply button.

Properties

• property controlDefs as list of %DeepSee.Component.controlDefinition;

List of control definitions for the widget.

• property dashboardName as %ZEN.Datatype.string(ZENURL="DASHBOARD");

Dashboard name.

• property dataLink as %ZEN.Datatype.string;

Data link name.

• property dataPropertyDefs as list of %DeepSee.Component.dataPropertyDefinition;

List of data property definitions for the widget.

• property dataSeriesDefs as list of %DeepSee.Component.dataSeriesDefinition;

List of data series definitions for the widget.

• property dataSource as %ZEN.Datatype.string;

Data source name.

• property drillDownDataSource as %ZEN.Datatype.string;

Drill down data source name.

• property localDataSource as %ZEN.Datatype.string;

Local data source name (if any).

• property previewName as %ZEN.Datatype.string;

Name of dashboard used to hold preview copy.

• property showPreview as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Should dialog show the widget preview.

• property widgetCount as %ZEN.Datatype.csv(ZENURL="COUNT");

Number of widgets on dashboard.

• property widgetDescription as %ZEN.Datatype.string;

Description of the widget (if any).

• property widgetKey as %ZEN.Datatype.string(ZENURL="KEY");

Key for widget (if editing).

• property widgetKeywords as %ZEN.Datatype.string;

Keywords of the saved widget (if any).

• property widgetName as %ZEN.Datatype.string(ZENURL="WIDGETNAME");

Name of widget (on the dashboard).

• property widgetNames as %ZEN.Datatype.csv(ZENURL="NAMES");

List of current widget names on dashboard.

• property widgetOwner as %ZEN.Datatype.string(MAXLEN=255);

Widget owner.

• property widgetPropertyArray as array of %ZEN.Datatype.string;

Additional name/value pairs for the widget.

• property widgetResource as %ZEN.Datatype.string(MAXLEN=255);

Widget resource.

• property widgetSubtype as %ZEN.Datatype.string;

Current selected widget subtype.

• property widgetTemplateName as %ZEN.Datatype.string;

Name used to save this widget to the catalog!

• property widgetType as %ZEN.Datatype.string;

Current selected widget type.

Methods

• method %OnAfterCreatePage() as %Status

Apply changes to page.

• method %OnGetSubtitle() as %String

Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.

• method %OnGetTitle() as %String

Get the (localized) title string for the dialog. This should be implemented in a subclass.

• method AddWidgetToDashboard(pDashboardName As %String, pWidgetName As %String, pInfo As %ZEN.proxyObject, pPreview As %Boolean = 0) as %String [ ZenMethod ]

Add a widget to the given dashboard definition. If pPreview, then save to the private preview dashboard.

• classmethod GetWidgetInfo(pKey As %String, pInfo As %ZEN.proxyObject) as %String [ ZenMethod ]

Get info on the selected widget.

• method GetWidgetTypeList(ByRef pParameters, Output pMetaData, Output pData) as %Status

Return JSON array of widget types.

• method adjustSize() [ Language = javascript ]

Adjust size and position of components on this page.

• method browseDataSources() [ Language = javascript ]

Launch the data source finder.

• method browseDrillDataSources() [ Language = javascript ]

Launch the data source finder.

• method chooseDataSource(id) [ Language = javascript ]

Show data source finder for widget property control

• method clearDataSource() [ Language = javascript ]

Clear the data source. If there is a local override, first clear it and restore the original value.

• method clearDrillDataSource() [ Language = javascript ]

Clear the data source.

• method dataSourceChange() [ Language = javascript ]

User edit of dataSource.

• method getDialogValue() [ Language = javascript ]

Get the value that will be applied when the user presses the OK button. This is implemented by subclasses.

• method loadKPI() [ Language = javascript ]

Launch the KPI finder dialog.

• method loadPivot() [ Language = javascript ]

Launch the pivot finder dialog.

• method loadWorksheet() [ Language = javascript ]

Launch the worksheet finder dialog.

• method onPopupAction(popupName, action, value) [ Language = javascript ]

This client event is fired when the a popup page launched from this page fires an action.

• method ondialogFinish(action) as %Boolean [ Language = javascript ]

This callback, if defined, is called when the user presses the OK or Apply action buttons. If this returns false, then the action is cancelled.

• method ondialogStart() [ Language = javascript ]

This callback, if defined, is called when the dialog page is loaded.

• method selectWidgetType(key) [ Language = javascript ]

User selected a widget type.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search