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

[Feature Anywhere] Add view events flyout #3382

Conversation

ohltyler
Copy link
Member

@ohltyler ohltyler commented Feb 3, 2023

Signed-off-by: Tyler Ohlsen [email protected]

Description

This PR adds the 'View events' flyout which will open via an event click on a chart with VisLayers enabled, or in the vis options menu via View events button. It shows the base vis with the event annotations, and below it a breakdown of each set of events produced by each plugin resource. It is categorized by plugin resource type as well.

Technical details, more information, and example mocks can be found in the related issue #3155

Implementation details

Components

ViewEventsFlyout - the base component where all embeddables are created from the source vis embeddable. Persists the event visualizations by type via a map mapping resource type -> list of embeddables

DateRangeItem - contains the selected date range and refresh button. Hooks into the reload() function defined in ViewEventsFlyout to reload all of the embeddables when clicked.

BaseVisItem - the re-created base vis embeddable containing all of the events

EventsPanel - the base component to show all of the event annotation charts. Contains a set of PluginEventsPanels

PluginEventsPanel - contains a set of EventVisItems for a particular plugin resource type

EventVisItem - contains an event vis embeddable, including the resource name, url, and event count

TimelinePanel - contains the empty embeddable. Used to re-create the timeline and is a static component on the bottom of the flyout

All of the embeddables are using the EmbeddablePanel component, which takes care of individual component lifecycles for us, including the rendering, refreshing, and destroying. This is fetched from the embeddable service function's getEmbeddablePanel().

Issues Resolved

Closes #3155

Check List

  • All tests pass
    • yarn test:jest
    • yarn test:jest_integration
    • yarn test:ftr
  • New functionality includes testing.
  • New functionality has been documented.
  • Update CHANGELOG.md
  • Commits are signed per the DCO using --signoff

@ohltyler ohltyler requested a review from a team as a code owner February 3, 2023 21:46
@ohltyler ohltyler marked this pull request as draft February 3, 2023 21:46
@ohltyler ohltyler added visualizations Issues and PRs related to visualizations feature-anywhere labels Feb 3, 2023
@ohltyler
Copy link
Member Author

ohltyler commented Feb 3, 2023

Currently this PR has many dependent ones that will need to be merged first. This includes:

These all involve finalizing the rest of the chart render workflow, and the VisLayer design.

When these have been merged, we can finish the following items for this flyout:

Signed-off-by: Tyler Ohlsen <[email protected]>
@ohltyler
Copy link
Member Author

Cleaned up and created a new branch - now tracking in #3415

@ohltyler ohltyler closed this Feb 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-anywhere visualizations Issues and PRs related to visualizations
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant