From 9922d95b74a80bddd381c4e7797953471759ab9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20B=C5=82a=C5=BCejewicz=20=28Peter=20Blazejewicz=29?= Date: Tue, 7 Apr 2020 04:22:31 +0200 Subject: [PATCH] fix(plotly.js): fix minor errors (#43636) - missing optional `extendTraces` parameter of `extendTraces` - remove superflous `autoScale2d` type from `ModeBarDefaultButtons` - add test for optional `maxPoints` parameter - reformat `ModeBarDefaultButtons` for better readability when adding/chaning supported types Fixes comment: https://github.com/DefinitelyTyped/DefinitelyTyped/pull/42882#issuecomment-609016691 Thanks /cc @mmakrzem --- types/plotly.js/index.d.ts | 37 +++++++++++++++++++++++------ types/plotly.js/test/index-tests.ts | 3 +++ 2 files changed, 33 insertions(+), 7 deletions(-) diff --git a/types/plotly.js/index.d.ts b/types/plotly.js/index.d.ts index 81f268f449..bbf21412da 100644 --- a/types/plotly.js/index.d.ts +++ b/types/plotly.js/index.d.ts @@ -212,7 +212,7 @@ export function update(root: Root, traceUpdate: Data, layoutUpdate: Partial; export function deleteTraces(root: Root, indices: number[] | number): Promise; export function moveTraces(root: Root, currentIndices: number[] | number, newIndices?: number[] | number): Promise; -export function extendTraces(root: Root, update: Data | Data[], indices: number | number[]): Promise; +export function extendTraces(root: Root, update: Data | Data[], indices: number | number[], maxPoints?: number): Promise; export function prependTraces(root: Root, update: Data | Data[], indices: number | number[]): Promise; export function toImage(root: Root, opts: ToImgopts): Promise; export function downloadImage(root: Root, opts: DownloadImgopts): Promise; @@ -463,12 +463,35 @@ export interface Margin { pad: number; } -export type ModeBarDefaultButtons = 'lasso2d' | 'select2d' | 'sendDataToCloud' | 'autoScale2d' | - 'zoom2d' | 'pan2d' | 'zoomIn2d' | 'zoomOut2d' | 'autoScale2d' | 'resetScale2d' | - 'hoverClosestCartesian' | 'hoverCompareCartesian' | 'zoom3d' | 'pan3d' | 'orbitRotation' | - 'tableRotation' | 'resetCameraDefault3d' | 'resetCameraLastSave3d' | 'hoverClosest3d' | - 'zoomInGeo' | 'zoomOutGeo' | 'resetGeo' | 'hoverClosestGeo' | 'hoverClosestGl2d' | - 'hoverClosestPie' | 'toggleHover' | 'toImage' | 'resetViews' | 'toggleSpikelines'; +export type ModeBarDefaultButtons = + | 'lasso2d' + | 'select2d' + | 'sendDataToCloud' + | 'zoom2d' + | 'pan2d' + | 'zoomIn2d' + | 'zoomOut2d' + | 'autoScale2d' + | 'resetScale2d' + | 'hoverClosestCartesian' + | 'hoverCompareCartesian' + | 'zoom3d' + | 'pan3d' + | 'orbitRotation' + | 'tableRotation' + | 'resetCameraDefault3d' + | 'resetCameraLastSave3d' + | 'hoverClosest3d' + | 'zoomInGeo' + | 'zoomOutGeo' + | 'resetGeo' + | 'hoverClosestGeo' + | 'hoverClosestGl2d' + | 'hoverClosestPie' + | 'toggleHover' + | 'toImage' + | 'resetViews' + | 'toggleSpikelines'; export type ButtonClickEvent = (gd: PlotlyHTMLElement, ev: MouseEvent) => void; diff --git a/types/plotly.js/test/index-tests.ts b/types/plotly.js/test/index-tests.ts index cd217292c4..098e368b75 100644 --- a/types/plotly.js/test/index-tests.ts +++ b/types/plotly.js/test/index-tests.ts @@ -340,6 +340,9 @@ function rand() { // extend multiple traces Plotly.extendTraces(graphDiv, { y: [[rand()], [rand()]] }, [0, 1]); + + // extend multiple traces up to a maximum of 10 points per trace + Plotly.extendTraces(graphDiv, {y: [[rand()], [rand()]]}, [0, 1], 10); })(); //////////////////////////////////////////////////////////////////////