Skip to content

[FEATURE]: Better error message for axis scaling. #7568

@umer936

Description

@umer936

Description

Currently, when a Plotly chart is rendered inside a container <div> that is too small (e.g., height = 0 or very small), Plotly.js throws a very broad error:

Uncaught (in promise) Error: Something went wrong with axis scaling

The error stack traces to internal scaling functions, but it provides no actionable guidance for the developer. In my case, the issue was resolved by explicitly setting a minimum height on the container:

#plotlyContainer {
    min-height: 600px;
}

The error message should instead clearly indicate that the container element is too small to render the chart, so developers can quickly diagnose the problem.


Why should this feature be added?

  1. Improved developer experience: The current error is misleading and vague. Many users may spend significant time debugging chart data or layout issues when the root cause is the container size.
  2. Faster debugging: A clear, descriptive error such as "Plotly container height is too small to render the chart" would allow developers to quickly fix layout issues.
  3. Prevents unnecessary workarounds: Developers currently have to discover these issues through trial and error.

Mocks/Designs

No visual mockups required. The requested change is purely to improve the clarity of the error message.


Notes

  • This could potentially be implemented as a validation step during Plotly.newPlot that checks the container's computed height and width before rendering.
  • It might also be helpful to provide a warning in the console if either dimension is below a certain threshold.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions