{"description":"<p>Set up event handlers for the sonification</p>\n","typeList":{"names":["*"]},"children":[{"description":"<p>Called after updating the sonification.</p>\n<p>A context object is passed to the function, with properties <code>chart</code>\nand <code>timeline</code>.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.events.afterUpdate","isLeaf":true,"line":156,"lineEnd":164,"name":"afterUpdate","typeList":{"names":["function"]},"version":"12.6.0"},{"description":"<p>Called immediately when a play is requested.</p>\n<p>A context object is passed to the function, with properties <code>chart</code>\nand <code>timeline</code>.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.events.beforePlay","isLeaf":true,"line":138,"lineEnd":146,"name":"beforePlay","typeList":{"names":["function"]},"version":"12.6.0"},{"description":"<p>Called before updating the sonification.</p>\n<p>A context object is passed to the function, with properties <code>chart</code>\nand <code>timeline</code>.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.events.beforeUpdate","isLeaf":true,"line":147,"lineEnd":155,"name":"beforeUpdate","typeList":{"names":["function"]},"version":"12.6.0"},{"description":"<p>Called when attempting to play an adjacent point or series, and\nthere is none.</p>\n<p>By default a percussive sound is played.</p>\n<p>A context object is passed to the function, with properties <code>chart</code>,\n<code>timeline</code>, and <code>attemptedNext</code>. <code>attemptedNext</code> is a boolean\nproperty that is <code>true</code> if the boundary hit was from trying to play\nthe next series/point, and <code>false</code> if it was from trying to play the\nprevious.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.events.onBoundaryHit","isLeaf":true,"line":183,"lineEnd":197,"name":"onBoundaryHit","typeList":{"names":["function"]},"version":"12.6.0"},{"description":"<p>Called when play is completed.</p>\n<p>A context object is passed to the function, with properties <code>chart</code>,\n<code>timeline</code> and <code>pointsPlayed</code>. <code>pointsPlayed</code> is an array of <code>Point</code>\nobjects, referencing data points that were related to the audio\nevents played.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.events.onEnd","isLeaf":true,"line":127,"lineEnd":137,"name":"onEnd","typeList":{"names":["function"]},"version":"12.6.0"},{"description":"<p>Called on play.</p>\n<p>A context object is passed to the function, with properties <code>chart</code>\nand <code>timeline</code>.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.events.onPlay","isLeaf":true,"line":107,"lineEnd":115,"name":"onPlay","typeList":{"names":["function"]},"version":"12.6.0"},{"description":"<p>Called when finished playing a series.</p>\n<p>A context object is passed to the function, with properties <code>series</code>\nand <code>timeline</code>.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.events.onSeriesEnd","isLeaf":true,"line":174,"lineEnd":182,"name":"onSeriesEnd","typeList":{"names":["function"]},"version":"12.6.0"},{"description":"<p>Called on the beginning of playing a series.</p>\n<p>A context object is passed to the function, with properties <code>series</code>\nand <code>timeline</code>.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.events.onSeriesStart","isLeaf":true,"line":165,"lineEnd":173,"name":"onSeriesStart","typeList":{"names":["function"]},"version":"12.6.0"},{"description":"<p>Called on pause, cancel, or if play is completed.</p>\n<p>A context object is passed to the function, with properties <code>chart</code>,\n<code>timeline</code> and <code>pointsPlayed</code>. <code>pointsPlayed</code> is an array of <code>Point</code>\nobjects, referencing data points that were related to the audio\nevents played.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.events.onStop","isLeaf":true,"line":116,"lineEnd":126,"name":"onStop","typeList":{"names":["function"]},"version":"12.6.0"}]}