feat(listeners): add seriesIdentifiers to element listeners #525
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
This commit changes the object passed to an event listener providing the value of the
clicked/hovered element together with the seriesIdentifier object
BREAKING CHANGE: the `onElementOver` and the `onElementClick` are now called with
an array of `{ value: GeometryValue; seriesId: SeriesIdentifier;}`
fix elastic#505
markov00
added
enhancement
Codecov Report
@@ Coverage Diff @@
## master #525 +/- ##
=======================================
Coverage 75.26% 75.26%
=======================================
Files 193 193
Lines 5797 5797
Branches 1118 1118
=======================================
Hits 4363 4363
Misses 1418 1418
Partials 16 16Continue to review full report at Codecov.
|
nickofthyme
reviewed
Jan 28, 2020
src/specs/settings.tsx
Outdated
| value: GeometryValue; | ||
| seriesId: SeriesIdentifier; | ||
| } | ||
| export type ElementClickListener = (elements: Element[]) => void; |
Collaborator
There was a problem hiding this comment.
What do you think of...
export type ElementClickListener = (elements: Array<Array<GeometryValue, SeriesIdentifier>>) => void;Otherwise can you use seriesIdentifier rather than seriesId?
Member
Author
There was a problem hiding this comment.
fixed on f4755a9 with Array<[GeometryValue, SeriesIdentifier]>
Instead of using an Element interface, with an ambigious name, I've replaced it with a tuple of [GeometryValue, SeriesIdentifier]
nickofthyme
approved these changes
Jan 29, 2020
markov00
pushed a commit
that referenced
this pull request
Jan 30, 2020
# [17.0.0](v16.2.1...v17.0.0) (2020-01-30) ### Bug Fixes * **brush:** rotate brush on rotated charts ([#528](#528)) ([985ac21](985ac21)), closes [#527](#527) ### Features * text improvements ([#524](#524)) ([6e61700](6e61700)) * **listeners:** add seriesIdentifiers to element listeners ([#525](#525)) ([027d008](027d008)), closes [#419](#419) [#505](#505) ### BREAKING CHANGES * **listeners:** the `onElementOver` and the `onElementClick` are now called with `Array<[GeometryValue, SeriesIdentifier]>` instead of `Array<GeometryValue>` * renames in `Partition` charts— `Layers`: `fillLabel.formatter`->`fillLabel.valueFormatter`; type `FillLabel`-> `FillLabelConfig` Non-breaking changes: * feat: the values in linked labels are rendered, just like they have been in the sectors (formerly, the value could optionally be put in the link label accessor itself) * feat: font styling is possible separately for values: `valueFormatter` configs * test: opacity decrease example; coloring examples * feat: hierarchical data (`parent`, `sortIndex`) is made available to accessors (see stories, helpful with eg. coloring) * refactor: tighter types; other code improvements
Member
Author
|
🎉 This PR is included in version 17.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
AMoo-Miki
pushed a commit
to AMoo-Miki/OpenSearch-Dashboards
that referenced
this pull request
Feb 10, 2022
# [17.0.0](elastic/elastic-charts@v16.2.1...v17.0.0) (2020-01-30) ### Bug Fixes * **brush:** rotate brush on rotated charts ([opensearch-project#528](elastic/elastic-charts#528)) ([b6c3302](elastic/elastic-charts@b6c3302)), closes [opensearch-project#527](elastic/elastic-charts#527) ### Features * text improvements ([opensearch-project#524](elastic/elastic-charts#524)) ([f7b53c8](elastic/elastic-charts@f7b53c8)) * **listeners:** add seriesIdentifiers to element listeners ([opensearch-project#525](elastic/elastic-charts#525)) ([643ef1b](elastic/elastic-charts@643ef1b)), closes [opensearch-project#419](elastic/elastic-charts#419) [opensearch-project#505](elastic/elastic-charts#505) ### BREAKING CHANGES * **listeners:** the `onElementOver` and the `onElementClick` are now called with `Array<[GeometryValue, SeriesIdentifier]>` instead of `Array<GeometryValue>` * renames in `Partition` charts— `Layers`: `fillLabel.formatter`->`fillLabel.valueFormatter`; type `FillLabel`-> `FillLabelConfig` Non-breaking changes: * feat: the values in linked labels are rendered, just like they have been in the sectors (formerly, the value could optionally be put in the link label accessor itself) * feat: font styling is possible separately for values: `valueFormatter` configs * test: opacity decrease example; coloring examples * feat: hierarchical data (`parent`, `sortIndex`) is made available to accessors (see stories, helpful with eg. coloring) * refactor: tighter types; other code improvements
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
This PR changes the object passed to the event listeners providing either the value of the
clicked/hovered element and with the
SeriesIdentifierobject that can uniquely identify a series in elastic-charts. (see #419 for a description on SeriesIdentifiers)BREAKING CHANGE: the
onElementOverand theonElementClickare now called withArray<[GeometryValue, SeriesIdentifier]>instead ofArray<GeometryValue>fix #505
Checklist
Use
strikethroughsto remove checklist items you don't feel are applicable to this PR.src/index.ts(and stories only import from../srcexcept for test data & storybook)