Skip to content

Commit 7158a6d

Browse files
authored
add documentation for object readyState and hideLoadImage (#60)
* add documentation for object readyState and hideLoadImage
1 parent 10a1e5e commit 7158a6d

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,16 @@ When a report element is assigned new attribute values or removed from the DOM,
1111
any `ObjectHandles` obtained from that element are invalidated and should be
1212
discarded.
1313

14+
## Properties
15+
16+
### readyState: string
17+
The ready state of the report object. When this value changes, a `readyStateChanged` event is fired on the ObjectHandle.
18+
19+
This value can be one of the following:
20+
- `"contentLoading"` when the report object is still loading its content.
21+
- `"complete"` when the report object has finished loading.
22+
- `"error"` when the report object encountered an error and could not load.
23+
1424
## Methods
1525

1626
### exportData(format: string, options?: ExportDataOptions): Promise\<string>
@@ -83,6 +93,7 @@ Adds an event listener to the `ObjectHandle` to call the supplied listener when
8393

8494
`eventType` is a string that represents the event type to listen for. These event types are supported:
8595
- `"selectionChanged"` for listening for selection changes in the object.
96+
- `"readyStateChanged"` for listening to changes on the `readyState` property.
8697

8798
`listener` is an event listener callback function. When the event occurs, `listener` is called and passed an event object containing the following properties:
8899
- `type` is a string that matches the event type.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,12 @@ default value: `true`
6262
default value: `undefined`<br>
6363
default behavior: use a shared report context per report
6464

65+
### `hideLoadImage: boolean`
66+
67+
When `false`, report objects display a placeholder static image of the report object while it is loading. `true` hides this placeholder and displays a loading indicator.
68+
69+
default value: `false`
70+
6571

6672
## Properties
6773

0 commit comments

Comments
 (0)