Skip to content

Commit

Permalink
docs(api): rename specProcessed to specResolved
Browse files Browse the repository at this point in the history
  • Loading branch information
thomcsmits committed Oct 19, 2023
1 parent 8abb9a8 commit c6de69b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/js-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Subscribe the callback function to the specified event.

- **eventName**: string
Specify the event using its name.
One of `"mouseOver"`, `"rangeSelect"`, `"click"`, `"rawData"`, `"onNewTrack"`, `"onNewView"`, `"location"`, `"specProcessed"`.
One of `"mouseOver"`, `"rangeSelect"`, `"click"`, `"rawData"`, `"onNewTrack"`, `"onNewView"`, `"location"`, `"specResolved"`.

- **callback**: `(msg:string, eventData)=>void`
A function that is subscribed to the specified event.
Expand Down Expand Up @@ -201,7 +201,7 @@ One of `"mouseOver"`, `"rangeSelect"`, `"click"`, `"rawData"`, `"onNewTrack"`, `
}
```

- For `"specProcessed"`, the `eventData` stores the spec as processed in the compiler, resolving defaults and attributes inherited from a parent view, as well as flattening overlaid tracks.
- For `"specResolved"`, the `eventData` stores the spec as processed in the compiler, resolving defaults and attributes inherited from a parent view, as well as flattening overlaid tracks.
```javascript
{
id: string,
Expand All @@ -219,4 +219,4 @@ Unsubscribe the callback function from the specified event.

- **eventName**: string
Name of the event.
One of `"mouseOver"`, `"rangeSelect"`, `"click"`, `"rawData"`, `"location"`, `"specProcessed"`.
One of `"mouseOver"`, `"rangeSelect"`, `"click"`, `"rawData"`, `"location"`, `"specResolved"`.

0 comments on commit c6de69b

Please sign in to comment.