# chartjs-plugin-zoom - v2.2.0
# Variables
# default
• default: Object
# Type declaration
| Name | Type |
|---|---|
defaults | ZoomPluginOptions |
id | string |
panFunctions | Record<string, PanFunction> |
version | string |
zoomFunctions | Record<string, ZoomFunction> |
zoomRectFunctions | Record<string, ZoomRectFunction> |
afterDatasetsDraw | (chart: Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown>, _args: unknown, options: ZoomPluginOptions) => void |
afterDraw | (chart: Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown>, _args: unknown, options: ZoomPluginOptions) => void |
beforeDatasetsDraw | (chart: Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown>, _args: unknown, options: ZoomPluginOptions) => void |
beforeDraw | (chart: Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown>, _args: unknown, options: ZoomPluginOptions) => void |
beforeEvent | (chart: Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown>, __namedParameters: { cancelable: true ; event: ChartEvent ; inChartArea: boolean ; replay: boolean }) => boolean | void |
beforeUpdate | (chart: Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown>, _args: unknown, options: ZoomPluginOptions) => void |
start | (chart: Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown>, _args: unknown, options: ZoomPluginOptions) => void |
stop | (chart: Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown>) => void |
# Defined in
plugin.ts:65 (opens new window)
# Functions
# pan
▸ pan(chart, delta, enabledScales?, transition?): void
# Parameters
| Name | Type | Default value |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown> | undefined |
delta | PanAmount | undefined |
enabledScales? | Scale<CoreScaleOptions>[] | undefined |
transition | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | "zoom" | 'none' |
# Returns
void
# Defined in
core.ts:210 (opens new window)
# resetZoom
▸ resetZoom(chart, transition?): void
# Parameters
| Name | Type | Default value |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown> | undefined |
transition | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | "zoom" | 'default' |
# Returns
void
# Defined in
core.ts:141 (opens new window)
# zoom
▸ zoom(chart, amount, transition?, trigger?): void
# Parameters
| Name | Type | Default value |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown> | undefined |
amount | ZoomAmount | undefined |
transition | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | "zoom" | 'none' |
trigger | ZoomTrigger | 'api' |
# Returns
void
# Defined in
# zoomRect
▸ zoomRect(chart, p0, p1, transition?, trigger?): void
# Parameters
| Name | Type | Default value |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown> | undefined |
p0 | Point | undefined |
p1 | Point | undefined |
transition | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | "zoom" | 'none' |
trigger | ZoomTrigger | 'api' |
# Returns
void
# Defined in
# zoomScale
▸ zoomScale(chart, scaleId, range, transition?, trigger?): void
# Parameters
| Name | Type | Default value |
|---|---|---|
chart | Chart<keyof ChartTypeRegistry, (null | number | [number, number] | Point | BubbleDataPoint)[], unknown> | undefined |
scaleId | string | undefined |
range | ScaleRange | undefined |
transition | "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | "zoom" | 'none' |
trigger | ZoomTrigger | 'api' |
# Returns
void