Skip to content

docs: update event document #7239

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.

Sign up for GitHub

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

Jump to bottom
Merged
interstellarmt merged 1 commit into from
Dec 18, 2025
Merged

docs: update event document #7239

interstellarmt merged 1 commit into from
Dec 18, 2025
+585 −271

Conversation

@interstellarmt
Copy link
Member

@interstellarmt interstellarmt commented Dec 16, 2025

Checklist
  • documents are updated
Description of change
  • 更新 「事件」 相关的文档

@gemini-code-assist
Copy link
Contributor

gemini-code-assist bot commented Dec 16, 2025

Summary of Changes

Hello @interstellarmt, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on a substantial update to the G2 event documentation. The primary goal is to enhance the user's understanding of how to effectively utilize G2's event system for chart lifecycle and interaction. This includes modernizing code snippets, clarifying event behavior, and providing best practice recommendations for component interaction.

Highlights

  • Documentation Content Update: The event documentation for G2 has been significantly updated in both English and Chinese versions to improve clarity and provide more comprehensive guidance on event handling.
  • Modernized Code Examples: All code examples within the documentation have been updated to use the chart.options({...}) syntax for chart configuration, replacing the older chart.data([...]) and chained chart.interval().encode(...) methods.
  • Enhanced Event Handling Guidance: New sections have been added to explain why click events might not work on container elements (due to event bubbling) and provide recommended approaches for listening to component events, including high-level interaction events and methods for retrieving clicked legend item data.
  • Clarified Component Interaction: An important note now explicitly recommends using G2's high-level interaction events for components like legends and axes over direct DOM manipulation, ensuring more stable and semantically clear event handling.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

gemini-code-assist[bot]
gemini-code-assist bot reviewed Dec 16, 2025
View reviewed changes
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the G2 event handling documentation in both English and Chinese. The main changes involve refactoring chart configuration examples from a chained method approach to a more declarative chart.options() object-based style. The documentation also clarifies lifecycle and interaction event descriptions for conciseness. A significant addition is a new section on fine-grained control using class names, which now strongly recommends using G2's high-level interaction events over direct DOM manipulation for components like legends and axes. This section provides structured examples for high-level events, specific child element events, and direct Canvas DOM manipulation, along with an explanation of why click events might not work on container elements and how to retrieve data from clicked legend items. A minor review comment suggests removing an extra space in an arrow function definition for code consistency.

@coveralls
Copy link

coveralls commented Dec 16, 2025

Pull Request Test Coverage Report for Build 20268007653

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.02%) to 79.966%
Totals Coverage Status
Change from base Build 20263621559: 0.02%
Covered Lines: 10464
Relevant Lines: 12552
💛 - Coveralls

@interstellarmt interstellarmt merged commit a5604ee into v5 Dec 18, 2025
5 checks passed
@interstellarmt interstellarmt deleted the docs-event branch December 18, 2025 07:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lxfu1 lxfu1 lxfu1 approved these changes

+1 more reviewer

@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@interstellarmt @coveralls @lxfu1