{"description":"<p>Musical pitch refers to how high or low notes are played.</p>\n<p>By default it is mapped to <code>y</code> so low <code>y</code> values are played\nwith a lower pitch, and high values are played with a higher\npitch.</p>\n<p>Pitch mapping has a few extra features compared to other\naudio parameters.</p>\n<p>Firstly, it accepts not only number values, but also string\nvalues denoting note names. These are given in the form\n<code>&lt;note&gt;&lt;octave&gt;</code>, for example <code>&quot;c6&quot;</code> or <code>&quot;F#2&quot;</code>.</p>\n<p>Secondly, it is possible to map pitch to an array of notes.\nIn this case, the <code>[gapBetweenNotes](#sonification.defaultInstrumentOptions.mapping.gapBetweenNotes)</code>\nmapping determines the delay between these notes.</p>\n<p>Thirdly, it is possible to define a musical scale to follow\nwhen mapping.</p>\n<p>Can be set to a fixed value, an array, a prop to map to, a\nfunction, or a mapping object.</p>\n","samples":[{"name":"Various types of mapping used","value":"highcharts/sonification/pitch-mapping"},{"name":"Inverted mapping to property","value":"highcharts/sonification/polarity-invert"},{"name":"Logarithmic mapping to property","value":"highcharts/sonification/log-mapping"}],"typeList":{"names":["string","number","function","Array.<(string|number)>","*"]},"children":[{"description":"<p>How to perform the mapping.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.globalTracks.mapping.pitch.mapFunction","isLeaf":true,"line":611,"lineEnd":618,"name":"mapFunction","samples":[{"name":"Logarithmic mapping to property","value":"highcharts/sonification/log-mapping"}],"typeList":{"names":["\"linear\"","\"logarithmic\""]},"version":"12.6.0"},{"default":"y","description":"<p>A point property to map the mapping parameter to.</p>\n<p>A negative sign <code>-</code> can be placed before the property name\nto make mapping inverted.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.globalTracks.mapping.pitch.mapTo","isLeaf":true,"line":699,"lineEnd":699,"name":"mapTo","samples":[{"name":"Inverted mapping to property","value":"highcharts/sonification/polarity-invert"}],"typeList":{"names":["string"]},"version":"12.6.0"},{"default":"c6","description":"<p>The maximum value for the audio parameter. This is the\nhighest value the audio parameter will be mapped to.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.globalTracks.mapping.pitch.max","isLeaf":true,"line":701,"lineEnd":701,"name":"max","typeList":{"names":["string"]},"version":"12.6.0"},{"default":"c2","description":"<p>The minimum value for the audio parameter. This is the\nlowest value the audio parameter will be mapped to.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.globalTracks.mapping.pitch.min","isLeaf":true,"line":700,"lineEnd":700,"name":"min","typeList":{"names":["string"]},"version":"12.6.0"},{"description":"<p>Map pitches to a musical scale. The scale is defined as an\narray of semitone offsets from the root note.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.globalTracks.mapping.pitch.scale","isLeaf":true,"line":704,"lineEnd":713,"name":"scale","samples":[{"name":"Predefined scale presets","value":"highcharts/sonification/all-scales"}],"supportsArray":true,"typeList":{"names":["Array.<number>"]},"version":"12.6.0"},{"description":"<p>A fixed value to use for the prop when mapping.</p>\n<p>For example, if mapping to <code>y</code>, setting value to <code>4</code> will\nmap as if all points had a y value of 4.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.globalTracks.mapping.pitch.value","isLeaf":true,"line":619,"lineEnd":630,"name":"value","samples":[{"name":"Map to fixed y value","value":"highcharts/demo/plotline-context"}],"typeList":{"names":["number"]},"version":"12.6.0"},{"default":"yAxis","description":"<p>What data values to map the parameter within.</p>\n<p>Mapping within <code>&quot;series&quot;</code> will make the lowest value point\nin the series map to the min audio parameter value, and the\nhighest value will map to the max audio parameter.</p>\n<p>Mapping within <code>&quot;chart&quot;</code> will make the lowest value point in\nthe whole chart map to the min audio parameter value, and\nthe highest value in the whole chart will map to the max\naudio parameter.</p>\n<p>You can also map within the X or Y axis of each series.</p>\n","filename":"ts/Extensions/Sonification/Options.ts","fullname":"sonification.globalTracks.mapping.pitch.within","isLeaf":true,"line":702,"lineEnd":702,"name":"within","samples":[{"name":"Mapping within demonstrated","value":"highcharts/sonification/mapping-within"}],"typeList":{"names":["string"]},"version":"12.6.0"}]}