Skip to content

Update docs to clarify the relationship between name and id #127

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

Merged
emilk merged 2 commits into from
Oct 10, 2025
Merged

Update docs to clarify the relationship between name and id #127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fe4e40
Clarify the relationship between name and id
YgorSouza Aug 7, 2025
5f1ac9e
Merge branch 'main' into clarify-item-name-docs
emilk Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion egui_plot/src/items/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,11 @@ macro_rules! builder_methods_for_base {
/// Name of this plot item.
///
/// This name will show up in the plot legend, if legends are turned on.
///
/// Setting the name via this method does not change the item's id, so you can use it to
/// change the name dynamically between frames without losing the item's state. You should
/// make sure the name passed to [`Self::new`] is unique and stable for each item, or
/// set unique and stable ids explicitly via [`Self::id`].
#[inline]
pub fn name(mut self, name: impl ToString) -> Self {
self.base_mut().name = name.to_string();
Expand All @@ -78,7 +83,8 @@ macro_rules! builder_methods_for_base {

/// Sets the id of this plot item.
///
/// By default the id is determined from the name, but it can be explicitly set to a different value.
/// By default the id is determined from the name passed to [`Self::new`], but it can be
/// explicitly set to a different value.
#[inline]
pub fn id(mut self, id: impl Into<Id>) -> Self {
self.base_mut().id = id.into();
Expand Down
Loading