Skip to content

[plotly.js] Updated types for LayoutAxis and Axis to match current API #70014

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 3 commits into from
Jul 10, 2024
Merged

[plotly.js] Updated types for LayoutAxis and Axis to match current API #70014

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a3fc53d
Updated types for LayoutAxis and Axis to match current API
acolvin-h1 Jul 9, 2024
5878caa
Fix linting error, bump version in package.json
acolvin-h1 Jul 9, 2024
dda3e16
Fix version number in package.json
acolvin-h1 Jul 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 63 additions & 1 deletion types/plotly.js/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,6 +586,40 @@ export interface TickFormatStop {
templateitemname: string;
}

export interface AutoRangeOptions {
clipmax: DTickValue;
clipmin: DTickValue;
include: DTickValue;
maxallowed: DTickValue;
minallowed: DTickValue;
}

export interface MinorAxisLayout {
dtick: DTickValue;
gridcolor: Color;
griddash: Dash;
gridwidth: number;
nticks: number;
showgrid: boolean;
tick0: DTickValue;
tickcolor: Color;
ticklen: number;
tickmode: "auto" | "linear" | "array";
ticks: "outside" | "inside" | "";
tickvals: any[];
tickwidth: number;
}

export interface RangeBreak {
bounds: any[];
dvalue: number;
enabled: boolean;
name: string;
pattern: "day of week" | "hour" | "";
templateitemname: string;
values: any[];
}

export interface Axis {
/**
* A single toggle to hide the axis while preserving interaction like dragging.
Expand All @@ -607,7 +641,8 @@ export interface Axis {
*/
titlefont: Partial<Font>;
type: AxisType;
autorange: true | false | "reversed";
autorange: true | false | "reversed" | "min reversed" | "max reversed" | "min" | "max";
autorangeoptions: Partial<AutoRangeOptions>;
/**
* 'If *normal*, the range is computed in relation to the extrema
* of the input data.
Expand Down Expand Up @@ -822,6 +857,11 @@ export interface Axis {
* Only has an effect on *multicategory* axes.
*/
dividerwidth: number;

autotypenumbers: "convert types" | "strict";
labelalias: DTickValue;
maxallowed: DTickValue;
minallowed: DTickValue;
}

export type Calendar =
Expand Down Expand Up @@ -867,6 +907,28 @@ export interface LayoutAxis extends Axis {
angle: any;
griddash: Dash;
l2p: (v: Datum) => number;

autotickangles: number[];
insiderange: any[];
matches: AxisName;
minor: Partial<MinorAxisLayout>;
rangebreaks: Array<Partial<RangeBreak>>;
ticklabelmode: "instant" | "period";
ticklabeloverflow: "allow" | "hide past div" | "hide past domain";
ticklabelposition:
| "outside"
| "inside"
| "outside top"
| "inside top"
| "outside left"
| "inside left"
| "outside right"
| "inside right"
| "outside bottom"
| "inside bottom";
ticklabelstep: number;
tickson: "labels" | "boundaries";
uirevision: DTickValue;
}

export interface SceneAxis extends Axis {
Expand Down
2 changes: 1 addition & 1 deletion types/plotly.js/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"private": true,
"name": "@types/plotly.js",
"version": "2.29.9999",
"version": "2.33.9999",
"projects": [
"https://plot.ly/javascript/",
"https://github.com/plotly/plotly.js"
Expand Down