Skip to content

[BUG]: Typing issue in relayout() #8047

Open
#8050
Open
[BUG]: Typing issue in relayout()#8047
#8050
Assignees
camdecoster
Labels
P3backlogbugsomething brokensize: 1

Description

@AbdealiLoKo
AbdealiLoKo
opened on Sep 16, 2026

Description

Updating to plotly 4.1 caused a typing issue with relayout()

For this line of code:

Plotly.relayout(this.plotlyChartEl().plotlyInstance, {
    'xaxis.autorange': true,
    'yaxis.autorange': true,
});

I get the following error from typescript:
Image

I checked the code here at:
https://github.com/plotly/plotly.js/blob/v4.1.1/src/types/core/api.d.ts#L212
export function relayout(root: Root, layout: Partial<Layout>)
Here the Partial<Layout> seems to cause the issue.

Notes

Versions:

  • plotly.js: 4.1.0
  • angular-plotly.js: 22.0.1
  • angular: 22.1.x

Alternatives

I tried:

Plotly.relayout(this.plotlyChartEl().plotlyInstance, {
    xaxis: {autorange: true},
    yaxis: {autorange: true},
});

but this will replace the existing xaxis properties like anchor, color, etc. will be removed -- i just want to update the autorange in this line of code

Activity

  1. AbdealiLoKo
    added
    bugsomething broken
    on Sep 16, 2026

  2. camdecoster commented on Sep 16, 2026

    @camdecoster
    camdecoster
    on Sep 16, 2026
    Contributor

    Thanks for the report. This is a limitation of how plotly.js and TS interact. plotly.js allows one to update references as a string like you describe, but TS has no way to know that's valid. IIRC, DefinitelyTyped included some of the more common strings as valid options. I thought I had included some in the new types, but maybe I missed that. I'll take a look and follow up.

  3. camdecoster
    added
    P3backlog
    size: 1
    on Sep 16, 2026
  4. camdecoster
    self-assigned this
    on Sep 16, 2026

  5. CAOShurong commented on Sep 16, 2026

    @CAOShurong
    CAOShurong
    on Sep 16, 2026
    Contributor

    I've opened #8050 to resolve this cleanly!

    Summary of Fix

    1. **\ asks/generate_schema_types.mjs\ & \src/types/generated/schema.d.ts**:
      • Generates common nested axis/title properties on \Layout\ (\xaxis.autorange, \yaxis.autorange, \xaxis.range, \xaxis.type, \xaxis.title, etc.) for direct IDE autocompletion and hover types.
      • Emits template literal index signatures [key: \.\]: any;\ and [key: \[\]: any;\ on \Layout. This allows arbitrary dotted and indexed attribute paths, while strictly preserving excess property checks for non-dotted top-level layout keys (e.g. typos like { titl: '...' }\ continue to be caught and rejected by TypeScript).
    2. **\src/types/core/api.d.ts**:
      • Added 2-parameter string attribute path overloads for \Plotly.relayout(root, astr, val)\ and \Plotly.restyle(root, astr, val, traces?).
      • Updated
        estyle\ and \update\ to allow \Partial | Record<string, any>\ for dotted trace attribute updates.
    3. **\lib/index.d.ts\ & \src/types/core/layout.d.ts**:
      • Exported \LayoutUpdate\ alias (\Partial).

    Verified via
    pm run typecheck,
    pm run schema-typegen-diff-check, and
    pm run lint\ (all clean).

  6. camdecoster commented on Sep 22, 2026

    @camdecoster
    camdecoster
    on Sep 22, 2026
    Contributor

    I'll take a look at the PR. I have opinions about how this should be added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

P3backlogbugsomething brokensize: 1

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions