vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-04 06:47:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(plotly.js): fix minor errors (#43636)

Browse Source 
- 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
This commit is contained in:
Piotr Błażejewicz (Peter Blazejewicz)
2020-04-06 19:22:31 -07:00
committed by GitHub
parent 7d69a9dfa2
commit 9922d95b74
2 changed files with 33 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/plotly.js/index.d.ts
Vendored
+30 -7
View File
@@ -212,7 +212,7 @@ export function update(root: Root, traceUpdate: Data, layoutUpdate: Partial<Layo
export function addTraces(root: Root, traces: Data | Data[], newIndices?: number[] | number): Promise<PlotlyHTMLElement>;
export function deleteTraces(root: Root, indices: number[] | number): Promise<PlotlyHTMLElement>;
export function moveTraces(root: Root, currentIndices: number[] | number, newIndices?: number[] | number): Promise<PlotlyHTMLElement>;
export function extendTraces(root: Root, update: Data | Data[], indices: number | number[]): Promise<PlotlyHTMLElement>;
export function extendTraces(root: Root, update: Data | Data[], indices: number | number[], maxPoints?: number): Promise<PlotlyHTMLElement>;
export function prependTraces(root: Root, update: Data | Data[], indices: number | number[]): Promise<PlotlyHTMLElement>;
export function toImage(root: Root, opts: ToImgopts): Promise<string>;
export function downloadImage(root: Root, opts: DownloadImgopts): Promise<string>;
@@ -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;
types/plotly.js/test/index-tests.ts
+3
View File
@@ -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);
})();
//////////////////////////////////////////////////////////////////////