Skip to content

Commit

Permalink
Add getData documentation (#56)
Browse files Browse the repository at this point in the history
* Add getData documentation

* review
  • Loading branch information
eheckel authored Nov 15, 2023
1 parent 9960104 commit 6096d8c
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions sdk/va-report-components/documentation/docs/api/ObjectHandle.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,23 @@ If no `options` parameter is supplied, the report is exported using the default
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`](ReportObjectResultData.md) 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.
Expand All @@ -48,9 +65,9 @@ Returns a user's selection data from the report object. Returns an empty array i
`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 only SAS date values as formatted and all other data is unformatted
- `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

Expand Down

0 comments on commit 6096d8c

Please sign in to comment.