Skip to content
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.

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

[plotly.js] Add missing data property on PlotlyHTMLElement. #65953

Merged
merged 1 commit into from Jul 2, 2023

Conversation

jychen630
Copy link
Contributor

@jychen630 jychen630 commented Jul 1, 2023

According to an example from the plotly.js/src/plot_api/plot_api.js, this reference, and documentation, a PlotlyHTMLElement object should be able to access data property. Such data property is currently not supported. This PR fixes this.

Testing and the rest of checklist are WIP.

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>
  • If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

@typescript-bot
Copy link
Contributor

typescript-bot commented Jul 1, 2023

@jychen630 Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

1 package in this PR

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ Most recent commit is approved by type definition owners or DT maintainers

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 65953,
  "author": "jychen630",
  "headCommitOid": "7409a8a0a3c61c06ccc370e8231906bae50fbbdb",
  "mergeBaseOid": "3420adf4ca802933d360aced242b4a44ebca507d",
  "lastPushDate": "2023-07-01T21:37:30.000Z",
  "lastActivityDate": "2023-07-02T18:05:41.000Z",
  "mergeOfferDate": "2023-07-02T17:29:13.000Z",
  "mergeRequestDate": "2023-07-02T18:05:41.000Z",
  "mergeRequestUser": "jychen630",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": "plotly.js",
      "kind": "edit",
      "files": [
        {
          "path": "types/plotly.js/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/plotly.js/test/index-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "chrisgervang",
        "martinduparc",
        "frederikaalund",
        "taoqf",
        "Dadstart",
        "szechyjs",
        "soorajpudiyadath",
        "jonfreedman",
        "meganrm",
        "milesjos",
        "skippercool",
        "mtadams007",
        "marnett-git",
        "peterblazejewicz",
        "brammitch",
        "blizzardjessica",
        "olegshilov",
        "PabloGracia",
        "jvgogh"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "peterblazejewicz",
      "date": "2023-07-02T17:28:26.000Z",
      "isMaintainer": true
    }
  ],
  "mainBotCommentID": 1616044209,
  "ciResult": "pass"
}

@typescript-bot typescript-bot added Popular package This PR affects a popular package (as counted by NPM download counts). Untested Change This PR does not touch tests labels Jul 1, 2023
@typescript-bot typescript-bot added this to Waiting for Code Reviews in New Pull Request Status Board Jul 1, 2023
@typescript-bot
Copy link
Contributor

🔔 @chrisgervang @martinduparc @frederikaalund @taoqf @Dadstart @szechyjs @soorajpudiyadath @jonfreedman @meganrm @milesjos @SkipperCool @mtadams007 @marnett-git @peterblazejewicz @brammitch @blizzardjessica @olegshilov @PabloGracia @jvgogh — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

@typescript-bot
Copy link
Contributor

typescript-bot commented Jul 1, 2023

@jychen630 Thank you for submitting this PR! I see this is your first time submitting to DefinitelyTyped 👋 — I'm the local bot who will help you through the process of getting things through.

This is a live comment which I will keep updated.

1 package in this PR

Code Reviews

Because you edited one package and updated the tests (👏), I can help you merge this PR once someone else signs off on it.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ Most recent commit is approved by type definition owners or DT maintainers

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 65953,
  "author": "jychen630",
  "headCommitOid": "7409a8a0a3c61c06ccc370e8231906bae50fbbdb",
  "mergeBaseOid": "3420adf4ca802933d360aced242b4a44ebca507d",
  "lastPushDate": "2023-07-01T21:37:30.000Z",
  "lastActivityDate": "2023-07-02T18:05:41.000Z",
  "mergeOfferDate": "2023-07-02T17:29:13.000Z",
  "mergeRequestDate": "2023-07-02T18:05:41.000Z",
  "mergeRequestUser": "jychen630",
  "hasMergeConflict": false,
  "isFirstContribution": true,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Popular",
  "pkgInfo": [
    {
      "name": "plotly.js",
      "kind": "edit",
      "files": [
        {
          "path": "types/plotly.js/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/plotly.js/test/index-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "chrisgervang",
        "martinduparc",
        "frederikaalund",
        "taoqf",
        "Dadstart",
        "szechyjs",
        "soorajpudiyadath",
        "jonfreedman",
        "meganrm",
        "milesjos",
        "skippercool",
        "mtadams007",
        "marnett-git",
        "peterblazejewicz",
        "brammitch",
        "blizzardjessica",
        "olegshilov",
        "PabloGracia",
        "jvgogh"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Popular"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "peterblazejewicz",
      "date": "2023-07-02T17:28:26.000Z",
      "isMaintainer": true
    }
  ],
  "mainBotCommentID": 1616044209,
  "ciResult": "pass"
}

@DangerBotOSS
Copy link

DangerBotOSS commented Jul 1, 2023

Inspecting the JavaScript source for this package found some properties that are not in the .d.ts files.
The check for missing properties isn't always right, so take this list as advice, not a requirement.

plotly.js (unpkg)

was missing the following properties:

  1. version
  2. Fx
  3. Snapshot
  4. PlotSchema

Generated by 🚫 dangerJS against 7409a8a

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Needs Maintainer Review in New Pull Request Status Board Jul 1, 2023
Signed-off-by: Junyao Chen <junyao.chen@nyu.edu>
@typescript-bot typescript-bot removed the Untested Change This PR does not touch tests label Jul 1, 2023
@typescript-bot typescript-bot moved this from Needs Maintainer Review to Waiting for Code Reviews in New Pull Request Status Board Jul 1, 2023
Copy link
Member

@peterblazejewicz peterblazejewicz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!
@jychen630 thanks!

@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner labels Jul 2, 2023
@typescript-bot
Copy link
Contributor

@jychen630: Everything looks good here. I am ready to merge this PR (at 7409a8a) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@chrisgervang, @martinduparc, @frederikaalund, @taoqf, @Dadstart, @szechyjs, @soorajpudiyadath, @jonfreedman, @meganrm, @milesjos, @SkipperCool, @mtadams007, @marnett-git, @peterblazejewicz, @brammitch, @blizzardjessica, @olegshilov, @PabloGracia, @jvgogh: you can do this too.)

@typescript-bot typescript-bot moved this from Waiting for Code Reviews to Waiting for Author to Merge in New Pull Request Status Board Jul 2, 2023
@jychen630
Copy link
Contributor Author

Ready to merge

@typescript-bot typescript-bot moved this from Waiting for Author to Merge to Recently Merged in New Pull Request Status Board Jul 2, 2023
@typescript-bot typescript-bot merged commit 7624bd8 into DefinitelyTyped:master Jul 2, 2023
2 checks passed
@typescript-bot typescript-bot removed this from Recently Merged in New Pull Request Status Board Jul 2, 2023
Desplandis pushed a commit to Desplandis/DefinitelyTyped that referenced this pull request Jul 3, 2023
…y on PlotlyHTMLElement. by @jychen630

Signed-off-by: Junyao Chen <junyao.chen@nyu.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Maintainer Approved Popular package This PR affects a popular package (as counted by NPM download counts). Self Merge This PR can now be self-merged by the PR author or an owner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants