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

Custom Dashboard Panel Title #7336

Closed
wants to merge 12 commits into from

Conversation

panda01
Copy link
Contributor

@panda01 panda01 commented Jun 1, 2016

Implements #3393

Dashboard Title.

  • Adds a directive called kbn-edit-field, which is essentially ng-model but with reset and undo built in.
  • Keyboard shortcuts, Enter set the value, Esc undoes any noncommited changes.
  • Sets the dashboard title as a property on the uiState for a particular panel.

dashboard-title

Closes #3393.
Re-implimintation of #5607.

@panda01
Copy link
Contributor Author

panda01 commented Jun 2, 2016

@tbragin I would like you to try your hand at this please. I think after playing with it some more perhaps it should reset to the chart title.

@panda01
Copy link
Contributor Author

panda01 commented Jun 7, 2016

I changed the reset to change it back to the visualizations title, instead of the last dashboard title saved. Also added some tests.

@panda01 panda01 added the review label Jun 7, 2016
@panda01 panda01 changed the title [WIP]Feature/dashboard title Feature/dashboard title Jun 7, 2016
@panda01 panda01 changed the title Feature/dashboard title Custom Dashboard Title Jun 8, 2016
@LeeDr
Copy link

LeeDr commented Jun 8, 2016

I'm a little confused. The PR description says "Sets the dashboard title as a property on the uiState for a particular panel." I think I understand that this is not editing the name of the Dashboard itself, but of the visualizations that are added to the dashboard.

So does that mean a visualization has 2 titles?
The "Visualization title"
and the "Visualization's Dashboard title"?
Or is there just the one title and you can change it from the dashboard?

If there's a separate "Visualization Dashboard title";
If use the same visualization on multiple dashboards, can it have a different Dashboard Title on each Dashboard?

@panda01
Copy link
Contributor Author

panda01 commented Jun 8, 2016

@LeeDr Yes, the title being set here is per panel, and independent of the visualization. A lot like how the legend and spy panel work. If you add the same visualization to the same dashboard, or different ones it's unaware of the other's current state.

Everything you wrote is pretty much spot on.

@tbragin tbragin mentioned this pull request Jun 10, 2016
@tbragin
Copy link
Contributor

tbragin commented Jun 10, 2016

@panda01 If these are custom notes per visualization instance on a dashboard, perhaps we should name this PR as such? Right not the name "custom dashboard title" is a bit confusing to me.

I'll have to play with it some to provide further feedback. One question I have is what do long titles look like? Do they wrap? Run off screen? Is this really about re-titling something or about adding potentially long arbitrary notes (as one might with a markdown widget)?

@panda01
Copy link
Contributor Author

panda01 commented Jun 10, 2016

@tbragin nope this would be for only the title, notes would be another text field that can be changed and is possibly hidden until you hover over it.

In regard to long titles, well What i did was just add a input box that is has a transparent border when it doesn't have focus essentially rendering it invisible. So my guess would be that it doesn't wrap and rather just cuts off if the panel isn't wide enough.

@panda01
Copy link
Contributor Author

panda01 commented Jun 10, 2016

Jenkins, test it.

@panda01
Copy link
Contributor Author

panda01 commented Jun 10, 2016

One feature I think I think I should add to this is having some kind of indicator so that people realize they can change the title now. Not really sure what form that should take though.

@epixa epixa changed the title Custom Dashboard Title Custom Dashboard Panel Title Jun 13, 2016
@panda01
Copy link
Contributor Author

panda01 commented Jun 13, 2016

Jenkins, test it.

@acs
Copy link

acs commented Oct 31, 2016

@epixa @panda01 could I help here with this PR? We need this feature and I can continue using our own patch based on #5607 or help finishing this one so it is included in Kibana. I would prefer the second, of course 👍

@elasticmachine
Copy link
Contributor

Can one of the admins verify this patch?

@epixa
Copy link
Contributor

epixa commented Oct 31, 2016

@acs If you're interested in picking this up, that'd be awesome! I recommend branching from this and opening a new PR. Just link back to this one so we know to close it.

@acs
Copy link

acs commented Oct 31, 2016

@panda01 what is pending in this PR from your point of view? Is it stalled just for lack of time or for other reason I have to take in mind to unblock it?

@epixa I am just deciding now the approach in order to plan next weeks effort in our migration to the cool Kibana 5.0.0. Awesome work guys!

@epixa
Copy link
Contributor

epixa commented Oct 31, 2016

@acs At the very least, this will need to be rebased on the latest master and the conflicts will need to be resolved. It could probably benefit by some sort of visual indication that you can edit titles as well. Those would be the most immediate things that come to mind, but there may be more that comes up in review.

@tbragin tbragin added Feature:Dashboard Dashboard related features :Sharing labels Nov 12, 2016
@kobelb
Copy link
Contributor

kobelb commented Dec 19, 2016

After further discussion, this doesn't really fit with the direction that we intend the dashboard to go in the immediate future. Since this PR hasn't seen any activity for a while, I'm going to close out this PR.

@kobelb kobelb closed this Dec 19, 2016
@acs
Copy link

acs commented Jan 2, 2017

@kobelb some pointer about the direction in which the dashboard is going related to title customization?

Thanks!

@kobelb
Copy link
Contributor

kobelb commented Jan 2, 2017

@acs we've been discussing introducing groups/containers/rows to the dashboard, and these would allow the user to enter in a 'title/description' for the specific group; which we're hoping will address a number of the use-cases for this functionality.

To elaborate on our concerns I briefly mentioned before; currently, visualizations/dashboard are separate sections of Kibana and the title that is entered in the visualization editor is what's being displayed on the dashboard. The functionality that this PR introduced allowed a separate title/description to be set for a visualization, that shadowed the visualization title. We're concerned that this 'shadowing' behavior could cause confusion for the user; and we're also concerned that changing this functionality to change the visualization title itself (which is then reflected in the visualization section, and possibly other dashboards) could cause it's own confusion.

@acs
Copy link

acs commented Jan 4, 2017

@kobelb thanks for the explanation.

Once this feature is included in Kibana we will test it to see if it addressed our use case. And yes, we have troubles with the 'shadowing' (or 'customization') of the title, but the feature is critical for us so our customer understand what is included in the visualization (something that depends in the config of the visualization and the data being showed). I am not sure how much this custom title for groups/containers/rows will help. I need to see it in action :)

@elasticmachine
Copy link
Contributor

Can one of the admins verify this patch?

@rgheleribefore
Copy link

Any news about it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Dashboard Dashboard related features help wanted adoptme updates_needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants