deno.land / x / billboardjs@3.6.0 / config / Options / interaction / zoom.ts
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687/** * Copyright (c) 2017 ~ present NAVER Corp. * billboard.js project is licensed under the MIT license *//** * zoom config options */export default { /** * Set zoom options * @name zoom * @memberof Options * @type {object} * @property {object} zoom Zoom object * @property {boolean} [zoom.enabled=false] Enable zooming. * - **NOTE:** for ESM imports, needs to import 'zoom' exports and instantiate it by calling `zoom()`. * - `enabled: zoom()` * @property {string} [zoom.type='wheel'] Set zoom interaction type. * - **Available types:** * - wheel * - drag * @property {boolean} [zoom.rescale=false] Enable to rescale after zooming.<br> * If true set, y domain will be updated according to the zoomed region. * @property {Array} [zoom.extent=[1, 10]] Change zoom extent. * @property {number|Date} [zoom.x.min] Set x Axis minimum zoom range * @property {number|Date} [zoom.x.max] Set x Axis maximum zoom range * @property {Function} [zoom.onzoomstart=undefined] Set callback that is called when zooming starts.<br> * Specified function receives the zoom event. * @property {Function} [zoom.onzoom=undefined] Set callback that is called when the chart is zooming.<br> * Specified function receives the zoomed domain. * @property {Function} [zoom.onzoomend=undefined] Set callback that is called when zooming ends.<br> * Specified function receives the zoomed domain. * @property {boolean|object} [zoom.resetButton=true] Set to display zoom reset button for 'drag' type zoom * @property {Function} [zoom.resetButton.onclick] Set callback when clicks the reset button. The callback will receive reset button element reference as argument. * @property {string} [zoom.resetButton.text='Reset Zoom'] Text value for zoom reset button. * @see [Demo:zoom](https://naver.github.io/billboard.js/demo/#Interaction.Zoom) * @see [Demo:drag zoom](https://naver.github.io/billboard.js/demo/#Interaction.DragZoom) * @example * zoom: { * enabled: true, * type: "drag", * rescale: true, * extent: [1, 100] // enable more zooming * x: { * min: -1, // set min range * max: 10 // set max range * }, * onzoomstart: function(event) { ... }, * onzoom: function(domain) { ... }, * onzoomend: function(domain) { ... }, * * // show reset button when is zoomed-in * resetButton: true, * * resetButton: { * // onclick callback when reset button is clicked * onclick: function(button) { * button; // Reset button element reference * ... * }, * * // customized text value for reset zoom button * text: "Unzoom" * } * } * @example * // importing ESM * import bb, {zoom} from "billboard.js"; * * zoom: { * enabled: zoom(), * ... * } */ zoom_enabled: <boolean> false, zoom_type: <"wheel" | "drag"> "wheel", zoom_extent: <number[]|undefined> undefined, zoom_privileged: false, zoom_rescale: false, zoom_onzoom: <Function|undefined> undefined, zoom_onzoomstart: <Function|undefined> undefined, zoom_onzoomend: <Function|undefined> undefined, zoom_resetButton: <{text: string;}|boolean> true, zoom_x_min: <Number|Date|undefined> undefined, zoom_x_max: <Number|Date|undefined> undefined};
Version Info