ObjectHandle

An ObjectHandle is used to perform actions on a single object in an open report. An object's handle can be obtained using the getObjectHandle method on a ReportHandle.

When a report element is assigned new attribute values or removed from the DOM, any ObjectHandles obtained from that element are invalidated and should be discarded.

Properties

readyState: string

The ready state of the report object. When this value changes, a readyStateChanged event is fired on the ObjectHandle.

This value can be one of the following:

• "contentLoading" when the report object is still loading its content.
• "complete" when the report object has finished loading.
• "error" when the report object encountered an error and could not load.

Methods

exportData(format: string, options?: ExportDataOptions): Promise<string>

Exports a file that contains the object's data, and returns a URL to the file.

format defines the format of the data output file. Supported formats:

• "XLSX"
• "CSV"
• "TSV"

options is an ExportDataOptions bundle that modifies properties of the exported data file.

If no options parameter is supplied, the data will be exported using the default option values.

exportPDF(options?: ExportPDFOptions): Promise<string>

Exports a PDF of the report object and returns a URL to the PDF document.

options is an ExportPDFOptions that controls the format of the exported PDF document. The option includedReportObjects does not apply when exporting a report object.

If no options parameter is supplied, the report is exported using the default options values.

refreshData(): void

Refreshes the data for the report object that is controlled by the ObjectHandle.

getData(options?: Object): ReportObjectResultData[]

Returns all of the data from the report object. This data matches what appears in the report object, including any filters that have been applied.

Arguments

options is an optional options bundle for customizing the returned data. The following options are supported:

• formatData specifies the format of the returned data.
  • true returns all formatted data.
  • false returns all unformatted data.
  • "datesOnly" default returns SAS date values as formatted data and returns all other values as unformatted data.

Return value

Returns an array of ReportObjectResultData objects, where each object is associated with one data set.

getSelectedData(options?: Object): ReportObjectResultData[]

Returns a user's selection data from the report object. Returns an empty array if the object has no selections.

Arguments

options is an optional options bundle for customizing the returned data. The following options are supported:

• formatData specifies the format of the returned data.
  • true returns all formatted data.
  • false returns all unformatted data.
  • "datesOnly" default returns SAS date values as formatted data and returns all other values as unformatted data.

Return value

Returns an array of ReportObjectResultData objects, where each object is associated with one data set.

For user selection data, the ReportObjectResultData property columns will never include values for usage, aggregation, or format.

addEventListener(eventType: string, listener: (event: Object) => void)

Adds an event listener to the ObjectHandle to call the supplied listener when the specified event occurs.

Arguments

eventType is a string that represents the event type to listen for. These event types are supported:

• "selectionChanged" for listening for selection changes in the object.
• "readyStateChanged" for listening to changes on the readyState property.

listener is an event listener callback function. When the event occurs, listener is called and passed an event object containing the following properties:

• type is a string that matches the event type.
• target refers to the ObjectHandle that the event occurred on.

removeEventListener(eventType: string, listener: (event: Object) => void)

Removes the previously registered event listener from the ObjectHandle.