Exago Logo
Search
Generic filters
Exact matches only

ClientInfo

This article describes the properties and methods in the clientInfo object and what they are commonly used for.

Note

If an element is not listed here, it is likely intended for internal use and should not be accessed.

Properties

showHourglass

DescriptionSet to False to disable the progress icon that appears when data is being saved or loaded.

includeReportData

DescriptionSet to False to prevent the client from passing the sessionInfo object to the server whenever a server callback is done.
RemarksIt may be useful to disable this to limit overhead if access to sessionInfo is not needed for a specific callback.

includeReportSaveData

DescriptionSet to False to prevent the client from passing the report save data to the server whenever a server callback is done.
RemarksThe SaveData is an additional set of data passed whenever a report is saved. This information is only passed by an onSaveReport global event. It may be useful to disable this to limit overhead if the save data is not needed for a specific callback.

refreshDataOnReturn

DescriptionSet to False to prevent the client Viewer from refreshing the report whenever a server callback alters report data.
RemarksIf a SaveReport callback does not alter the appearance of the report, it may be useful to disable this to limit overhead.

Utilities

DescriptionAccess to a large variety of utilities and controls.
RemarksLikely unnecessary in most cases. A pre-written action event provided to you by a support analyst may make use of this.

webReportsCtrl

DescriptionAccess to the Exago Web Application user interface elements.
RemarksOften used in order to add or remove items from the report tree sidebar. Useful for allowing Exago to handle third-party report objects.

contextObject

DescriptionA generic class for the object which the action event call was attached.
RemarksThe more specific context items below provide a superset of this class.

dashboard, dashboardItem, report, chartData, chartSeriesDataPoint, chartItemDataPoint, reportWidgets, categoriesCtrl, parameterListCtrl

DescriptionSpecific classes which are set depending on the context of the call. Contain information about the object for which the action event call was attached.
RemarksThese are set contextually depending on the object of the call. For example, chartData will only be set if the action event was attached to a chart or gauge.

uiElement

DescriptionProvides information about the UI element called by a “click” local action event. For a list of supported elements, see Actionable UI Elements.

isSandboxMode

DescriptionTrue if an action event is running in a non-interactive environment, i.e. any non-html environment, where javascript interactivity is not permitted. Includes all export types: PDF, Excel, RTF, CSV.

urlToClassify

DescriptionString value of a URL. To be classified as “external” or “internal”. Requires user confirmation if classified as external.
RemarkThis property corresponds specifically with the OnClassifyUserInputURL Global Action Event. For an example of a use case, please see Action Event: External URL Confirmation.

Methods

ServerCallback(args[])

DescriptionCall back to the server with any given arguments.

GetLanguageData(id)

DescriptionReturns the text and tooltip info from the language file for the specified UI item.

ExecuteParentFunction(func, args), GetParentFunction(func), GetParentByFunctionName(func)

DescriptionIf the Exago Web Application is running in an iframe these are helper functions to call JavaScript functions in the parent frame.
RemarksThese functions are for convenience and safety. They are generally the same as calling Parent.FunctionName.

LoadHtmlDialog(html, options)

DescriptionCreates and loads an HTML dialog box. Accepts an HTML string or an html element. Accepts several options.

SetDialogValue(elementId, value)

DescriptionPopulates the given element of a dialog with a given value.

GetDialogElementById(elementID)

DescriptionFinds and returns the element given by its ID.

Alert(alertText)

DescriptionCreates and loads an HTML alert dialog with the given text.

UpdateChart(chartWidget, chartData)

DescriptionUpdates the given chart with the given data and re-renders it in the report.

GetDashboardReports(options)

DescriptionReturns all the reports on the dashboard as report objects.

GetDashboardWidgets()

DescriptionReturns all the widgets on the dashboard (i.e. all dashboard elements besides embedded reports).

EditReport(reportName, options)

DescriptionOpens the Report Designer for the given report with options. See .NET API.

ExecuteReport(reportName, exportType, options)

DescriptionExecutes the given report with options. See .NET API.

StartNewReportWizard(reportType)

DescriptionStarts the Designer for the given report type.

GetClientReportObject(reportName)

DescriptionReturns the given report object by name.

LoadUrlToNewTab(string url)

DescriptionOpens a new tab with the provided URL as the contents.
Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents