TimeFilter in Custom Plugin

cjord · June 23, 2021, 5:44am

Is there any way to get the values of the time filter in a custom page on a plugin?

Screenshot 2021-06-23 014107

I would like to be able to read the values to display on the page as well as hook into the refresh event when the time filter is updated.

This is the closest reference I have been able to find and appears to be very out of date. Get time from Time Range from custom plugin

Thanks

dosant · June 23, 2021, 10:41am

Hi @cjord!

You need to use data plugin. It will be available on time filter services:
Something like: data.query.timefilter.timefilter.getTime()

And this is how it used in one of our developer examples plugins:

github.com

elastic/kibana/blob/0477c4dae41daf75fd2dcfc98ced09458d0f1bbf/examples/search_examples/public/search_sessions/app.tsx#L145


      
            state,
          } = useAppState({ data });
          
          const isRestoring = !!state.restoreSessionId;
          
          const enableSessionStorage = useCallback(() => {
            data.search.session.enableStorage({
              getName: async () => 'Search sessions example',
              getUrlGeneratorData: async () => ({
                initialState: {
                  time: data.query.timefilter.timefilter.getTime(),
                  filters: data.query.filterManager.getFilters(),
                  query: data.query.queryString.getQuery(),
                  indexPatternId: indexPattern?.id,
                  numericFieldName,
                } as SearchSessionExamplesUrlGeneratorState,
                restoreState: {
                  time: data.query.timefilter.timefilter.getAbsoluteTime(),
                  filters: data.query.filterManager.getFilters(),
                  query: data.query.queryString.getQuery(),
                  indexPatternId: indexPattern?.id,

system · July 21, 2021, 10:42am

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

Topic		Replies	Views
Get time from Time Range from custom plugin Kibana	3	570	May 9, 2019
How can I read the timefilter range within an external plugin? Kibana kibana-plugin-development	5	605	December 21, 2020
Referencing time range and filter from Controller Kibana	4	1711	July 6, 2017
How to get time index selected in my custom plugin? Kibana	3	455	August 24, 2017
Access timepicker range from within visualization plugin Kibana	3	1256	July 6, 2017

TimeFilter in Custom Plugin

Related topics