Parameters for Field Format plugin

Elaak · December 13, 2019, 9:41am

Using ES+Kibana: v 7.4.2

I have a field formatter for strings, and I want the user to be able to adjust some settings when they select the FieldFormat under "Index Patterns". An example I have seen for the Field Format "Truncated String"

Can anyone tell me what I need to do to allow input of parameters into my field formatter? I can of course do it using kibana.yml but it is neither user friendly not dynamic.

As an alternative/extra question, I was trying to find the code for the "Truncated String" Field formatter to use as an example, but was unable to find it. Does anyone know where it is located?

Brandon_Kobel · December 16, 2019, 5:48pm

Can anyone tell me what I need to do to allow input of parameters into my field formatter? I can of course do it using kibana.yml but it is neither user friendly not dynamic.

Unfortunately, this is not supported at this point. Feel free to open a feature request for this to be added.

As an alternative/extra question, I was trying to find the code for the "Truncated String" Field formatter to use as an example, but was unable to find it. Does anyone know where it is located?

github.com

elastic/kibana/blob/3a915b22a04dc85e257a1cc8802178dc541d83ca/src/plugins/data/common/field_formats/converters/truncate.ts#L29


      
          
          import { trunc } from 'lodash';
          import { KBN_FIELD_TYPES } from '../../kbn_field_types/types';
          import { FieldFormat } from '../field_format';
          import { TextContextTypeConvert, FIELD_FORMAT_IDS } from '../types';
          
          const omission = '...';
          
          export class TruncateFormat extends FieldFormat {
            static id = FIELD_FORMAT_IDS.TRUNCATE;
            static title = 'Truncated String';
            static fieldType = KBN_FIELD_TYPES.STRING;
          
            textConvert: TextContextTypeConvert = val => {
              const length = this.param('fieldLength');
              if (length > 0) {
                return trunc(val, {
                  length: length + omission.length,
                  omission,
                });
              }

Elaak · December 17, 2019, 8:18am

That is unfortunate. I will stick to the configuration for now but will request the feature for the future.

system · January 14, 2020, 8:18am

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

Topic		Replies	Views
Editor for FieldFormat-plugin in new platform Kibana	2	263	September 30, 2020
Register FieldFormat plugin in v. 7.6.2 Kibana	1	481	August 5, 2020
Anyone had luck creating a formatFields plugin for Kibana 5.x? Kibana	4	838	April 14, 2017
Custom field formatter Kibana	4	514	November 8, 2020
Truncate Scripted Field Kibana	2	1901	January 7, 2019

Parameters for Field Format plugin

Related topics