Skip to content

Commit

Permalink
add documentation for the "drillThrough" event
Browse files Browse the repository at this point in the history
  • Loading branch information
jkissel committed Nov 29, 2023
1 parent 75b42f1 commit b8a59e6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased
### Added
- Documentation for the `'drillThrough'` event for `CadenzaClient#show` and `CadenzaClient#showMap`

## 2.0.0 - 2023-11-23
### Changed
Expand Down
7 changes: 7 additions & 0 deletions src/cadenza.js
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,10 @@ export class CadenzaClient {
* @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
* @return {Promise<void>} A Promise for when the iframe is loaded
* @throws For invalid arguments
* @fires `drillThrough` - When the user executed a POST message drill-through.
* The event includes a row of values for each row in the workbook selection, each row consisting of the values of
* the attributes that were selected for the POST message content. If the drill-through was executed from a map
* view, each row includes the geometry of the select object as the last value.
*/
show(
source,
Expand Down Expand Up @@ -251,6 +255,9 @@ export class CadenzaClient {
* @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
* @return {Promise<void>} A Promise for when the iframe is loaded
* @throws For invalid arguments
* @fires `drillThrough` - When the user executed a POST message drill-through.
* The event includes a row of values for each row in the workbook selection, each row consisting of the values of
* the attributes that were selected for the POST message content plus the geometry of the select object as the last value.
*/
async showMap(
mapView,
Expand Down

0 comments on commit b8a59e6

Please sign in to comment.