fix: set correct type for XmlCanvas2D.root #423
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The type of the `root` property had been incorrectly set to `SVGElement` during the Typescript migration (see commit 413796a). This prevented to use it in various scenario, like the example described in the `ExportImage` JSDoc. This example was working in mxGraph and typed-mxgraph declares the property as a `Element`, so it is now declares the property as a `Element` A test has been added to show that the ExportImage example using XmlCanvas2D with a root using an Element type works.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The type of the
rootproperty had been incorrectly set toSVGElementduring the Typescript migration (see commit 413796a).This prevented to use it in various scenario, like the example described in the
ExportImageJSDoc.This example was working in mxGraph and typed-mxgraph declares the property as a
Element, so it is now declares the property as aElementA test has been added to show that the
ExportImageexample using XmlCanvas2D with a root using an Element type works.Notes
typed-mxgraph: https://github.com/typed-mxgraph/typed-mxgraph/blob/187dd4f0dc7644c0cfbc998dae5fc90879597d81/lib/util/mxXmlCanvas2D.d.ts#L2-L8
mxGraph documentation for the usage of
XmlCanvas2DinExportImage: https://github.com/jgraph/mxgraph/blob/ff141aab158417bd866e2dfebd06c61d40773cd2/javascript/src/js/util/mxImageExport.js#L13-L25