kibana/api_docs/kbn_data_view_utils.devdocs.json

{
  "id": "@kbn/data-view-utils",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "@kbn/data-view-utils",
        "id": "def-common.convertDatatableColumnToDataViewFieldSpec",
        "type": "Function",
        "tags": [],
        "label": "convertDatatableColumnToDataViewFieldSpec",
        "description": [
          "\nConvert a datatable column to a DataViewFieldSpec"
        ],
        "signature": [
          "(column: ",
          {
            "pluginId": "expressions",
            "scope": "common",
            "docId": "kibExpressionsPluginApi",
            "section": "def-common.DatatableColumn",
            "text": "DatatableColumn"
          },
          ") => ",
          {
            "pluginId": "dataViews",
            "scope": "common",
            "docId": "kibDataViewsPluginApi",
            "section": "def-common.FieldSpec",
            "text": "FieldSpec"
          }
        ],
        "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/convert_to_data_view_field_spec.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-view-utils",
            "id": "def-common.convertDatatableColumnToDataViewFieldSpec.$1",
            "type": "Object",
            "tags": [],
            "label": "column",
            "description": [],
            "signature": [
              {
                "pluginId": "expressions",
                "scope": "common",
                "docId": "kibExpressionsPluginApi",
                "section": "def-common.DatatableColumn",
                "text": "DatatableColumn"
              }
            ],
            "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/convert_to_data_view_field_spec.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-view-utils",
        "id": "def-common.createRegExpPatternFrom",
        "type": "Function",
        "tags": [],
        "label": "createRegExpPatternFrom",
        "description": [],
        "signature": [
          "(basePatterns: string | string[], selector: Selector) => RegExp"
        ],
        "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/create_regexp_pattern_from.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-view-utils",
            "id": "def-common.createRegExpPatternFrom.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "basePatterns",
            "description": [],
            "signature": [
              "string | string[]"
            ],
            "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/create_regexp_pattern_from.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          },
          {
            "parentPluginId": "@kbn/data-view-utils",
            "id": "def-common.createRegExpPatternFrom.$2",
            "type": "CompoundType",
            "tags": [],
            "label": "selector",
            "description": [],
            "signature": [
              "Selector"
            ],
            "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/create_regexp_pattern_from.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-view-utils",
        "id": "def-common.getDataViewFieldOrCreateFromColumnMeta",
        "type": "Function",
        "tags": [],
        "label": "getDataViewFieldOrCreateFromColumnMeta",
        "description": [],
        "signature": [
          "({ dataView, fieldName, columnMeta, }: { dataView: ",
          {
            "pluginId": "dataViews",
            "scope": "common",
            "docId": "kibDataViewsPluginApi",
            "section": "def-common.DataView",
            "text": "DataView"
          },
          "; fieldName: string; columnMeta?: ",
          {
            "pluginId": "expressions",
            "scope": "common",
            "docId": "kibExpressionsPluginApi",
            "section": "def-common.DatatableColumnMeta",
            "text": "DatatableColumnMeta"
          },
          " | undefined; }) => ",
          {
            "pluginId": "dataViews",
            "scope": "common",
            "docId": "kibDataViewsPluginApi",
            "section": "def-common.DataViewField",
            "text": "DataViewField"
          },
          " | undefined"
        ],
        "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/get_data_view_field_or_create.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-view-utils",
            "id": "def-common.getDataViewFieldOrCreateFromColumnMeta.$1",
            "type": "Object",
            "tags": [],
            "label": "{\n  dataView,\n  fieldName,\n  columnMeta,\n}",
            "description": [],
            "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/get_data_view_field_or_create.ts",
            "deprecated": false,
            "trackAdoption": false,
            "children": [
              {
                "parentPluginId": "@kbn/data-view-utils",
                "id": "def-common.getDataViewFieldOrCreateFromColumnMeta.$1.dataView",
                "type": "Object",
                "tags": [],
                "label": "dataView",
                "description": [],
                "signature": [
                  {
                    "pluginId": "dataViews",
                    "scope": "common",
                    "docId": "kibDataViewsPluginApi",
                    "section": "def-common.DataView",
                    "text": "DataView"
                  }
                ],
                "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/get_data_view_field_or_create.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/data-view-utils",
                "id": "def-common.getDataViewFieldOrCreateFromColumnMeta.$1.fieldName",
                "type": "string",
                "tags": [],
                "label": "fieldName",
                "description": [],
                "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/get_data_view_field_or_create.ts",
                "deprecated": false,
                "trackAdoption": false
              },
              {
                "parentPluginId": "@kbn/data-view-utils",
                "id": "def-common.getDataViewFieldOrCreateFromColumnMeta.$1.columnMeta",
                "type": "Object",
                "tags": [],
                "label": "columnMeta",
                "description": [],
                "signature": [
                  {
                    "pluginId": "expressions",
                    "scope": "common",
                    "docId": "kibExpressionsPluginApi",
                    "section": "def-common.DatatableColumnMeta",
                    "text": "DatatableColumnMeta"
                  },
                  " | undefined"
                ],
                "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/get_data_view_field_or_create.ts",
                "deprecated": false,
                "trackAdoption": false
              }
            ]
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/data-view-utils",
        "id": "def-common.testPatternAgainstAllowedList",
        "type": "Function",
        "tags": [],
        "label": "testPatternAgainstAllowedList",
        "description": [],
        "signature": [
          "(allowedList: (string | RegExp)[]) => (value: string) => boolean"
        ],
        "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/test_pattern_against_allowed_list.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/data-view-utils",
            "id": "def-common.testPatternAgainstAllowedList.$1",
            "type": "Array",
            "tags": [],
            "label": "allowedList",
            "description": [],
            "signature": [
              "(string | RegExp)[]"
            ],
            "path": "src/platform/packages/shared/kbn-data-view-utils/src/utils/test_pattern_against_allowed_list.ts",
            "deprecated": false,
            "trackAdoption": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/data-view-utils",
        "id": "def-common.ESQL_TYPE",
        "type": "string",
        "tags": [],
        "label": "ESQL_TYPE",
        "description": [
          "\nESQL type constant"
        ],
        "signature": [
          "\"esql\""
        ],
        "path": "src/platform/packages/shared/kbn-data-view-utils/src/constants.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}