Skip to content

Commit 6096d8c

Browse files
authored
Add getData documentation (#56)
* Add getData documentation * review
1 parent 9960104 commit 6096d8c

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

sdk/va-report-components/documentation/docs/api/ObjectHandle.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,23 @@ If no `options` parameter is supplied, the report is exported using the default
3939
Refreshes the data for the report object that is controlled by the
4040
`ObjectHandle`.
4141

42+
### getData(options?: Object): ReportObjectResultData[]
43+
44+
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.
45+
46+
#### Arguments
47+
48+
`options` is an optional options bundle for customizing the returned data. The following options are supported:
49+
50+
- `formatData` specifies the format of the returned data.
51+
- `true` returns all formatted data.
52+
- `false` returns all unformatted data.
53+
- `"datesOnly"` `default` returns SAS date values as formatted data and returns all other values as unformatted data.
54+
55+
#### Return value
56+
57+
Returns an array of [`ReportObjectResultData`](ReportObjectResultData.md) objects, where each object is associated with one data set.
58+
4259
### getSelectedData(options?: Object): ReportObjectResultData[]
4360

4461
Returns a user's selection data from the report object. Returns an empty array if the object has no selections.
@@ -48,9 +65,9 @@ Returns a user's selection data from the report object. Returns an empty array i
4865
`options` is an optional options bundle for customizing the returned data. The following options are supported:
4966

5067
- `formatData` specifies the format of the returned data.
51-
- `true` returns all formatted data
52-
- `false` returns all unformatted data
53-
- `"datesOnly"` `default` returns only SAS date values as formatted and all other data is unformatted
68+
- `true` returns all formatted data.
69+
- `false` returns all unformatted data.
70+
- `"datesOnly"` `default` returns SAS date values as formatted data and returns all other values as unformatted data.
5471

5572
#### Return value
5673

0 commit comments

Comments
 (0)