What is uiState parameter in kibana URL?

Elastic Stack Kibana
#1

Hi,
i want to know what is uiState parameter in kibana URl and what are the things that i can achieve with this uistate?
Sample uiState as below...
"uiState:(P-11:(vis:(colors:(Exception:%23967302,Fail:%23F9E2D2,exception:%23F2C96D,fail:%23BF1B00,pass:%23508642,warning:%23BA43A9),legendOpen:!t)),P-12:(vis:(colors:('Unique%20count%20of%20testCase.id':%23CCA300),legendOpen:!f)),P-13:(vis:(colors:('Unique%20count%20of%20testCase.id':%23BF1B00),legendOpen:!f)),P-14:(vis:(colors:('Unique%20count%20of%20testCase.id':%23E24D42),legendOpen:!t)),P-15:(vis:(colors:('Unique%20count%20of%20testCase.id':%23508642),legendOpen:!f))))"

I saw that it is useful for some colours of charts. Is there any other purpose of this?

#2

I'm still figuring out what all of the bits that are used in the UI state. I did use it to save settings on a plugin at one point. I'm not sure what that line you have above does but think of it as settings that a specific plugin/page uses. So the sting itself could literally be anything since the plugin knows how to read it.

Example: a=true&y="superAwesome" means nothing until you look at the plugin and how it uses that info.

When I built my plugin I looked at /src/core_plugins/kibana/public/discover/controllers/discover.js

Look for the resolve: { ip... portion. That reads the state and sets up some initial stuff for the discover plugin to use. There's also a slight comment in there about how they had to work around their own appState object.

Good luck, and if anyone knows anything more about how to use the appState and best ways to save/read things from it, I'm all ears.

#3

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.