WARNING: Version 6.2 of Kibana has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

« Visualization Response Handlers AggConfig object »
Elastic Docs ›Kibana User Guide [6.2] ›Contributing to Kibana ›Developing Visualizations

Vis object

edit

Vis object

edit

The vis object holds the visualization state and is the window into kibana:

  • vis.params: holds the visualization parameters
  • vis.indexPattern: selected index pattern object
  • vis.getState(): gets current visualization state
  • vis.updateState(): updates current state with values from vis.params
  • vis.resetState(): resets vis.params to the values in the current state
  • vis.forceReload(): forces whole cycle (request handler gets called)
  • vis.getUiState(): gets UI state of visualization
  • vis.uiStateVal(name, val): updates a property in UI state
  • vis.isEditorMode(): returns true if in editor mode
  • vis.API.timeFilter: allows you to access time picker
  • vis.API.queryFilter: gives you access to queryFilter
  • vis.API.queryManager: gives you access to add filters to the filter bar
  • vis.API.filterManager: gives you access to filterManager
  • vis.API.kuery: gives you access to the experimental keury-language filter bar
  • vis.API.events.click: default click handler
  • vis.API.events.brush: default brush handler

The visualization gets all its parameters in vis.params, which are default values merged with the current state. If the visualization needs to update the current state, it should update the vis.params and call vis.updateState() which will inform <visualize> about the change, which will call request and response handler and then your visualization’s render method.

For the parameters that should not be saved with the visualization you should use the UI state. These hold viewer-specific state, such as popup open/closed, custom colors applied to the series etc.

You can access filter bar and time picker through the objects defined on vis.API

timeFilter

edit

Update the timefilter time values and call update() method on it to update time picker

   timefilter.time.from = moment(ranges.xaxis.from);
   timefilter.time.to = moment(ranges.xaxis.to);
   timefilter.time.mode = 'absolute';
   timefilter.update();
« Visualization Response Handlers AggConfig object »