kibana/api_docs/timelines.json
Stacey Gammon 4bfb35b43a
Update api docs (#116495)
* update api docs

* update api docs
2021-11-01 19:16:16 +00:00

22051 lines
714 KiB
JSON

{
"id": "timelines",
"client": {
"classes": [],
"functions": [
{
"parentPluginId": "timelines",
"id": "def-public.addFieldToTimelineColumns",
"type": "Function",
"tags": [],
"label": "addFieldToTimelineColumns",
"description": [],
"signature": [
"({ browserFields, dispatch, result, timelineId, defaultsHeader, }: AddFieldToTimelineColumnsParams) => void"
],
"path": "x-pack/plugins/timelines/public/components/drag_and_drop/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.addFieldToTimelineColumns.$1",
"type": "Object",
"tags": [],
"label": "{\n browserFields,\n dispatch,\n result,\n timelineId,\n defaultsHeader,\n}",
"description": [],
"signature": [
"AddFieldToTimelineColumnsParams"
],
"path": "x-pack/plugins/timelines/public/components/drag_and_drop/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.arrayIndexToAriaIndex",
"type": "Function",
"tags": [],
"label": "arrayIndexToAriaIndex",
"description": [
"Converts an array index, which starts at zero, to an aria index, which starts at one"
],
"signature": [
"(arrayIndex: number) => number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.arrayIndexToAriaIndex.$1",
"type": "number",
"tags": [],
"label": "arrayIndex",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.elementOrChildrenHasFocus",
"type": "Function",
"tags": [],
"label": "elementOrChildrenHasFocus",
"description": [
"Returns `true` when the element, or one of it's children has focus"
],
"signature": [
"(element: HTMLElement | null | undefined) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.elementOrChildrenHasFocus.$1",
"type": "CompoundType",
"tags": [],
"label": "element",
"description": [],
"signature": [
"HTMLElement | null | undefined"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.focusColumn",
"type": "Function",
"tags": [],
"label": "focusColumn",
"description": [
"\nSIDE EFFECT: mutates the DOM by focusing the specified column\nreturns the `aria-colindex` of the newly-focused column"
],
"signature": [
"({ colindexAttribute, containerElement, ariaColindex, ariaRowindex, rowindexAttribute, }: { colindexAttribute: string; containerElement: Element | null; ariaColindex: number; ariaRowindex: number; rowindexAttribute: string; }) => FocusColumnResult"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.focusColumn.$1",
"type": "Object",
"tags": [],
"label": "{\n colindexAttribute,\n containerElement,\n ariaColindex,\n ariaRowindex,\n rowindexAttribute,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.focusColumn.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.focusColumn.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"Element | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.focusColumn.$1.ariaColindex",
"type": "number",
"tags": [],
"label": "ariaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.focusColumn.$1.ariaRowindex",
"type": "number",
"tags": [],
"label": "ariaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.focusColumn.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getFocusedAriaColindexCell",
"type": "Function",
"tags": [],
"label": "getFocusedAriaColindexCell",
"description": [
"\nReturns the focused cell for tables that use `aria-colindex`"
],
"signature": [
"({ containerElement, tableClassName, }: { containerElement: HTMLElement | null; tableClassName: string; }) => HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getFocusedAriaColindexCell.$1",
"type": "Object",
"tags": [],
"label": "{\n containerElement,\n tableClassName,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getFocusedAriaColindexCell.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getFocusedAriaColindexCell.$1.tableClassName",
"type": "string",
"tags": [],
"label": "tableClassName",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getFocusedDataColindexCell",
"type": "Function",
"tags": [],
"label": "getFocusedDataColindexCell",
"description": [
"\nReturns the focused cell for tables that use `data-colindex`"
],
"signature": [
"({ containerElement, tableClassName, }: { containerElement: HTMLElement | null; tableClassName: string; }) => HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getFocusedDataColindexCell.$1",
"type": "Object",
"tags": [],
"label": "{\n containerElement,\n tableClassName,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getFocusedDataColindexCell.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getFocusedDataColindexCell.$1.tableClassName",
"type": "string",
"tags": [],
"label": "tableClassName",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getNotesContainerClassName",
"type": "Function",
"tags": [],
"label": "getNotesContainerClassName",
"description": [],
"signature": [
"(ariaRowindex: number) => string"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getNotesContainerClassName.$1",
"type": "number",
"tags": [],
"label": "ariaRowindex",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getPageRowIndex",
"type": "Function",
"tags": [],
"label": "getPageRowIndex",
"description": [
"\nrowIndex is bigger than `data.length` for pages with page numbers bigger than one.\nFor that reason, we must calculate `rowIndex % itemsPerPage`.\n\nEx:\nGiven `rowIndex` is `13` and `itemsPerPage` is `10`.\nIt means that the `activePage` is `2` and the `pageRowIndex` is `3`\n\n**Warning**:\nBe careful with array out of bounds. `pageRowIndex` can be bigger or equal to `data.length`\n in the scenario where the user changes the event status (Open, Acknowledged, Closed)."
],
"signature": [
"(rowIndex: number, itemsPerPage: number) => number"
],
"path": "x-pack/plugins/timelines/common/utils/pagination.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getPageRowIndex.$1",
"type": "number",
"tags": [],
"label": "rowIndex",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/timelines/common/utils/pagination.ts",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "timelines",
"id": "def-public.getPageRowIndex.$2",
"type": "number",
"tags": [],
"label": "itemsPerPage",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/timelines/common/utils/pagination.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getRowRendererClassName",
"type": "Function",
"tags": [],
"label": "getRowRendererClassName",
"description": [],
"signature": [
"(ariaRowindex: number) => string"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getRowRendererClassName.$1",
"type": "number",
"tags": [],
"label": "ariaRowindex",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getTableSkipFocus",
"type": "Function",
"tags": [],
"label": "getTableSkipFocus",
"description": [
"\nThis function, which works with tables that use the `aria-colindex` or\n`data-colindex` attributes, examines the focus state of the table, and\nreturns a `SkipFocus` enumeration.\n\nThe `SkipFocus` return value indicates whether the caller should skip focus\nto \"before\" the table, \"after\" the table, or take no action, and let the\nbrowser's \"natural\" focus management manage focus."
],
"signature": [
"({ containerElement, getFocusedCell, shiftKey, tableHasFocus, tableClassName, }: { containerElement: HTMLElement | null; getFocusedCell: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.GetFocusedCell",
"text": "GetFocusedCell"
},
"; shiftKey: boolean; tableHasFocus: (containerElement: HTMLElement | null) => boolean; tableClassName: string; }) => ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SkipFocus",
"text": "SkipFocus"
}
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getTableSkipFocus.$1",
"type": "Object",
"tags": [],
"label": "{\n containerElement,\n getFocusedCell,\n shiftKey,\n tableHasFocus,\n tableClassName,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getTableSkipFocus.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getTableSkipFocus.$1.getFocusedCell",
"type": "Function",
"tags": [],
"label": "getFocusedCell",
"description": [],
"signature": [
"({ containerElement, tableClassName, }: { containerElement: HTMLElement | null; tableClassName: string; }) => HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getTableSkipFocus.$1.getFocusedCell.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ containerElement: HTMLElement | null; tableClassName: string; }"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "timelines",
"id": "def-public.getTableSkipFocus.$1.shiftKey",
"type": "boolean",
"tags": [],
"label": "shiftKey",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getTableSkipFocus.$1.tableHasFocus",
"type": "Function",
"tags": [],
"label": "tableHasFocus",
"description": [],
"signature": [
"(containerElement: HTMLElement | null) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getTableSkipFocus.$1.tableHasFocus.$1",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.getTableSkipFocus.$1.tableClassName",
"type": "string",
"tags": [],
"label": "tableClassName",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.getTimelineIdFromColumnDroppableId",
"type": "Function",
"tags": [],
"label": "getTimelineIdFromColumnDroppableId",
"description": [],
"signature": [
"(droppableId: string) => string"
],
"path": "x-pack/plugins/timelines/public/components/drag_and_drop/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.getTimelineIdFromColumnDroppableId.$1",
"type": "string",
"tags": [],
"label": "droppableId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/timelines/public/components/drag_and_drop/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.handleSkipFocus",
"type": "Function",
"tags": [],
"label": "handleSkipFocus",
"description": [
"\nIf the value of `skipFocus` is `SKIP_FOCUS_BACKWARDS` or `SKIP_FOCUS_FORWARD`\nthis function will invoke the provided `onSkipFocusBackwards` or\n`onSkipFocusForward` functions respectively.\n\nIf `skipFocus` is `SKIP_FOCUS_NOOP`, the `onSkipFocusBackwards` and\n`onSkipFocusForward` functions will not be invoked."
],
"signature": [
"({ onSkipFocusBackwards, onSkipFocusForward, skipFocus, }: { onSkipFocusBackwards: () => void; onSkipFocusForward: () => void; skipFocus: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SkipFocus",
"text": "SkipFocus"
},
"; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.handleSkipFocus.$1",
"type": "Object",
"tags": [],
"label": "{\n onSkipFocusBackwards,\n onSkipFocusForward,\n skipFocus,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.handleSkipFocus.$1.onSkipFocusBackwards",
"type": "Function",
"tags": [],
"label": "onSkipFocusBackwards",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.handleSkipFocus.$1.onSkipFocusForward",
"type": "Function",
"tags": [],
"label": "onSkipFocusForward",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.handleSkipFocus.$1.skipFocus",
"type": "CompoundType",
"tags": [],
"label": "skipFocus",
"description": [],
"signature": [
"\"SKIP_FOCUS_BACKWARDS\" | \"SKIP_FOCUS_FORWARD\" | \"SKIP_FOCUS_NOOP\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.isArrowDownOrArrowUp",
"type": "Function",
"tags": [],
"label": "isArrowDownOrArrowUp",
"description": [
"Returns `true` if the down or up arrow was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.isArrowDownOrArrowUp.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.isArrowUp",
"type": "Function",
"tags": [],
"label": "isArrowUp",
"description": [
"Returns `true` if the up arrow key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.isArrowUp.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.isEscape",
"type": "Function",
"tags": [],
"label": "isEscape",
"description": [
"Returns `true` if the escape key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.isEscape.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.isTab",
"type": "Function",
"tags": [],
"label": "isTab",
"description": [
"Returns `true` if the tab key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.isTab.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.onFocusReFocusDraggable",
"type": "Function",
"tags": [],
"label": "onFocusReFocusDraggable",
"description": [
"\nAn `onFocus` event handler that focuses the first child draggable\nkeyboard handler"
],
"signature": [
"(event: React.FocusEvent<HTMLElement>) => void | undefined"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.onFocusReFocusDraggable.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.FocusEvent<HTMLElement>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler",
"type": "Function",
"tags": [],
"label": "onKeyDownFocusHandler",
"description": [
"\nThis function adds keyboard accessability to any `containerElement` that\nrenders its rows with support for `aria-colindex` and `aria-rowindex`.\n\nTo use this function, invoke it in the `onKeyDown` handler of the specified\n`containerElement`.\n\nSee the `Keyboard Support` section of\nhttps://www.w3.org/TR/wai-aria-practices-1.1/examples/grid/dataGrids.html\nfor details of the behavior."
],
"signature": [
"({ colindexAttribute, containerElement, event, maxAriaColindex, maxAriaRowindex, onColumnFocused, rowindexAttribute, }: { colindexAttribute: string; containerElement: HTMLDivElement | null; event: React.KeyboardEvent<Element>; maxAriaColindex: number; maxAriaRowindex: number; onColumnFocused: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnColumnFocused",
"text": "OnColumnFocused"
},
"; rowindexAttribute: string; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler.$1",
"type": "Object",
"tags": [],
"label": "{\n colindexAttribute,\n containerElement,\n event,\n maxAriaColindex,\n maxAriaRowindex,\n onColumnFocused,\n rowindexAttribute,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler.$1.event",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler.$1.maxAriaColindex",
"type": "number",
"tags": [],
"label": "maxAriaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler.$1.maxAriaRowindex",
"type": "number",
"tags": [],
"label": "maxAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler.$1.onColumnFocused",
"type": "Function",
"tags": [],
"label": "onColumnFocused",
"description": [],
"signature": [
"({ newFocusedColumn, newFocusedColumnAriaColindex, }: { newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler.$1.onColumnFocused.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "timelines",
"id": "def-public.onKeyDownFocusHandler.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.skipFocusInContainerTo",
"type": "Function",
"tags": [],
"label": "skipFocusInContainerTo",
"description": [
"\nThis function has a side effect. It focuses the first element with a\nmatching `className` in the `containerElement`."
],
"signature": [
"({ containerElement, className, }: { containerElement: HTMLElement | null; className: string; }) => void | undefined"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.skipFocusInContainerTo.$1",
"type": "Object",
"tags": [],
"label": "{\n containerElement,\n className,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.skipFocusInContainerTo.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.skipFocusInContainerTo.$1.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.StatefulFieldsBrowser",
"type": "Function",
"tags": [],
"label": "StatefulFieldsBrowser",
"description": [],
"signature": [
"React.NamedExoticComponent<",
"FieldBrowserProps",
">"
],
"path": "x-pack/plugins/timelines/public/components/t_grid/toolbar/fields_browser/index.tsx",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.StatefulFieldsBrowser.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/index.d.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.stopPropagationAndPreventDefault",
"type": "Function",
"tags": [],
"label": "stopPropagationAndPreventDefault",
"description": [
"\nThis function has side effects: It stops propagation of the provided\n`KeyboardEvent` and prevents the browser's default behavior."
],
"signature": [
"(event: React.KeyboardEvent<Element>) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.stopPropagationAndPreventDefault.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.tGridReducer",
"type": "Function",
"tags": [],
"label": "tGridReducer",
"description": [
"The reducer for all timeline actions"
],
"signature": [
"(state: ",
{
"pluginId": "timelines",
"scope": "public",
"docId": "kibTimelinesPluginApi",
"section": "def-public.TimelineState",
"text": "TimelineState"
},
" | undefined, action: { type: any; }) => ",
{
"pluginId": "timelines",
"scope": "public",
"docId": "kibTimelinesPluginApi",
"section": "def-public.TimelineState",
"text": "TimelineState"
}
],
"path": "x-pack/plugins/timelines/public/store/t_grid/reducer.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.tGridReducer.$1",
"type": "Uncategorized",
"tags": [],
"label": "state",
"description": [],
"signature": [
"PassedS"
],
"path": "node_modules/typescript-fsa-reducers/dist/index.d.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.tGridReducer.$2",
"type": "Object",
"tags": [],
"label": "action",
"description": [],
"signature": [
"{ type: any; }"
],
"path": "node_modules/typescript-fsa-reducers/dist/index.d.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.useStatusBulkActionItems",
"type": "Function",
"tags": [],
"label": "useStatusBulkActionItems",
"description": [],
"signature": [
"({ eventIds, currentStatus, query, indexName, setEventsLoading, setEventsDeleted, onUpdateSuccess, onUpdateFailure, timelineId, }: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.StatusBulkActionsProps",
"text": "StatusBulkActionsProps"
},
") => JSX.Element[]"
],
"path": "x-pack/plugins/timelines/public/hooks/use_status_bulk_action_items.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.useStatusBulkActionItems.$1",
"type": "Object",
"tags": [],
"label": "{\n eventIds,\n currentStatus,\n query,\n indexName,\n setEventsLoading,\n setEventsDeleted,\n onUpdateSuccess,\n onUpdateFailure,\n timelineId,\n}",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.StatusBulkActionsProps",
"text": "StatusBulkActionsProps"
}
],
"path": "x-pack/plugins/timelines/public/hooks/use_status_bulk_action_items.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "timelines",
"id": "def-public.CursorType",
"type": "Interface",
"tags": [],
"label": "CursorType",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.CursorType.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.CursorType.tiebreaker",
"type": "CompoundType",
"tags": [],
"label": "tiebreaker",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.Inspect",
"type": "Interface",
"tags": [],
"label": "Inspect",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.Inspect.dsl",
"type": "Array",
"tags": [],
"label": "dsl",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.PaginationInputPaginated",
"type": "Interface",
"tags": [],
"label": "PaginationInputPaginated",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.PaginationInputPaginated.activePage",
"type": "number",
"tags": [],
"label": "activePage",
"description": [
"The activePage parameter defines the page of results you want to fetch"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.PaginationInputPaginated.cursorStart",
"type": "number",
"tags": [],
"label": "cursorStart",
"description": [
"The cursorStart parameter defines the start of the results to be displayed"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.PaginationInputPaginated.fakePossibleCount",
"type": "number",
"tags": [],
"label": "fakePossibleCount",
"description": [
"The fakePossibleCount parameter determines the total count in order to show 5 additional pages"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.PaginationInputPaginated.querySize",
"type": "number",
"tags": [],
"label": "querySize",
"description": [
"The querySize parameter is the number of items to be returned"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.SortField",
"type": "Interface",
"tags": [],
"label": "SortField",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortField",
"text": "SortField"
},
"<Field>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.SortField.field",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"Field"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.SortField.direction",
"type": "Enum",
"tags": [],
"label": "direction",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelineState",
"type": "Interface",
"tags": [],
"label": "TimelineState",
"description": [
"The state of all timelines is stored here"
],
"path": "x-pack/plugins/timelines/public/store/t_grid/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelineState.timelineById",
"type": "Object",
"tags": [],
"label": "timelineById",
"description": [],
"signature": [
"TimelineById"
],
"path": "x-pack/plugins/timelines/public/store/t_grid/types.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.TimerangeInput",
"type": "Interface",
"tags": [],
"label": "TimerangeInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimerangeInput.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [
"The interval string to use for last bucket. The format is '{value}{unit}'. For example '5m' would return the metrics for the last 5 minutes of the timespan."
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.TimerangeInput.to",
"type": "string",
"tags": [],
"label": "to",
"description": [
"The end of the timerange"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.TimerangeInput.from",
"type": "string",
"tags": [],
"label": "from",
"description": [
"The beginning of the timerange"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.TotalValue",
"type": "Interface",
"tags": [],
"label": "TotalValue",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TotalValue.value",
"type": "number",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-public.TotalValue.relation",
"type": "string",
"tags": [],
"label": "relation",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "timelines",
"id": "def-public.Direction",
"type": "Enum",
"tags": [],
"label": "Direction",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "timelines",
"id": "def-public.ARIA_COLINDEX_ATTRIBUTE",
"type": "string",
"tags": [],
"label": "ARIA_COLINDEX_ATTRIBUTE",
"description": [
"\nThe name of the ARIA attribute representing a column, used in conjunction with\nthe ARIA: grid role https://www.w3.org/TR/wai-aria-practices-1.1/examples/grid/dataGrids.html"
],
"signature": [
"\"aria-colindex\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.ARIA_ROWINDEX_ATTRIBUTE",
"type": "string",
"tags": [],
"label": "ARIA_ROWINDEX_ATTRIBUTE",
"description": [
"\nThe name of the ARIA attribute representing a row, used in conjunction with\nthe ARIA: grid role https://www.w3.org/TR/wai-aria-practices-1.1/examples/grid/dataGrids.html"
],
"signature": [
"\"aria-rowindex\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.DATA_COLINDEX_ATTRIBUTE",
"type": "string",
"tags": [],
"label": "DATA_COLINDEX_ATTRIBUTE",
"description": [
"\nThis alternative attribute to `aria-colindex` is used to decorate the data\nin existing `EuiTable`s to enable keyboard navigation with minimal\nrefactoring of existing code until we're ready to migrate to `EuiDataGrid`.\nIt may be applied directly to keyboard-focusable elements and thus doesn't\nhave exactly the same semantics as `aria-colindex`."
],
"signature": [
"\"data-colindex\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.DATA_ROWINDEX_ATTRIBUTE",
"type": "string",
"tags": [],
"label": "DATA_ROWINDEX_ATTRIBUTE",
"description": [
"\nThis alternative attribute to `aria-rowindex` is used to decorate the data\nin existing `EuiTable`s to enable keyboard navigation with minimal\nrefactoring of existing code until we're ready to migrate to `EuiDataGrid`.\nIt's typically applied to `<tr>` elements via `EuiTable`'s `rowProps` prop."
],
"signature": [
"\"data-rowindex\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.DocValueFields",
"type": "Type",
"tags": [],
"label": "DocValueFields",
"description": [],
"signature": [
"SearchDocValueField"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.FIRST_ARIA_INDEX",
"type": "number",
"tags": [],
"label": "FIRST_ARIA_INDEX",
"description": [
"`aria-colindex` and `aria-rowindex` start at one"
],
"signature": [
"1"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.OnColumnFocused",
"type": "Type",
"tags": [],
"label": "OnColumnFocused",
"description": [],
"signature": [
"({ newFocusedColumn, newFocusedColumnAriaColindex, }: { newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.OnColumnFocused.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.SortDirection",
"type": "Type",
"tags": [],
"label": "SortDirection",
"description": [],
"signature": [
"\"none\" | \"asc\" | \"desc\" | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.TGridModelForTimeline",
"type": "Type",
"tags": [],
"label": "TGridModelForTimeline",
"description": [],
"signature": [
"{ columns: (Pick<",
"EuiDataGridColumn",
", \"id\" | \"display\" | \"displayAsText\" | \"initialWidth\"> & Pick<",
"EuiDataGridColumn",
", \"id\" | \"schema\" | \"display\" | \"actions\" | \"defaultSortDirection\" | \"displayAsText\" | \"initialWidth\" | \"isSortable\"> & { aggregatable?: boolean | undefined; tGridCellActions?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TGridCellAction",
"text": "TGridCellAction"
},
"[] | undefined; category?: string | undefined; columnHeaderType: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderType",
"text": "ColumnHeaderType"
},
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
"IFieldSubTypeMultiOptional",
" | ",
"IFieldSubTypeNestedOptional",
" | undefined; type?: string | undefined; })[]; id: string; title: string; filters?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; sort: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortColumnTimeline",
"text": "SortColumnTimeline"
},
"[]; version: string | null; isLoading: boolean; filterManager?: ",
{
"pluginId": "data",
"scope": "public",
"docId": "kibDataQueryPluginApi",
"section": "def-public.FilterManager",
"text": "FilterManager"
},
" | undefined; dateRange: { start: string; end: string; }; defaultColumns: (Pick<",
"EuiDataGridColumn",
", \"id\" | \"display\" | \"displayAsText\" | \"initialWidth\"> & Pick<",
"EuiDataGridColumn",
", \"id\" | \"schema\" | \"display\" | \"actions\" | \"defaultSortDirection\" | \"displayAsText\" | \"initialWidth\" | \"isSortable\"> & { aggregatable?: boolean | undefined; tGridCellActions?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TGridCellAction",
"text": "TGridCellAction"
},
"[] | undefined; category?: string | undefined; columnHeaderType: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderType",
"text": "ColumnHeaderType"
},
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
"IFieldSubTypeMultiOptional",
" | ",
"IFieldSubTypeNestedOptional",
" | undefined; type?: string | undefined; })[]; savedObjectId: string | null; unit?: ((n: number) => React.ReactNode) | undefined; dataProviders: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProvider",
"text": "DataProvider"
},
"[]; deletedEventIds: string[]; documentType: string; excludedRowRendererIds: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[]; expandedDetail: Partial<Record<string, ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineExpandedDetailType",
"text": "TimelineExpandedDetailType"
},
">>; footerText?: React.ReactNode; graphEventId?: string | undefined; kqlQuery: { filterQuery: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SerializedFilterQuery",
"text": "SerializedFilterQuery"
},
" | null; }; queryFields: string[]; indexNames: string[]; isSelectAllChecked: boolean; itemsPerPage: number; itemsPerPageOptions: number[]; loadingEventIds: string[]; loadingText?: React.ReactNode; selectAll: boolean; showCheckboxes: boolean; selectedEventIds: Record<string, ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineNonEcsData",
"text": "TimelineNonEcsData"
},
"[]>; }"
],
"path": "x-pack/plugins/timelines/public/store/t_grid/model.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.TGridType",
"type": "Type",
"tags": [],
"label": "TGridType",
"description": [],
"signature": [
"\"standalone\" | \"embedded\""
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "timelines",
"id": "def-public.StatefulEventContext",
"type": "Object",
"tags": [],
"label": "StatefulEventContext",
"description": [],
"signature": [
"React.Context<",
"StatefulEventContextType",
" | null>"
],
"path": "x-pack/plugins/timelines/public/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.tGridActions",
"type": "Object",
"tags": [],
"label": "tGridActions",
"description": [],
"signature": [
"typeof ",
"x-pack/plugins/timelines/public/store/t_grid/actions"
],
"path": "x-pack/plugins/timelines/public/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.tGridSelectors",
"type": "Object",
"tags": [],
"label": "tGridSelectors",
"description": [],
"signature": [
"typeof ",
"x-pack/plugins/timelines/public/store/t_grid/selectors"
],
"path": "x-pack/plugins/timelines/public/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelineContext",
"type": "Object",
"tags": [],
"label": "TimelineContext",
"description": [],
"signature": [
"React.Context<{ timelineId: string | null; }>"
],
"path": "x-pack/plugins/timelines/public/components/t_grid/shared/index.tsx",
"deprecated": false,
"initialIsOpen": false
}
],
"start": {
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart",
"type": "Interface",
"tags": [],
"label": "TimelinesUIStart",
"description": [],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getHoverActions",
"type": "Function",
"tags": [],
"label": "getHoverActions",
"description": [],
"signature": [
"() => ",
"HoverActionsConfig"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getTGrid",
"type": "Function",
"tags": [],
"label": "getTGrid",
"description": [],
"signature": [
"<T extends ",
{
"pluginId": "timelines",
"scope": "public",
"docId": "kibTimelinesPluginApi",
"section": "def-public.TGridType",
"text": "TGridType"
},
" = \"embedded\">(props: ",
"GetTGridProps",
"<T>) => React.ReactElement<",
"GetTGridProps",
"<T>, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)>"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getTGrid.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"GetTGridProps",
"<T>"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getTGridReducer",
"type": "Function",
"tags": [],
"label": "getTGridReducer",
"description": [],
"signature": [
"() => any"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getLoadingPanel",
"type": "Function",
"tags": [],
"label": "getLoadingPanel",
"description": [],
"signature": [
"(props: ",
"LoadingPanelProps",
") => React.ReactElement<",
"LoadingPanelProps",
">"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getLoadingPanel.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"LoadingPanelProps"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getLastUpdated",
"type": "Function",
"tags": [],
"label": "getLastUpdated",
"description": [],
"signature": [
"(props: ",
"LastUpdatedAtProps",
") => React.ReactElement<",
"LastUpdatedAtProps",
">"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getLastUpdated.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"LastUpdatedAtProps"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getFieldBrowser",
"type": "Function",
"tags": [],
"label": "getFieldBrowser",
"description": [],
"signature": [
"(props: ",
"FieldBrowserProps",
") => React.ReactElement<",
"FieldBrowserProps",
">"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getFieldBrowser.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"FieldBrowserProps"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getUseAddToTimeline",
"type": "Function",
"tags": [],
"label": "getUseAddToTimeline",
"description": [],
"signature": [
"() => (props: ",
"UseAddToTimelineProps",
") => ",
"UseAddToTimeline"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getUseAddToTimelineSensor",
"type": "Function",
"tags": [],
"label": "getUseAddToTimelineSensor",
"description": [],
"signature": [
"() => (api: ",
"SensorAPI",
") => void"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getUseDraggableKeyboardWrapper",
"type": "Function",
"tags": [],
"label": "getUseDraggableKeyboardWrapper",
"description": [],
"signature": [
"() => (props: ",
"UseDraggableKeyboardWrapperProps",
") => ",
"UseDraggableKeyboardWrapper"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.setTGridEmbeddedStore",
"type": "Function",
"tags": [],
"label": "setTGridEmbeddedStore",
"description": [],
"signature": [
"(store: ",
"Store",
"<any, ",
"AnyAction",
">) => void"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.setTGridEmbeddedStore.$1",
"type": "Object",
"tags": [],
"label": "store",
"description": [],
"signature": [
"Store",
"<any, ",
"AnyAction",
">"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getAddToCaseAction",
"type": "Function",
"tags": [],
"label": "getAddToCaseAction",
"description": [],
"signature": [
"(props: ",
"AddToCaseActionProps",
") => React.ReactElement<",
"AddToCaseActionProps",
">"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getAddToCaseAction.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"AddToCaseActionProps"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getAddToCasePopover",
"type": "Function",
"tags": [],
"label": "getAddToCasePopover",
"description": [],
"signature": [
"(props: ",
"AddToCaseActionProps",
") => React.ReactElement<",
"AddToCaseActionProps",
">"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getAddToCasePopover.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"AddToCaseActionProps"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getAddToExistingCaseButton",
"type": "Function",
"tags": [],
"label": "getAddToExistingCaseButton",
"description": [],
"signature": [
"(props: ",
"AddToCaseActionProps",
") => React.ReactElement<",
"AddToCaseActionProps",
">"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getAddToExistingCaseButton.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"AddToCaseActionProps"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getAddToNewCaseButton",
"type": "Function",
"tags": [],
"label": "getAddToNewCaseButton",
"description": [],
"signature": [
"(props: ",
"AddToCaseActionProps",
") => React.ReactElement<",
"AddToCaseActionProps",
">"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-public.TimelinesUIStart.getAddToNewCaseButton.$1",
"type": "Object",
"tags": [],
"label": "props",
"description": [],
"signature": [
"AddToCaseActionProps"
],
"path": "x-pack/plugins/timelines/public/types.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": [],
"setup": {
"parentPluginId": "timelines",
"id": "def-server.TimelinesPluginUI",
"type": "Interface",
"tags": [],
"label": "TimelinesPluginUI",
"description": [],
"path": "x-pack/plugins/timelines/server/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "timelines",
"id": "def-server.TimelinesPluginStart",
"type": "Interface",
"tags": [],
"label": "TimelinesPluginStart",
"description": [],
"path": "x-pack/plugins/timelines/server/types.ts",
"deprecated": false,
"children": [],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "timelines",
"id": "def-common.ariaIndexToArrayIndex",
"type": "Function",
"tags": [],
"label": "ariaIndexToArrayIndex",
"description": [
"Converts an aria index, which starts at one, to an array index, which starts at zero"
],
"signature": [
"(ariaIndex: number) => number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ariaIndexToArrayIndex.$1",
"type": "number",
"tags": [],
"label": "ariaIndex",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.arrayIndexToAriaIndex",
"type": "Function",
"tags": [],
"label": "arrayIndexToAriaIndex",
"description": [
"Converts an array index, which starts at zero, to an aria index, which starts at one"
],
"signature": [
"(arrayIndex: number) => number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.arrayIndexToAriaIndex.$1",
"type": "number",
"tags": [],
"label": "arrayIndex",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.elementOrChildrenHasFocus",
"type": "Function",
"tags": [],
"label": "elementOrChildrenHasFocus",
"description": [
"Returns `true` when the element, or one of it's children has focus"
],
"signature": [
"(element: HTMLElement | null | undefined) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.elementOrChildrenHasFocus.$1",
"type": "CompoundType",
"tags": [],
"label": "element",
"description": [],
"signature": [
"HTMLElement | null | undefined"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.focusColumn",
"type": "Function",
"tags": [],
"label": "focusColumn",
"description": [
"\nSIDE EFFECT: mutates the DOM by focusing the specified column\nreturns the `aria-colindex` of the newly-focused column"
],
"signature": [
"({ colindexAttribute, containerElement, ariaColindex, ariaRowindex, rowindexAttribute, }: { colindexAttribute: string; containerElement: Element | null; ariaColindex: number; ariaRowindex: number; rowindexAttribute: string; }) => FocusColumnResult"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.focusColumn.$1",
"type": "Object",
"tags": [],
"label": "{\n colindexAttribute,\n containerElement,\n ariaColindex,\n ariaRowindex,\n rowindexAttribute,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.focusColumn.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.focusColumn.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"Element | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.focusColumn.$1.ariaColindex",
"type": "number",
"tags": [],
"label": "ariaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.focusColumn.$1.ariaRowindex",
"type": "number",
"tags": [],
"label": "ariaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.focusColumn.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.focusedCellHasAlwaysOpenHoverContent",
"type": "Function",
"tags": [],
"label": "focusedCellHasAlwaysOpenHoverContent",
"description": [
"\nReturns `true` when the provided `focusedCell` has always-open hover\ncontent (i.e. a hover menu)\n\nWhen this function returns true, the caller should `NOT` move focus away\nfrom the table. Instead, the browser's \"natural\" focus management should\nbe allowed to manage focus between the table and the hover content."
],
"signature": [
"(focusedCell: HTMLElement | null) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.focusedCellHasAlwaysOpenHoverContent.$1",
"type": "CompoundType",
"tags": [],
"label": "focusedCell",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.focusedCellHasMoreFocusableChildren",
"type": "Function",
"tags": [],
"label": "focusedCellHasMoreFocusableChildren",
"description": [
"\nThe provided `focusedCell` may contain multiple focusable children. For,\nexample, the cell may contain multiple `HTMLButtonElement`s that represent\nactions, or the cell may contain multiple draggables.\n\nThis function returns `true` when there are still more children of the cell\nthat should receive focus when the tab key is pressed.\n\nWhen this function returns `true`, the caller should NOT move focus away\nfrom the table. Instead, the browser's \"natural\" focus management should be\nallowed to automatically focus the next (or previous) focusable child of the\ncell."
],
"signature": [
"({ focusedCell, shiftKey, }: { focusedCell: HTMLElement | null; shiftKey: boolean; }) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.focusedCellHasMoreFocusableChildren.$1",
"type": "Object",
"tags": [],
"label": "{\n focusedCell,\n shiftKey,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.focusedCellHasMoreFocusableChildren.$1.focusedCell",
"type": "CompoundType",
"tags": [],
"label": "focusedCell",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.focusedCellHasMoreFocusableChildren.$1.shiftKey",
"type": "boolean",
"tags": [],
"label": "shiftKey",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.focusedCellIsPlainColumnHeader",
"type": "Function",
"tags": [],
"label": "focusedCellIsPlainColumnHeader",
"description": [
"\nReturns true if the focused cell is a plain, non-action `columnheader`"
],
"signature": [
"(focusedCell: HTMLDivElement | null) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.focusedCellIsPlainColumnHeader.$1",
"type": "CompoundType",
"tags": [],
"label": "focusedCell",
"description": [],
"signature": [
"HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getColindex",
"type": "Function",
"tags": [],
"label": "getColindex",
"description": [
"Returns the numeric `aria-colindex` of the specified element"
],
"signature": [
"({ colindexAttribute, element, }: { colindexAttribute: string; element: Element | null; }) => number | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getColindex.$1",
"type": "Object",
"tags": [],
"label": "{\n colindexAttribute,\n element,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getColindex.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getColindex.$1.element",
"type": "CompoundType",
"tags": [],
"label": "element",
"description": [],
"signature": [
"Element | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getElementWithMatchingAriaColindex",
"type": "Function",
"tags": [],
"label": "getElementWithMatchingAriaColindex",
"description": [
"Returns the element at the specified `aria-colindex`"
],
"signature": [
"({ ariaColindex, colindexAttribute, element, }: { ariaColindex: number; colindexAttribute: string; element: HTMLDivElement | null; }) => HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getElementWithMatchingAriaColindex.$1",
"type": "Object",
"tags": [],
"label": "{\n ariaColindex,\n colindexAttribute,\n element,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getElementWithMatchingAriaColindex.$1.ariaColindex",
"type": "number",
"tags": [],
"label": "ariaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getElementWithMatchingAriaColindex.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getElementWithMatchingAriaColindex.$1.element",
"type": "CompoundType",
"tags": [],
"label": "element",
"description": [],
"signature": [
"HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFirstNonVisibleAriaRowindex",
"type": "Function",
"tags": [],
"label": "getFirstNonVisibleAriaRowindex",
"description": [],
"signature": [
"({ focusedAriaRowindex, element, event, maxAriaRowindex, rowindexAttribute, }: { focusedAriaRowindex: number; element: HTMLDivElement | null; event: React.KeyboardEvent<Element>; maxAriaRowindex: number; rowindexAttribute: string; }) => number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFirstNonVisibleAriaRowindex.$1",
"type": "Object",
"tags": [],
"label": "{\n focusedAriaRowindex,\n element,\n event,\n maxAriaRowindex,\n rowindexAttribute,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFirstNonVisibleAriaRowindex.$1.focusedAriaRowindex",
"type": "number",
"tags": [],
"label": "focusedAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFirstNonVisibleAriaRowindex.$1.element",
"type": "CompoundType",
"tags": [],
"label": "element",
"description": [],
"signature": [
"HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFirstNonVisibleAriaRowindex.$1.event",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFirstNonVisibleAriaRowindex.$1.maxAriaRowindex",
"type": "number",
"tags": [],
"label": "maxAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFirstNonVisibleAriaRowindex.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFirstOrLastAriaRowindex",
"type": "Function",
"tags": [],
"label": "getFirstOrLastAriaRowindex",
"description": [
"Returns the first `aria-rowindex` if the home key is pressed, otherwise the last `aria-rowindex` is returned"
],
"signature": [
"({ event, maxAriaRowindex, }: { event: React.KeyboardEvent<Element>; maxAriaRowindex: number; }) => number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFirstOrLastAriaRowindex.$1",
"type": "Object",
"tags": [],
"label": "{\n event,\n maxAriaRowindex,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFirstOrLastAriaRowindex.$1.event",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFirstOrLastAriaRowindex.$1.maxAriaRowindex",
"type": "number",
"tags": [],
"label": "maxAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusableChidren",
"type": "Function",
"tags": [],
"label": "getFocusableChidren",
"description": [
"\nReturns a table cell's focusable children, which may be one of the following\na) a `HTMLButtonElement` that does NOT have the `disabled` attribute\nb) an element with the `DRAGGABLE_KEYBOARD_WRAPPER_CLASS_NAME`"
],
"signature": [
"(cell: HTMLElement | null) => ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.FocusableElement",
"text": "FocusableElement"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusableChidren.$1",
"type": "CompoundType",
"tags": [],
"label": "cell",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedAriaColindexCell",
"type": "Function",
"tags": [],
"label": "getFocusedAriaColindexCell",
"description": [
"\nReturns the focused cell for tables that use `aria-colindex`"
],
"signature": [
"({ containerElement, tableClassName, }: { containerElement: HTMLElement | null; tableClassName: string; }) => HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedAriaColindexCell.$1",
"type": "Object",
"tags": [],
"label": "{\n containerElement,\n tableClassName,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedAriaColindexCell.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedAriaColindexCell.$1.tableClassName",
"type": "string",
"tags": [],
"label": "tableClassName",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedColumn",
"type": "Function",
"tags": [],
"label": "getFocusedColumn",
"description": [
"\nReturns the column that directly owns focus, or contains a focused element,\nusing the `aria-colindex` attribute."
],
"signature": [
"({ colindexAttribute, element, }: { colindexAttribute: string; element: Element | null; }) => Element | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedColumn.$1",
"type": "Object",
"tags": [],
"label": "{\n colindexAttribute,\n element,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedColumn.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedColumn.$1.element",
"type": "CompoundType",
"tags": [],
"label": "element",
"description": [],
"signature": [
"Element | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedDataColindexCell",
"type": "Function",
"tags": [],
"label": "getFocusedDataColindexCell",
"description": [
"\nReturns the focused cell for tables that use `data-colindex`"
],
"signature": [
"({ containerElement, tableClassName, }: { containerElement: HTMLElement | null; tableClassName: string; }) => HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedDataColindexCell.$1",
"type": "Object",
"tags": [],
"label": "{\n containerElement,\n tableClassName,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedDataColindexCell.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedDataColindexCell.$1.tableClassName",
"type": "string",
"tags": [],
"label": "tableClassName",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedRow",
"type": "Function",
"tags": [],
"label": "getFocusedRow",
"description": [
" Returns the row that directly owns focus, or contains a focused element"
],
"signature": [
"({ rowindexAttribute, element, }: { rowindexAttribute: string; element: Element | null; }) => Element | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedRow.$1",
"type": "Object",
"tags": [],
"label": "{\n rowindexAttribute,\n element,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedRow.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusedRow.$1.element",
"type": "CompoundType",
"tags": [],
"label": "element",
"description": [],
"signature": [
"Element | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getFocusOnFromArrowKey",
"type": "Function",
"tags": [],
"label": "getFocusOnFromArrowKey",
"description": [
"Returns `previous` or `next`, depending on which arrow key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => \"previous\" | \"next\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getFocusOnFromArrowKey.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaColindex",
"type": "Function",
"tags": [],
"label": "getNewAriaColindex",
"description": [
"Returns the `previous` or `next` `aria-colindex` relative to the currently focused `aria-colindex`"
],
"signature": [
"({ focusedAriaColindex, focusOn, maxAriaColindex, }: { focusedAriaColindex: number; focusOn: \"previous\" | \"next\"; maxAriaColindex: number; }) => number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaColindex.$1",
"type": "Object",
"tags": [],
"label": "{\n focusedAriaColindex,\n focusOn,\n maxAriaColindex,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaColindex.$1.focusedAriaColindex",
"type": "number",
"tags": [],
"label": "focusedAriaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaColindex.$1.focusOn",
"type": "CompoundType",
"tags": [],
"label": "focusOn",
"description": [],
"signature": [
"\"previous\" | \"next\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaColindex.$1.maxAriaColindex",
"type": "number",
"tags": [],
"label": "maxAriaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaRowindex",
"type": "Function",
"tags": [],
"label": "getNewAriaRowindex",
"description": [
"Returns the `previous` or `next` `aria-rowindex` relative to the currently focused `aria-rowindex`"
],
"signature": [
"({ focusedAriaRowindex, focusOn, maxAriaRowindex, }: { focusedAriaRowindex: number; focusOn: \"previous\" | \"next\"; maxAriaRowindex: number; }) => number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaRowindex.$1",
"type": "Object",
"tags": [],
"label": "{\n focusedAriaRowindex,\n focusOn,\n maxAriaRowindex,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaRowindex.$1.focusedAriaRowindex",
"type": "number",
"tags": [],
"label": "focusedAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaRowindex.$1.focusOn",
"type": "CompoundType",
"tags": [],
"label": "focusOn",
"description": [],
"signature": [
"\"previous\" | \"next\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getNewAriaRowindex.$1.maxAriaRowindex",
"type": "number",
"tags": [],
"label": "maxAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getNotesContainerClassName",
"type": "Function",
"tags": [],
"label": "getNotesContainerClassName",
"description": [],
"signature": [
"(ariaRowindex: number) => string"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getNotesContainerClassName.$1",
"type": "number",
"tags": [],
"label": "ariaRowindex",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getRowByAriaRowindex",
"type": "Function",
"tags": [],
"label": "getRowByAriaRowindex",
"description": [
"Returns the row with the specified `aria-rowindex`"
],
"signature": [
"({ ariaRowindex, element, rowindexAttribute, }: { ariaRowindex: number; element: Element | null; rowindexAttribute: string; }) => HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getRowByAriaRowindex.$1",
"type": "Object",
"tags": [],
"label": "{\n ariaRowindex,\n element,\n rowindexAttribute,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getRowByAriaRowindex.$1.ariaRowindex",
"type": "number",
"tags": [],
"label": "ariaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getRowByAriaRowindex.$1.element",
"type": "CompoundType",
"tags": [],
"label": "element",
"description": [],
"signature": [
"Element | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getRowByAriaRowindex.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getRowindex",
"type": "Function",
"tags": [],
"label": "getRowindex",
"description": [
"Returns the numeric `aria-rowindex` of the specified element"
],
"signature": [
"({ rowindexAttribute, element, }: { rowindexAttribute: string; element: Element | null; }) => number | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getRowindex.$1",
"type": "Object",
"tags": [],
"label": "{\n rowindexAttribute,\n element,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getRowindex.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getRowindex.$1.element",
"type": "CompoundType",
"tags": [],
"label": "element",
"description": [],
"signature": [
"Element | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getRowRendererClassName",
"type": "Function",
"tags": [],
"label": "getRowRendererClassName",
"description": [],
"signature": [
"(ariaRowindex: number) => string"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getRowRendererClassName.$1",
"type": "number",
"tags": [],
"label": "ariaRowindex",
"description": [],
"signature": [
"number"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getTableSkipFocus",
"type": "Function",
"tags": [],
"label": "getTableSkipFocus",
"description": [
"\nThis function, which works with tables that use the `aria-colindex` or\n`data-colindex` attributes, examines the focus state of the table, and\nreturns a `SkipFocus` enumeration.\n\nThe `SkipFocus` return value indicates whether the caller should skip focus\nto \"before\" the table, \"after\" the table, or take no action, and let the\nbrowser's \"natural\" focus management manage focus."
],
"signature": [
"({ containerElement, getFocusedCell, shiftKey, tableHasFocus, tableClassName, }: { containerElement: HTMLElement | null; getFocusedCell: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.GetFocusedCell",
"text": "GetFocusedCell"
},
"; shiftKey: boolean; tableHasFocus: (containerElement: HTMLElement | null) => boolean; tableClassName: string; }) => ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SkipFocus",
"text": "SkipFocus"
}
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getTableSkipFocus.$1",
"type": "Object",
"tags": [],
"label": "{\n containerElement,\n getFocusedCell,\n shiftKey,\n tableHasFocus,\n tableClassName,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getTableSkipFocus.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getTableSkipFocus.$1.getFocusedCell",
"type": "Function",
"tags": [],
"label": "getFocusedCell",
"description": [],
"signature": [
"({ containerElement, tableClassName, }: { containerElement: HTMLElement | null; tableClassName: string; }) => HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getTableSkipFocus.$1.getFocusedCell.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ containerElement: HTMLElement | null; tableClassName: string; }"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "timelines",
"id": "def-common.getTableSkipFocus.$1.shiftKey",
"type": "boolean",
"tags": [],
"label": "shiftKey",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getTableSkipFocus.$1.tableHasFocus",
"type": "Function",
"tags": [],
"label": "tableHasFocus",
"description": [],
"signature": [
"(containerElement: HTMLElement | null) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getTableSkipFocus.$1.tableHasFocus.$1",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.getTableSkipFocus.$1.tableClassName",
"type": "string",
"tags": [],
"label": "tableClassName",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getValidationErrors",
"type": "Function",
"tags": [],
"label": "getValidationErrors",
"description": [],
"signature": [
"(response: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ErrorResponse",
"text": "ErrorResponse"
},
") => string[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/validation/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.getValidationErrors.$1",
"type": "Object",
"tags": [],
"label": "response",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ErrorResponse",
"text": "ErrorResponse"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/validation/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.handleSkipFocus",
"type": "Function",
"tags": [],
"label": "handleSkipFocus",
"description": [
"\nIf the value of `skipFocus` is `SKIP_FOCUS_BACKWARDS` or `SKIP_FOCUS_FORWARD`\nthis function will invoke the provided `onSkipFocusBackwards` or\n`onSkipFocusForward` functions respectively.\n\nIf `skipFocus` is `SKIP_FOCUS_NOOP`, the `onSkipFocusBackwards` and\n`onSkipFocusForward` functions will not be invoked."
],
"signature": [
"({ onSkipFocusBackwards, onSkipFocusForward, skipFocus, }: { onSkipFocusBackwards: () => void; onSkipFocusForward: () => void; skipFocus: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SkipFocus",
"text": "SkipFocus"
},
"; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.handleSkipFocus.$1",
"type": "Object",
"tags": [],
"label": "{\n onSkipFocusBackwards,\n onSkipFocusForward,\n skipFocus,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.handleSkipFocus.$1.onSkipFocusBackwards",
"type": "Function",
"tags": [],
"label": "onSkipFocusBackwards",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.handleSkipFocus.$1.onSkipFocusForward",
"type": "Function",
"tags": [],
"label": "onSkipFocusForward",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.handleSkipFocus.$1.skipFocus",
"type": "CompoundType",
"tags": [],
"label": "skipFocus",
"description": [],
"signature": [
"\"SKIP_FOCUS_BACKWARDS\" | \"SKIP_FOCUS_FORWARD\" | \"SKIP_FOCUS_NOOP\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isArrowDown",
"type": "Function",
"tags": [],
"label": "isArrowDown",
"description": [
"Returns `true` if the down arrow key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isArrowDown.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isArrowDownOrArrowUp",
"type": "Function",
"tags": [],
"label": "isArrowDownOrArrowUp",
"description": [
"Returns `true` if the down or up arrow was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isArrowDownOrArrowUp.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isArrowKey",
"type": "Function",
"tags": [],
"label": "isArrowKey",
"description": [
"Returns `true` if an arrow key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isArrowKey.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isArrowRight",
"type": "Function",
"tags": [],
"label": "isArrowRight",
"description": [
"Returns `true` if the right arrow key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isArrowRight.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isArrowRightOrArrowLeft",
"type": "Function",
"tags": [],
"label": "isArrowRightOrArrowLeft",
"description": [
"Returns `true` if the left or right arrow was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isArrowRightOrArrowLeft.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isArrowUp",
"type": "Function",
"tags": [],
"label": "isArrowUp",
"description": [
"Returns `true` if the up arrow key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isArrowUp.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isEnd",
"type": "Function",
"tags": [],
"label": "isEnd",
"description": [
"Returns `true` if the end key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isEnd.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isErrorResponse",
"type": "Function",
"tags": [],
"label": "isErrorResponse",
"description": [],
"signature": [
"(response: unknown) => response is ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ErrorResponse",
"text": "ErrorResponse"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/validation/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isErrorResponse.$1",
"type": "Unknown",
"tags": [],
"label": "response",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/validation/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isEscape",
"type": "Function",
"tags": [],
"label": "isEscape",
"description": [
"Returns `true` if the escape key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isEscape.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isHome",
"type": "Function",
"tags": [],
"label": "isHome",
"description": [
"Returns `true` if the home key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isHome.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isHomeOrEnd",
"type": "Function",
"tags": [],
"label": "isHomeOrEnd",
"description": [
"Returns `true` if the home or end key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isHomeOrEnd.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isPageDown",
"type": "Function",
"tags": [],
"label": "isPageDown",
"description": [
"Returns `true` if the page down key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isPageDown.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isPageDownOrPageUp",
"type": "Function",
"tags": [],
"label": "isPageDownOrPageUp",
"description": [
"Returns `true` if the page up or page down key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isPageDownOrPageUp.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isPageUp",
"type": "Function",
"tags": [],
"label": "isPageUp",
"description": [
"Returns `true` if the page up key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isPageUp.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isTab",
"type": "Function",
"tags": [],
"label": "isTab",
"description": [
"Returns `true` if the tab key was pressed"
],
"signature": [
"(event: React.KeyboardEvent<Element>) => boolean"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isTab.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.isValidationErrorResponse",
"type": "Function",
"tags": [],
"label": "isValidationErrorResponse",
"description": [],
"signature": [
"(response: unknown) => response is ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ErrorResponse",
"text": "ErrorResponse"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/validation/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.isValidationErrorResponse.$1",
"type": "Unknown",
"tags": [],
"label": "response",
"description": [],
"signature": [
"unknown"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/validation/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown",
"type": "Function",
"tags": [],
"label": "onArrowKeyDown",
"description": [
"\nThis function implements arrow key support for the `onKeyDownFocusHandler`.\n\nSee the `Keyboard Support` section of\nhttps://www.w3.org/TR/wai-aria-practices-1.1/examples/grid/dataGrids.html\nfor details"
],
"signature": [
"({ colindexAttribute, containerElement, event, focusedAriaColindex, focusedAriaRowindex, maxAriaColindex, maxAriaRowindex, onColumnFocused, rowindexAttribute, }: { colindexAttribute: string; containerElement: HTMLElement | null; event: React.KeyboardEvent<Element>; focusedAriaColindex: number; focusedAriaRowindex: number; maxAriaColindex: number; maxAriaRowindex: number; onColumnFocused?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnColumnFocused",
"text": "OnColumnFocused"
},
" | undefined; rowindexAttribute: string; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1",
"type": "Object",
"tags": [],
"label": "{\n colindexAttribute,\n containerElement,\n event,\n focusedAriaColindex,\n focusedAriaRowindex,\n maxAriaColindex,\n maxAriaRowindex,\n onColumnFocused,\n rowindexAttribute,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1.event",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1.focusedAriaColindex",
"type": "number",
"tags": [],
"label": "focusedAriaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1.focusedAriaRowindex",
"type": "number",
"tags": [],
"label": "focusedAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1.maxAriaColindex",
"type": "number",
"tags": [],
"label": "maxAriaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1.maxAriaRowindex",
"type": "number",
"tags": [],
"label": "maxAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1.onColumnFocused",
"type": "Function",
"tags": [],
"label": "onColumnFocused",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnColumnFocused",
"text": "OnColumnFocused"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onArrowKeyDown.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onFocusReFocusDraggable",
"type": "Function",
"tags": [],
"label": "onFocusReFocusDraggable",
"description": [
"\nAn `onFocus` event handler that focuses the first child draggable\nkeyboard handler"
],
"signature": [
"(event: React.FocusEvent<HTMLElement>) => void | undefined"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onFocusReFocusDraggable.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.FocusEvent<HTMLElement>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown",
"type": "Function",
"tags": [],
"label": "onHomeEndDown",
"description": [
"\nThis function implements `home` and `end` key support for the `onKeyDownFocusHandler`.\n\nSee the `Keyboard Support` section of\nhttps://www.w3.org/TR/wai-aria-practices-1.1/examples/grid/dataGrids.html\nfor details"
],
"signature": [
"({ colindexAttribute, containerElement, event, focusedAriaRowindex, maxAriaColindex, maxAriaRowindex, onColumnFocused, rowindexAttribute, }: { colindexAttribute: string; containerElement: HTMLElement | null; event: React.KeyboardEvent<Element>; focusedAriaRowindex: number; maxAriaColindex: number; maxAriaRowindex: number; onColumnFocused?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnColumnFocused",
"text": "OnColumnFocused"
},
" | undefined; rowindexAttribute: string; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown.$1",
"type": "Object",
"tags": [],
"label": "{\n colindexAttribute,\n containerElement,\n event,\n focusedAriaRowindex,\n maxAriaColindex,\n maxAriaRowindex,\n onColumnFocused,\n rowindexAttribute,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown.$1.event",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown.$1.focusedAriaRowindex",
"type": "number",
"tags": [],
"label": "focusedAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown.$1.maxAriaColindex",
"type": "number",
"tags": [],
"label": "maxAriaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown.$1.maxAriaRowindex",
"type": "number",
"tags": [],
"label": "maxAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown.$1.onColumnFocused",
"type": "Function",
"tags": [],
"label": "onColumnFocused",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnColumnFocused",
"text": "OnColumnFocused"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onHomeEndDown.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler",
"type": "Function",
"tags": [],
"label": "onKeyDownFocusHandler",
"description": [
"\nThis function adds keyboard accessability to any `containerElement` that\nrenders its rows with support for `aria-colindex` and `aria-rowindex`.\n\nTo use this function, invoke it in the `onKeyDown` handler of the specified\n`containerElement`.\n\nSee the `Keyboard Support` section of\nhttps://www.w3.org/TR/wai-aria-practices-1.1/examples/grid/dataGrids.html\nfor details of the behavior."
],
"signature": [
"({ colindexAttribute, containerElement, event, maxAriaColindex, maxAriaRowindex, onColumnFocused, rowindexAttribute, }: { colindexAttribute: string; containerElement: HTMLDivElement | null; event: React.KeyboardEvent<Element>; maxAriaColindex: number; maxAriaRowindex: number; onColumnFocused: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnColumnFocused",
"text": "OnColumnFocused"
},
"; rowindexAttribute: string; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler.$1",
"type": "Object",
"tags": [],
"label": "{\n colindexAttribute,\n containerElement,\n event,\n maxAriaColindex,\n maxAriaRowindex,\n onColumnFocused,\n rowindexAttribute,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler.$1.event",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler.$1.maxAriaColindex",
"type": "number",
"tags": [],
"label": "maxAriaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler.$1.maxAriaRowindex",
"type": "number",
"tags": [],
"label": "maxAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler.$1.onColumnFocused",
"type": "Function",
"tags": [],
"label": "onColumnFocused",
"description": [],
"signature": [
"({ newFocusedColumn, newFocusedColumnAriaColindex, }: { newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler.$1.onColumnFocused.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "timelines",
"id": "def-common.onKeyDownFocusHandler.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp",
"type": "Function",
"tags": [],
"label": "onPageDownOrPageUp",
"description": [
"\nThis function implements `page down` and `page up` key support for the `onKeyDownFocusHandler`.\n\nSee the `Keyboard Support` section of\nhttps://www.w3.org/TR/wai-aria-practices-1.1/examples/grid/dataGrids.html\nfor details"
],
"signature": [
"({ colindexAttribute, containerElement, event, focusedAriaColindex, focusedAriaRowindex, maxAriaRowindex, onColumnFocused, rowindexAttribute, }: { colindexAttribute: string; containerElement: HTMLDivElement | null; event: React.KeyboardEvent<Element>; focusedAriaColindex: number; focusedAriaRowindex: number; maxAriaRowindex: number; onColumnFocused?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnColumnFocused",
"text": "OnColumnFocused"
},
" | undefined; rowindexAttribute: string; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp.$1",
"type": "Object",
"tags": [],
"label": "{\n colindexAttribute,\n containerElement,\n event,\n focusedAriaColindex,\n focusedAriaRowindex,\n maxAriaRowindex,\n onColumnFocused,\n rowindexAttribute,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp.$1.colindexAttribute",
"type": "string",
"tags": [],
"label": "colindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp.$1.event",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp.$1.focusedAriaColindex",
"type": "number",
"tags": [],
"label": "focusedAriaColindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp.$1.focusedAriaRowindex",
"type": "number",
"tags": [],
"label": "focusedAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp.$1.maxAriaRowindex",
"type": "number",
"tags": [],
"label": "maxAriaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp.$1.onColumnFocused",
"type": "Function",
"tags": [],
"label": "onColumnFocused",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnColumnFocused",
"text": "OnColumnFocused"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.onPageDownOrPageUp.$1.rowindexAttribute",
"type": "string",
"tags": [],
"label": "rowindexAttribute",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.skipFocusInContainerTo",
"type": "Function",
"tags": [],
"label": "skipFocusInContainerTo",
"description": [
"\nThis function has a side effect. It focuses the first element with a\nmatching `className` in the `containerElement`."
],
"signature": [
"({ containerElement, className, }: { containerElement: HTMLElement | null; className: string; }) => void | undefined"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.skipFocusInContainerTo.$1",
"type": "Object",
"tags": [],
"label": "{\n containerElement,\n className,\n}",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.skipFocusInContainerTo.$1.containerElement",
"type": "CompoundType",
"tags": [],
"label": "containerElement",
"description": [],
"signature": [
"HTMLElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.skipFocusInContainerTo.$1.className",
"type": "string",
"tags": [],
"label": "className",
"description": [],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
]
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.stopPropagationAndPreventDefault",
"type": "Function",
"tags": [],
"label": "stopPropagationAndPreventDefault",
"description": [
"\nThis function has side effects: It stops propagation of the provided\n`KeyboardEvent` and prevents the browser's default behavior."
],
"signature": [
"(event: React.KeyboardEvent<Element>) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.stopPropagationAndPreventDefault.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"React.KeyboardEvent<Element>"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps",
"type": "Interface",
"tags": [],
"label": "ActionProps",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.action",
"type": "CompoundType",
"tags": [],
"label": "action",
"description": [],
"signature": [
"((props: Pick<",
"EuiDataGridCellValueElementProps",
", \"columnId\" | \"rowIndex\">) => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: Pick<",
"EuiDataGridCellValueElementProps",
", \"columnId\" | \"rowIndex\">) => React.Component<Pick<",
"EuiDataGridCellValueElementProps",
", \"columnId\" | \"rowIndex\">, any, any>) | ((props: Pick<",
"EuiDataGridCellValueElementProps",
", \"columnId\" | \"rowIndex\">) => JSX.Element) | ((props: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ActionProps",
"text": "ActionProps"
},
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ActionProps",
"text": "ActionProps"
},
") => React.Component<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ActionProps",
"text": "ActionProps"
},
", any, any>) | ((props: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ActionProps",
"text": "ActionProps"
},
") => JSX.Element) | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.ariaRowindex",
"type": "number",
"tags": [],
"label": "ariaRowindex",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.checked",
"type": "boolean",
"tags": [],
"label": "checked",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.columnId",
"type": "string",
"tags": [],
"label": "columnId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.columnValues",
"type": "string",
"tags": [],
"label": "columnValues",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.data",
"type": "Array",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineNonEcsData",
"text": "TimelineNonEcsData"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.disabled",
"type": "CompoundType",
"tags": [],
"label": "disabled",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.ecsData",
"type": "Object",
"tags": [],
"label": "ecsData",
"description": [],
"signature": [
"Ecs"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.eventId",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.eventIdToNoteIds",
"type": "Object",
"tags": [],
"label": "eventIdToNoteIds",
"description": [],
"signature": [
"Readonly<Record<string, string[]>> | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.index",
"type": "number",
"tags": [],
"label": "index",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.isEventPinned",
"type": "CompoundType",
"tags": [],
"label": "isEventPinned",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.isEventViewer",
"type": "CompoundType",
"tags": [],
"label": "isEventViewer",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.loadingEventIds",
"type": "Object",
"tags": [],
"label": "loadingEventIds",
"description": [],
"signature": [
"readonly string[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.onEventDetailsPanelOpened",
"type": "Function",
"tags": [],
"label": "onEventDetailsPanelOpened",
"description": [],
"signature": [
"() => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.onRowSelected",
"type": "Function",
"tags": [],
"label": "onRowSelected",
"description": [],
"signature": [
"({ eventIds, isSelected, }: { eventIds: string[]; isSelected: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.onRowSelected.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ eventIds: string[]; isSelected: boolean; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.onRuleChange",
"type": "Function",
"tags": [],
"label": "onRuleChange",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.refetch",
"type": "Function",
"tags": [],
"label": "refetch",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.rowIndex",
"type": "number",
"tags": [],
"label": "rowIndex",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.setEventsDeleted",
"type": "Function",
"tags": [],
"label": "setEventsDeleted",
"description": [],
"signature": [
"(params: { eventIds: string[]; isDeleted: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.setEventsDeleted.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ eventIds: string[]; isDeleted: boolean; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.setEventsLoading",
"type": "Function",
"tags": [],
"label": "setEventsLoading",
"description": [],
"signature": [
"(params: { eventIds: string[]; isLoading: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.setEventsLoading.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ eventIds: string[]; isLoading: boolean; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.showCheckboxes",
"type": "boolean",
"tags": [],
"label": "showCheckboxes",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.showNotes",
"type": "CompoundType",
"tags": [],
"label": "showNotes",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.tabType",
"type": "CompoundType",
"tags": [],
"label": "tabType",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineTabs",
"text": "TimelineTabs"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.timelineId",
"type": "string",
"tags": [],
"label": "timelineId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.toggleShowNotes",
"type": "Function",
"tags": [],
"label": "toggleShowNotes",
"description": [],
"signature": [
"(() => void) | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.ActionProps.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BaseHit",
"type": "Interface",
"tags": [],
"label": "BaseHit",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BaseHit",
"text": "BaseHit"
},
"<T>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.BaseHit._index",
"type": "string",
"tags": [],
"label": "_index",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BaseHit._id",
"type": "string",
"tags": [],
"label": "_id",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BaseHit._source",
"type": "Uncategorized",
"tags": [],
"label": "_source",
"description": [],
"signature": [
"T"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BaseHit.fields",
"type": "Object",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"Record<string, ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SearchTypes",
"text": "SearchTypes"
},
"[]> | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField",
"type": "Interface",
"tags": [],
"label": "BrowserField",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.aggregatable",
"type": "boolean",
"tags": [],
"label": "aggregatable",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.category",
"type": "string",
"tags": [],
"label": "category",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.description",
"type": "CompoundType",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.example",
"type": "CompoundType",
"tags": [],
"label": "example",
"description": [],
"signature": [
"string | number | null"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.fields",
"type": "Object",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"{ readonly [x: string]: Partial<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.format",
"type": "string",
"tags": [],
"label": "format",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.indexes",
"type": "Array",
"tags": [],
"label": "indexes",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.searchable",
"type": "boolean",
"tags": [],
"label": "searchable",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserField.subType",
"type": "CompoundType",
"tags": [],
"label": "subType",
"description": [],
"signature": [
"IFieldSubTypeMultiOptional",
" | ",
"IFieldSubTypeNestedOptional",
" | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BulkActionsObjectProp",
"type": "Interface",
"tags": [],
"label": "BulkActionsObjectProp",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.BulkActionsObjectProp.alertStatusActions",
"type": "CompoundType",
"tags": [],
"label": "alertStatusActions",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BulkActionsObjectProp.onAlertStatusActionSuccess",
"type": "Function",
"tags": [],
"label": "onAlertStatusActionSuccess",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnUpdateAlertStatusSuccess",
"text": "OnUpdateAlertStatusSuccess"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BulkActionsObjectProp.onAlertStatusActionFailure",
"type": "Function",
"tags": [],
"label": "onAlertStatusActionFailure",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnUpdateAlertStatusError",
"text": "OnUpdateAlertStatusError"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BulkGetInput",
"type": "Interface",
"tags": [],
"label": "BulkGetInput",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.BulkGetInput.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BulkGetInput.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput",
"type": "Interface",
"tags": [],
"label": "ColumnHeaderInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.aggregatable",
"type": "CompoundType",
"tags": [],
"label": "aggregatable",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.category",
"type": "CompoundType",
"tags": [],
"label": "category",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.columnHeaderType",
"type": "CompoundType",
"tags": [],
"label": "columnHeaderType",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.description",
"type": "CompoundType",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.example",
"type": "CompoundType",
"tags": [],
"label": "example",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.indexes",
"type": "CompoundType",
"tags": [],
"label": "indexes",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.name",
"type": "CompoundType",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.placeholder",
"type": "CompoundType",
"tags": [],
"label": "placeholder",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.searchable",
"type": "CompoundType",
"tags": [],
"label": "searchable",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderInput.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult",
"type": "Interface",
"tags": [],
"label": "ColumnHeaderResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.aggregatable",
"type": "CompoundType",
"tags": [],
"label": "aggregatable",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.category",
"type": "CompoundType",
"tags": [],
"label": "category",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.columnHeaderType",
"type": "CompoundType",
"tags": [],
"label": "columnHeaderType",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.description",
"type": "CompoundType",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.example",
"type": "CompoundType",
"tags": [],
"label": "example",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.indexes",
"type": "CompoundType",
"tags": [],
"label": "indexes",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.name",
"type": "CompoundType",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.placeholder",
"type": "CompoundType",
"tags": [],
"label": "placeholder",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.searchable",
"type": "CompoundType",
"tags": [],
"label": "searchable",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderResult.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer",
"type": "Interface",
"tags": [],
"label": "ColumnRenderer",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.isInstance",
"type": "Function",
"tags": [],
"label": "isInstance",
"description": [],
"signature": [
"(columnName: string, data: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineNonEcsData",
"text": "TimelineNonEcsData"
},
"[]) => boolean"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.isInstance.$1",
"type": "string",
"tags": [],
"label": "columnName",
"description": [],
"signature": [
"string"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"isRequired": true
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.isInstance.$2",
"type": "Array",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineNonEcsData",
"text": "TimelineNonEcsData"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.renderColumn",
"type": "Function",
"tags": [],
"label": "renderColumn",
"description": [],
"signature": [
"({ columnName, eventId, field, timelineId, truncate, values, linkValues, }: { columnName: string; eventId: string; field: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderOptions",
"text": "ColumnHeaderOptions"
},
"; timelineId: string; truncate?: boolean | undefined; values: string[] | null | undefined; linkValues?: string[] | null | undefined; }) => React.ReactNode"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.renderColumn.$1",
"type": "Object",
"tags": [],
"label": "{\n columnName,\n eventId,\n field,\n timelineId,\n truncate,\n values,\n linkValues,\n }",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.renderColumn.$1.columnName",
"type": "string",
"tags": [],
"label": "columnName",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.renderColumn.$1.eventId",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.renderColumn.$1.field",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"signature": [
"Pick<",
"EuiDataGridColumn",
", \"id\" | \"schema\" | \"display\" | \"actions\" | \"defaultSortDirection\" | \"displayAsText\" | \"initialWidth\" | \"isSortable\"> & { aggregatable?: boolean | undefined; tGridCellActions?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TGridCellAction",
"text": "TGridCellAction"
},
"[] | undefined; category?: string | undefined; columnHeaderType: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderType",
"text": "ColumnHeaderType"
},
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
"IFieldSubTypeMultiOptional",
" | ",
"IFieldSubTypeNestedOptional",
" | undefined; type?: string | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.renderColumn.$1.timelineId",
"type": "string",
"tags": [],
"label": "timelineId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.renderColumn.$1.truncate",
"type": "CompoundType",
"tags": [],
"label": "truncate",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.renderColumn.$1.values",
"type": "CompoundType",
"tags": [],
"label": "values",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnRenderer.renderColumn.$1.linkValues",
"type": "CompoundType",
"tags": [],
"label": "linkValues",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.CursorType",
"type": "Interface",
"tags": [],
"label": "CursorType",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.CursorType.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.CursorType.tiebreaker",
"type": "CompoundType",
"tags": [],
"label": "tiebreaker",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProvider",
"type": "Interface",
"tags": [],
"label": "DataProvider",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.DataProvider.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"Uniquely identifies a data provider"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProvider.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"Human readable"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProvider.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [
"\nWhen `false`, a data provider is temporarily disabled, but not removed from\nthe timeline. default: `true`"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProvider.excluded",
"type": "boolean",
"tags": [],
"label": "excluded",
"description": [
"\nWhen `true`, a data provider is excluding the match, but not removed from\nthe timeline. default: `false`"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProvider.kqlQuery",
"type": "string",
"tags": [],
"label": "kqlQuery",
"description": [
"\nReturns the KQL query who have been added by user"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProvider.queryMatch",
"type": "Object",
"tags": [],
"label": "queryMatch",
"description": [
"\nReturns a query properties that, when executed, returns the data for this provider"
],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.QueryMatch",
"text": "QueryMatch"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProvider.and",
"type": "Array",
"tags": [],
"label": "and",
"description": [
"\nAdditional query clauses that are ANDed with this query to narrow results"
],
"signature": [
"Pick<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProvider",
"text": "DataProvider"
},
", \"type\" | \"id\" | \"name\" | \"enabled\" | \"excluded\" | \"kqlQuery\" | \"queryMatch\">[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProvider.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [
"\nReturns a DataProviderType"
],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderInput",
"type": "Interface",
"tags": [],
"label": "DataProviderInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderInput.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderInput.name",
"type": "CompoundType",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderInput.enabled",
"type": "CompoundType",
"tags": [],
"label": "enabled",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderInput.excluded",
"type": "CompoundType",
"tags": [],
"label": "excluded",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderInput.kqlQuery",
"type": "CompoundType",
"tags": [],
"label": "kqlQuery",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderInput.queryMatch",
"type": "CompoundType",
"tags": [],
"label": "queryMatch",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.QueryMatchInput",
"text": "QueryMatchInput"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderInput.and",
"type": "CompoundType",
"tags": [],
"label": "and",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderInput",
"text": "DataProviderInput"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderInput.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderResult",
"type": "Interface",
"tags": [],
"label": "DataProviderResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderResult.id",
"type": "CompoundType",
"tags": [],
"label": "id",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderResult.name",
"type": "CompoundType",
"tags": [],
"label": "name",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderResult.enabled",
"type": "CompoundType",
"tags": [],
"label": "enabled",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderResult.excluded",
"type": "CompoundType",
"tags": [],
"label": "excluded",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderResult.kqlQuery",
"type": "CompoundType",
"tags": [],
"label": "kqlQuery",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderResult.queryMatch",
"type": "CompoundType",
"tags": [],
"label": "queryMatch",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.QueryMatchResult",
"text": "QueryMatchResult"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderResult.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderResult.and",
"type": "CompoundType",
"tags": [],
"label": "and",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderResult",
"text": "DataProviderResult"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DateRangePickerInput",
"type": "Interface",
"tags": [],
"label": "DateRangePickerInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.DateRangePickerInput.start",
"type": "CompoundType",
"tags": [],
"label": "start",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DateRangePickerInput.end",
"type": "CompoundType",
"tags": [],
"label": "end",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DateRangePickerResult",
"type": "Interface",
"tags": [],
"label": "DateRangePickerResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.DateRangePickerResult.start",
"type": "Any",
"tags": [],
"label": "start",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DateRangePickerResult.end",
"type": "Any",
"tags": [],
"label": "end",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsData",
"type": "Interface",
"tags": [],
"label": "EqlOptionsData",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsData.keywordFields",
"type": "Array",
"tags": [],
"label": "keywordFields",
"description": [],
"signature": [
"EuiComboBoxOptionOption",
"<string | number | string[] | undefined>[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsData.dateFields",
"type": "Array",
"tags": [],
"label": "dateFields",
"description": [],
"signature": [
"EuiComboBoxOptionOption",
"<string | number | string[] | undefined>[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsData.nonDateFields",
"type": "Array",
"tags": [],
"label": "nonDateFields",
"description": [],
"signature": [
"EuiComboBoxOptionOption",
"<string | number | string[] | undefined>[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsInput",
"type": "Interface",
"tags": [],
"label": "EqlOptionsInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsInput.eventCategoryField",
"type": "CompoundType",
"tags": [],
"label": "eventCategoryField",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsInput.tiebreakerField",
"type": "CompoundType",
"tags": [],
"label": "tiebreakerField",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsInput.timestampField",
"type": "CompoundType",
"tags": [],
"label": "timestampField",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsInput.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsInput.size",
"type": "CompoundType",
"tags": [],
"label": "size",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsResult",
"type": "Interface",
"tags": [],
"label": "EqlOptionsResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsResult.eventCategoryField",
"type": "CompoundType",
"tags": [],
"label": "eventCategoryField",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsResult.tiebreakerField",
"type": "CompoundType",
"tags": [],
"label": "tiebreakerField",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsResult.timestampField",
"type": "CompoundType",
"tags": [],
"label": "timestampField",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsResult.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsResult.size",
"type": "Any",
"tags": [],
"label": "size",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsSelected",
"type": "Interface",
"tags": [],
"label": "EqlOptionsSelected",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsSelected.eventCategoryField",
"type": "string",
"tags": [],
"label": "eventCategoryField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsSelected.tiebreakerField",
"type": "string",
"tags": [],
"label": "tiebreakerField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsSelected.timestampField",
"type": "string",
"tags": [],
"label": "timestampField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsSelected.query",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlOptionsSelected.size",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlSearchResponse",
"type": "Interface",
"tags": [],
"label": "EqlSearchResponse",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.EqlSearchResponse",
"text": "EqlSearchResponse"
},
"<T>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.EqlSearchResponse.is_partial",
"type": "boolean",
"tags": [],
"label": "is_partial",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlSearchResponse.is_running",
"type": "boolean",
"tags": [],
"label": "is_running",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlSearchResponse.took",
"type": "number",
"tags": [],
"label": "took",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlSearchResponse.timed_out",
"type": "boolean",
"tags": [],
"label": "timed_out",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlSearchResponse.hits",
"type": "Object",
"tags": [],
"label": "hits",
"description": [],
"signature": [
"{ total: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TotalValue",
"text": "TotalValue"
},
"; sequences?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.EqlSequence",
"text": "EqlSequence"
},
"<T>[] | undefined; events?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BaseHit",
"text": "BaseHit"
},
"<T>[] | undefined; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlSequence",
"type": "Interface",
"tags": [],
"label": "EqlSequence",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.EqlSequence",
"text": "EqlSequence"
},
"<T>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.EqlSequence.join_keys",
"type": "Array",
"tags": [],
"label": "join_keys",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SearchTypes",
"text": "SearchTypes"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EqlSequence.events",
"type": "Array",
"tags": [],
"label": "events",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BaseHit",
"text": "BaseHit"
},
"<T>[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ErrorResponse",
"type": "Interface",
"tags": [],
"label": "ErrorResponse",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/validation/helpers.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ErrorResponse.error",
"type": "CompoundType",
"tags": [],
"label": "error",
"description": [],
"signature": [
"ErrorCause & { root_cause: ErrorCause[]; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/validation/helpers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EventHit",
"type": "Interface",
"tags": [],
"label": "EventHit",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.EventHit",
"text": "EventHit"
},
" extends ",
"SearchHit",
"<Record<string, any>>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.EventHit.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EventHit.fields",
"type": "Object",
"tags": [],
"label": "fields",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Fields",
"text": "Fields"
},
"<unknown[]>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EventSource",
"type": "Interface",
"tags": [],
"label": "EventSource",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.EventSource.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ExportedNotes",
"type": "Interface",
"tags": [],
"label": "ExportedNotes",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ExportedNotes.eventNotes",
"type": "Array",
"tags": [],
"label": "eventNotes",
"description": [],
"signature": [
"NoteSavedObject",
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ExportedNotes.globalNotes",
"type": "Array",
"tags": [],
"label": "globalNotes",
"description": [],
"signature": [
"NoteSavedObject",
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ExportTimelineNotFoundError",
"type": "Interface",
"tags": [],
"label": "ExportTimelineNotFoundError",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ExportTimelineNotFoundError.statusCode",
"type": "number",
"tags": [],
"label": "statusCode",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ExportTimelineNotFoundError.message",
"type": "string",
"tags": [],
"label": "message",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.Fields",
"type": "Interface",
"tags": [],
"label": "Fields",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Fields",
"text": "Fields"
},
"<T>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.Fields.Unnamed",
"type": "Any",
"tags": [],
"label": "Unnamed",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput",
"type": "Interface",
"tags": [],
"label": "FilterMetaTimelineInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.alias",
"type": "CompoundType",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.controlledBy",
"type": "CompoundType",
"tags": [],
"label": "controlledBy",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.disabled",
"type": "CompoundType",
"tags": [],
"label": "disabled",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.field",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.formattedValue",
"type": "CompoundType",
"tags": [],
"label": "formattedValue",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.index",
"type": "CompoundType",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.key",
"type": "CompoundType",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.negate",
"type": "CompoundType",
"tags": [],
"label": "negate",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.params",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineInput.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult",
"type": "Interface",
"tags": [],
"label": "FilterMetaTimelineResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.alias",
"type": "CompoundType",
"tags": [],
"label": "alias",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.controlledBy",
"type": "CompoundType",
"tags": [],
"label": "controlledBy",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.disabled",
"type": "CompoundType",
"tags": [],
"label": "disabled",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.field",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.formattedValue",
"type": "CompoundType",
"tags": [],
"label": "formattedValue",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.index",
"type": "CompoundType",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.key",
"type": "CompoundType",
"tags": [],
"label": "key",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.negate",
"type": "CompoundType",
"tags": [],
"label": "negate",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.params",
"type": "CompoundType",
"tags": [],
"label": "params",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.type",
"type": "CompoundType",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterMetaTimelineResult.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineInput",
"type": "Interface",
"tags": [],
"label": "FilterTimelineInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineInput.exists",
"type": "CompoundType",
"tags": [],
"label": "exists",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineInput.meta",
"type": "CompoundType",
"tags": [],
"label": "meta",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.FilterMetaTimelineInput",
"text": "FilterMetaTimelineInput"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineInput.match_all",
"type": "CompoundType",
"tags": [],
"label": "match_all",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineInput.missing",
"type": "CompoundType",
"tags": [],
"label": "missing",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineInput.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineInput.range",
"type": "CompoundType",
"tags": [],
"label": "range",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineInput.script",
"type": "CompoundType",
"tags": [],
"label": "script",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineResult",
"type": "Interface",
"tags": [],
"label": "FilterTimelineResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineResult.exists",
"type": "CompoundType",
"tags": [],
"label": "exists",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineResult.meta",
"type": "CompoundType",
"tags": [],
"label": "meta",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.FilterMetaTimelineResult",
"text": "FilterMetaTimelineResult"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineResult.match_all",
"type": "CompoundType",
"tags": [],
"label": "match_all",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineResult.missing",
"type": "CompoundType",
"tags": [],
"label": "missing",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineResult.query",
"type": "CompoundType",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineResult.range",
"type": "CompoundType",
"tags": [],
"label": "range",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FilterTimelineResult.script",
"type": "CompoundType",
"tags": [],
"label": "script",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.GetAllTimelineVariables",
"type": "Interface",
"tags": [],
"label": "GetAllTimelineVariables",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.GetAllTimelineVariables.pageInfo",
"type": "Object",
"tags": [],
"label": "pageInfo",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.PageInfoTimeline",
"text": "PageInfoTimeline"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.GetAllTimelineVariables.search",
"type": "CompoundType",
"tags": [],
"label": "search",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.GetAllTimelineVariables.sort",
"type": "CompoundType",
"tags": [],
"label": "sort",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortTimeline",
"text": "SortTimeline"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.GetAllTimelineVariables.onlyUserFavorite",
"type": "CompoundType",
"tags": [],
"label": "onlyUserFavorite",
"description": [],
"signature": [
"boolean | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.GetAllTimelineVariables.timelineType",
"type": "CompoundType",
"tags": [],
"label": "timelineType",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.GetAllTimelineVariables.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps",
"type": "Interface",
"tags": [],
"label": "HeaderActionProps",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.width",
"type": "number",
"tags": [],
"label": "width",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.browserFields",
"type": "Object",
"tags": [],
"label": "browserFields",
"description": [],
"signature": [
"{ readonly [x: string]: Partial<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.columnHeaders",
"type": "Array",
"tags": [],
"label": "columnHeaders",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderOptions",
"text": "ColumnHeaderOptions"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.isEventViewer",
"type": "CompoundType",
"tags": [],
"label": "isEventViewer",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.isSelectAllChecked",
"type": "boolean",
"tags": [],
"label": "isSelectAllChecked",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.onSelectAll",
"type": "Function",
"tags": [],
"label": "onSelectAll",
"description": [],
"signature": [
"({ isSelected }: { isSelected: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.onSelectAll.$1",
"type": "Object",
"tags": [],
"label": "{ isSelected }",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.onSelectAll.$1.isSelected",
"type": "boolean",
"tags": [],
"label": "isSelected",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
]
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.showEventsSelect",
"type": "boolean",
"tags": [],
"label": "showEventsSelect",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.showSelectAllCheckbox",
"type": "boolean",
"tags": [],
"label": "showSelectAllCheckbox",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortColumnTimeline",
"text": "SortColumnTimeline"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.tabType",
"type": "Enum",
"tags": [],
"label": "tabType",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineTabs",
"text": "TimelineTabs"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderActionProps.timelineId",
"type": "string",
"tags": [],
"label": "timelineId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField",
"type": "Interface",
"tags": [],
"label": "IndexField",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.category",
"type": "string",
"tags": [],
"label": "category",
"description": [
"Where the field belong"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.example",
"type": "CompoundType",
"tags": [],
"label": "example",
"description": [
"Example of field's value"
],
"signature": [
"string | number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.indexes",
"type": "Array",
"tags": [],
"label": "indexes",
"description": [
"whether the field's belong to an alias index"
],
"signature": [
"(string | null)[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"The name of the field"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"The type of the field's values as recognized by Kibana"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.searchable",
"type": "boolean",
"tags": [],
"label": "searchable",
"description": [
"Whether the field's values can be efficiently searched for"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.aggregatable",
"type": "boolean",
"tags": [],
"label": "aggregatable",
"description": [
"Whether the field's values can be aggregated"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.description",
"type": "CompoundType",
"tags": [],
"label": "description",
"description": [
"Description of the field"
],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.format",
"type": "CompoundType",
"tags": [],
"label": "format",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.esTypes",
"type": "Array",
"tags": [],
"label": "esTypes",
"description": [
"the elastic type as mapped in the index"
],
"signature": [
"string[] | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.subType",
"type": "CompoundType",
"tags": [],
"label": "subType",
"description": [],
"signature": [
"IFieldSubTypeMultiOptional",
" | ",
"IFieldSubTypeNestedOptional",
" | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexField.readFromDocValues",
"type": "boolean",
"tags": [],
"label": "readFromDocValues",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexFieldsStrategyRequest",
"type": "Interface",
"tags": [],
"label": "IndexFieldsStrategyRequest",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.IndexFieldsStrategyRequest",
"text": "IndexFieldsStrategyRequest"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchRequest",
"text": "IEsSearchRequest"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.IndexFieldsStrategyRequest.indices",
"type": "Array",
"tags": [],
"label": "indices",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexFieldsStrategyRequest.onlyCheckIfIndicesExist",
"type": "boolean",
"tags": [],
"label": "onlyCheckIfIndicesExist",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexFieldsStrategyResponse",
"type": "Interface",
"tags": [],
"label": "IndexFieldsStrategyResponse",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.IndexFieldsStrategyResponse",
"text": "IndexFieldsStrategyResponse"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchResponse",
"text": "IEsSearchResponse"
},
"<any>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.IndexFieldsStrategyResponse.indexFields",
"type": "Array",
"tags": [],
"label": "indexFields",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.IndexField",
"text": "IndexField"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IndexFieldsStrategyResponse.indicesExist",
"type": "Array",
"tags": [],
"label": "indicesExist",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.Inspect",
"type": "Interface",
"tags": [],
"label": "Inspect",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.Inspect.dsl",
"type": "Array",
"tags": [],
"label": "dsl",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQuery",
"type": "Interface",
"tags": [],
"label": "KueryFilterQuery",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQuery.kind",
"type": "CompoundType",
"tags": [],
"label": "kind",
"description": [],
"signature": [
"\"eql\" | \"lucene\" | \"kuery\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQuery.expression",
"type": "string",
"tags": [],
"label": "expression",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQueryInput",
"type": "Interface",
"tags": [],
"label": "KueryFilterQueryInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQueryInput.kind",
"type": "CompoundType",
"tags": [],
"label": "kind",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQueryInput.expression",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQueryResult",
"type": "Interface",
"tags": [],
"label": "KueryFilterQueryResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQueryResult.kind",
"type": "CompoundType",
"tags": [],
"label": "kind",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQueryResult.expression",
"type": "CompoundType",
"tags": [],
"label": "expression",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.LastTimeDetails",
"type": "Interface",
"tags": [],
"label": "LastTimeDetails",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.LastTimeDetails.hostName",
"type": "CompoundType",
"tags": [],
"label": "hostName",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.LastTimeDetails.ip",
"type": "CompoundType",
"tags": [],
"label": "ip",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.PageInfoTimeline",
"type": "Interface",
"tags": [],
"label": "PageInfoTimeline",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.PageInfoTimeline.pageIndex",
"type": "number",
"tags": [],
"label": "pageIndex",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.PageInfoTimeline.pageSize",
"type": "number",
"tags": [],
"label": "pageSize",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.PaginationInputPaginated",
"type": "Interface",
"tags": [],
"label": "PaginationInputPaginated",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.PaginationInputPaginated.activePage",
"type": "number",
"tags": [],
"label": "activePage",
"description": [
"The activePage parameter defines the page of results you want to fetch"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.PaginationInputPaginated.cursorStart",
"type": "number",
"tags": [],
"label": "cursorStart",
"description": [
"The cursorStart parameter defines the start of the results to be displayed"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.PaginationInputPaginated.fakePossibleCount",
"type": "number",
"tags": [],
"label": "fakePossibleCount",
"description": [
"The fakePossibleCount parameter determines the total count in order to show 5 additional pages"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.PaginationInputPaginated.querySize",
"type": "number",
"tags": [],
"label": "querySize",
"description": [
"The querySize parameter is the number of items to be returned"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatch",
"type": "Interface",
"tags": [],
"label": "QueryMatch",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatch.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatch.displayField",
"type": "string",
"tags": [],
"label": "displayField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatch.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | number"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatch.displayValue",
"type": "CompoundType",
"tags": [],
"label": "displayValue",
"description": [],
"signature": [
"string | number | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatch.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [],
"signature": [
"\":\" | \":*\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchInput",
"type": "Interface",
"tags": [],
"label": "QueryMatchInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchInput.field",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchInput.displayField",
"type": "CompoundType",
"tags": [],
"label": "displayField",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchInput.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchInput.displayValue",
"type": "CompoundType",
"tags": [],
"label": "displayValue",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchInput.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchResult",
"type": "Interface",
"tags": [],
"label": "QueryMatchResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchResult.field",
"type": "CompoundType",
"tags": [],
"label": "field",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchResult.displayField",
"type": "CompoundType",
"tags": [],
"label": "displayField",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchResult.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchResult.displayValue",
"type": "CompoundType",
"tags": [],
"label": "displayValue",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryMatchResult.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ResponseTimeline",
"type": "Interface",
"tags": [],
"label": "ResponseTimeline",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.ResponseTimeline.code",
"type": "CompoundType",
"tags": [],
"label": "code",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ResponseTimeline.message",
"type": "CompoundType",
"tags": [],
"label": "message",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ResponseTimeline.timeline",
"type": "Object",
"tags": [],
"label": "timeline",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineResult",
"text": "TimelineResult"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer",
"type": "Interface",
"tags": [],
"label": "RowRenderer",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer.id",
"type": "Enum",
"tags": [],
"label": "id",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer.isInstance",
"type": "Function",
"tags": [],
"label": "isInstance",
"description": [],
"signature": [
"(data: ",
"Ecs",
") => boolean"
],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer.isInstance.$1",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
"Ecs"
],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer.renderRow",
"type": "Function",
"tags": [],
"label": "renderRow",
"description": [],
"signature": [
"({ browserFields, data, isDraggable, timelineId, }: { browserFields: Readonly<Record<string, Partial<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">>>; data: ",
"Ecs",
"; isDraggable: boolean; timelineId: string; }) => React.ReactNode"
],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer.renderRow.$1",
"type": "Object",
"tags": [],
"label": "{\n browserFields,\n data,\n isDraggable,\n timelineId,\n }",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer.renderRow.$1.browserFields",
"type": "Object",
"tags": [],
"label": "browserFields",
"description": [],
"signature": [
"{ readonly [x: string]: Partial<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer.renderRow.$1.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [],
"signature": [
"Ecs"
],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer.renderRow.$1.isDraggable",
"type": "boolean",
"tags": [],
"label": "isDraggable",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.RowRenderer.renderRow.$1.timelineId",
"type": "string",
"tags": [],
"label": "timelineId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/rows/index.ts",
"deprecated": false
}
]
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SerializedFilterQuery",
"type": "Interface",
"tags": [],
"label": "SerializedFilterQuery",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SerializedFilterQuery.kuery",
"type": "CompoundType",
"tags": [],
"label": "kuery",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.KueryFilterQuery",
"text": "KueryFilterQuery"
},
" | null"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SerializedFilterQuery.serializedQuery",
"type": "string",
"tags": [],
"label": "serializedQuery",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SerializedFilterQueryInput",
"type": "Interface",
"tags": [],
"label": "SerializedFilterQueryInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SerializedFilterQueryInput.filterQuery",
"type": "CompoundType",
"tags": [],
"label": "filterQuery",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SerializedKueryQueryInput",
"text": "SerializedKueryQueryInput"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SerializedFilterQueryResult",
"type": "Interface",
"tags": [],
"label": "SerializedFilterQueryResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SerializedFilterQueryResult.filterQuery",
"type": "CompoundType",
"tags": [],
"label": "filterQuery",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SerializedKueryQueryResult",
"text": "SerializedKueryQueryResult"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SerializedKueryQueryInput",
"type": "Interface",
"tags": [],
"label": "SerializedKueryQueryInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SerializedKueryQueryInput.kuery",
"type": "CompoundType",
"tags": [],
"label": "kuery",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.KueryFilterQueryInput",
"text": "KueryFilterQueryInput"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SerializedKueryQueryInput.serializedQuery",
"type": "CompoundType",
"tags": [],
"label": "serializedQuery",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SerializedKueryQueryResult",
"type": "Interface",
"tags": [],
"label": "SerializedKueryQueryResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SerializedKueryQueryResult.kuery",
"type": "CompoundType",
"tags": [],
"label": "kuery",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.KueryFilterQueryResult",
"text": "KueryFilterQueryResult"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SerializedKueryQueryResult.serializedQuery",
"type": "CompoundType",
"tags": [],
"label": "serializedQuery",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortColumnTimeline",
"type": "Interface",
"tags": [],
"label": "SortColumnTimeline",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SortColumnTimeline.columnId",
"type": "string",
"tags": [],
"label": "columnId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortColumnTimeline.columnType",
"type": "string",
"tags": [],
"label": "columnType",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortColumnTimeline.sortDirection",
"type": "CompoundType",
"tags": [],
"label": "sortDirection",
"description": [],
"signature": [
"\"none\" | \"asc\" | \"desc\" | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortField",
"type": "Interface",
"tags": [],
"label": "SortField",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortField",
"text": "SortField"
},
"<Field>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SortField.field",
"type": "Uncategorized",
"tags": [],
"label": "field",
"description": [],
"signature": [
"Field"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortField.direction",
"type": "Enum",
"tags": [],
"label": "direction",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortTimeline",
"type": "Interface",
"tags": [],
"label": "SortTimeline",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SortTimeline.sortField",
"type": "Enum",
"tags": [],
"label": "sortField",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortTimeline.sortOrder",
"type": "Enum",
"tags": [],
"label": "sortOrder",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortTimelineInput",
"type": "Interface",
"tags": [],
"label": "SortTimelineInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SortTimelineInput.columnId",
"type": "CompoundType",
"tags": [],
"label": "columnId",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortTimelineInput.sortDirection",
"type": "CompoundType",
"tags": [],
"label": "sortDirection",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps",
"type": "Interface",
"tags": [],
"label": "StatusBulkActionsProps",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.eventIds",
"type": "Array",
"tags": [],
"label": "eventIds",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.currentStatus",
"type": "CompoundType",
"tags": [],
"label": "currentStatus",
"description": [],
"signature": [
"\"open\" | \"in-progress\" | \"acknowledged\" | \"closed\" | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.query",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.indexName",
"type": "string",
"tags": [],
"label": "indexName",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.setEventsLoading",
"type": "Function",
"tags": [],
"label": "setEventsLoading",
"description": [],
"signature": [
"(params: { eventIds: string[]; isLoading: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.setEventsLoading.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ eventIds: string[]; isLoading: boolean; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.setEventsDeleted",
"type": "Function",
"tags": [],
"label": "setEventsDeleted",
"description": [],
"signature": [
"(params: { eventIds: string[]; isDeleted: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.setEventsDeleted.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ eventIds: string[]; isDeleted: boolean; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
]
},
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.onUpdateSuccess",
"type": "Function",
"tags": [],
"label": "onUpdateSuccess",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnUpdateAlertStatusSuccess",
"text": "OnUpdateAlertStatusSuccess"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.onUpdateFailure",
"type": "Function",
"tags": [],
"label": "onUpdateFailure",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.OnUpdateAlertStatusError",
"text": "OnUpdateAlertStatusError"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.StatusBulkActionsProps.timelineId",
"type": "string",
"tags": [],
"label": "timelineId",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEdges",
"type": "Interface",
"tags": [],
"label": "TimelineEdges",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEdges.node",
"type": "Object",
"tags": [],
"label": "node",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineItem",
"text": "TimelineItem"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEdges.cursor",
"type": "Object",
"tags": [],
"label": "cursor",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.CursorType",
"text": "CursorType"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlRequestOptions",
"type": "Interface",
"tags": [],
"label": "TimelineEqlRequestOptions",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEqlRequestOptions",
"text": "TimelineEqlRequestOptions"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.EqlSearchStrategyRequest",
"text": "EqlSearchStrategyRequest"
},
",Pick<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsAllRequestOptions",
"text": "TimelineEventsAllRequestOptions"
},
", \"id\" | \"sort\" | \"fields\" | \"defaultIndex\" | \"timerange\" | \"language\" | \"pagination\" | \"filterQuery\" | \"docValueFields\" | \"factoryQueryType\" | \"indexType\" | \"entityType\" | \"fieldRequested\" | \"excludeEcsData\" | \"authFilter\">"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlRequestOptions.eventCategoryField",
"type": "string",
"tags": [],
"label": "eventCategoryField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlRequestOptions.tiebreakerField",
"type": "string",
"tags": [],
"label": "tiebreakerField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlRequestOptions.timestampField",
"type": "string",
"tags": [],
"label": "timestampField",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlRequestOptions.size",
"type": "number",
"tags": [],
"label": "size",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlResponse",
"type": "Interface",
"tags": [],
"label": "TimelineEqlResponse",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEqlResponse",
"text": "TimelineEqlResponse"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.EqlSearchStrategyResponse",
"text": "EqlSearchStrategyResponse"
},
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.EqlSearchResponse",
"text": "EqlSearchResponse"
},
"<unknown>>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlResponse.edges",
"type": "Array",
"tags": [],
"label": "edges",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEdges",
"text": "TimelineEdges"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlResponse.totalCount",
"type": "number",
"tags": [],
"label": "totalCount",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlResponse.pageInfo",
"type": "Object",
"tags": [],
"label": "pageInfo",
"description": [],
"signature": [
"{ activePage: number; querySize: number; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEqlResponse.inspect",
"type": "CompoundType",
"tags": [],
"label": "inspect",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Inspect",
"text": "Inspect"
},
" | null"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllRequestOptions",
"type": "Interface",
"tags": [],
"label": "TimelineEventsAllRequestOptions",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsAllRequestOptions",
"text": "TimelineEventsAllRequestOptions"
},
" extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineRequestOptionsPaginated",
"text": "TimelineRequestOptionsPaginated"
},
"<string>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllRequestOptions.fields",
"type": "CompoundType",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"string[] | { field: string; include_unmapped: boolean; }[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllRequestOptions.fieldRequested",
"type": "Array",
"tags": [],
"label": "fieldRequested",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllRequestOptions.language",
"type": "CompoundType",
"tags": [],
"label": "language",
"description": [],
"signature": [
"\"eql\" | \"lucene\" | \"kuery\""
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllRequestOptions.excludeEcsData",
"type": "CompoundType",
"tags": [],
"label": "excludeEcsData",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllRequestOptions.authFilter",
"type": "Object",
"tags": [],
"label": "authFilter",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllStrategyResponse",
"type": "Interface",
"tags": [],
"label": "TimelineEventsAllStrategyResponse",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsAllStrategyResponse",
"text": "TimelineEventsAllStrategyResponse"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchResponse",
"text": "IEsSearchResponse"
},
"<any>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllStrategyResponse.consumers",
"type": "Object",
"tags": [],
"label": "consumers",
"description": [],
"signature": [
"{ [x: string]: number; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllStrategyResponse.edges",
"type": "Array",
"tags": [],
"label": "edges",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEdges",
"text": "TimelineEdges"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllStrategyResponse.totalCount",
"type": "number",
"tags": [],
"label": "totalCount",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllStrategyResponse.pageInfo",
"type": "Object",
"tags": [],
"label": "pageInfo",
"description": [],
"signature": [
"{ activePage: number; querySize: number; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsAllStrategyResponse.inspect",
"type": "CompoundType",
"tags": [],
"label": "inspect",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Inspect",
"text": "Inspect"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsItem",
"type": "Interface",
"tags": [],
"label": "TimelineEventsDetailsItem",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsItem.ariaRowindex",
"type": "CompoundType",
"tags": [],
"label": "ariaRowindex",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsItem.category",
"type": "string",
"tags": [],
"label": "category",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsItem.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsItem.values",
"type": "CompoundType",
"tags": [],
"label": "values",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsItem.originalValue",
"type": "Any",
"tags": [],
"label": "originalValue",
"description": [],
"signature": [
"any"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsItem.isObjectArray",
"type": "boolean",
"tags": [],
"label": "isObjectArray",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsRequestOptions",
"type": "Interface",
"tags": [],
"label": "TimelineEventsDetailsRequestOptions",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsDetailsRequestOptions",
"text": "TimelineEventsDetailsRequestOptions"
},
" extends Partial<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineRequestOptionsPaginated",
"text": "TimelineRequestOptionsPaginated"
},
"<string>>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsRequestOptions.indexName",
"type": "string",
"tags": [],
"label": "indexName",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsRequestOptions.eventId",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsRequestOptions.authFilter",
"type": "Object",
"tags": [],
"label": "authFilter",
"description": [],
"signature": [
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsStrategyResponse",
"type": "Interface",
"tags": [],
"label": "TimelineEventsDetailsStrategyResponse",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsDetailsStrategyResponse",
"text": "TimelineEventsDetailsStrategyResponse"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchResponse",
"text": "IEsSearchResponse"
},
"<any>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsStrategyResponse.data",
"type": "CompoundType",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsDetailsItem",
"text": "TimelineEventsDetailsItem"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsStrategyResponse.inspect",
"type": "CompoundType",
"tags": [],
"label": "inspect",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Inspect",
"text": "Inspect"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsDetailsStrategyResponse.rawEventData",
"type": "CompoundType",
"tags": [],
"label": "rawEventData",
"description": [],
"signature": [
"object | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/details/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsLastEventTimeRequestOptions",
"type": "Interface",
"tags": [],
"label": "TimelineEventsLastEventTimeRequestOptions",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsLastEventTimeRequestOptions",
"text": "TimelineEventsLastEventTimeRequestOptions"
},
" extends Pick<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineRequestBasicOptions",
"text": "TimelineRequestBasicOptions"
},
", \"id\" | \"defaultIndex\" | \"params\" | \"docValueFields\" | \"factoryQueryType\" | \"indexType\" | \"entityType\">"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsLastEventTimeRequestOptions.indexKey",
"type": "Enum",
"tags": [],
"label": "indexKey",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.LastEventIndexKey",
"text": "LastEventIndexKey"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsLastEventTimeRequestOptions.details",
"type": "Object",
"tags": [],
"label": "details",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.LastTimeDetails",
"text": "LastTimeDetails"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsLastEventTimeStrategyResponse",
"type": "Interface",
"tags": [],
"label": "TimelineEventsLastEventTimeStrategyResponse",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsLastEventTimeStrategyResponse",
"text": "TimelineEventsLastEventTimeStrategyResponse"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchResponse",
"text": "IEsSearchResponse"
},
"<any>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsLastEventTimeStrategyResponse.lastSeen",
"type": "CompoundType",
"tags": [],
"label": "lastSeen",
"description": [],
"signature": [
"string | null"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsLastEventTimeStrategyResponse.inspect",
"type": "CompoundType",
"tags": [],
"label": "inspect",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Inspect",
"text": "Inspect"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput",
"type": "Interface",
"tags": [],
"label": "TimelineInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.columns",
"type": "CompoundType",
"tags": [],
"label": "columns",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderInput",
"text": "ColumnHeaderInput"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.dataProviders",
"type": "CompoundType",
"tags": [],
"label": "dataProviders",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderInput",
"text": "DataProviderInput"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.description",
"type": "CompoundType",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.eqlOptions",
"type": "CompoundType",
"tags": [],
"label": "eqlOptions",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.EqlOptionsInput",
"text": "EqlOptionsInput"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.eventType",
"type": "CompoundType",
"tags": [],
"label": "eventType",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.excludedRowRendererIds",
"type": "CompoundType",
"tags": [],
"label": "excludedRowRendererIds",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.filters",
"type": "CompoundType",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.FilterTimelineInput",
"text": "FilterTimelineInput"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.kqlMode",
"type": "CompoundType",
"tags": [],
"label": "kqlMode",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.kqlQuery",
"type": "CompoundType",
"tags": [],
"label": "kqlQuery",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SerializedFilterQueryInput",
"text": "SerializedFilterQueryInput"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.indexNames",
"type": "CompoundType",
"tags": [],
"label": "indexNames",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.title",
"type": "CompoundType",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.templateTimelineId",
"type": "CompoundType",
"tags": [],
"label": "templateTimelineId",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.templateTimelineVersion",
"type": "CompoundType",
"tags": [],
"label": "templateTimelineVersion",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.timelineType",
"type": "CompoundType",
"tags": [],
"label": "timelineType",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.dateRange",
"type": "CompoundType",
"tags": [],
"label": "dateRange",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DateRangePickerInput",
"text": "DateRangePickerInput"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.savedQueryId",
"type": "CompoundType",
"tags": [],
"label": "savedQueryId",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.sort",
"type": "CompoundType",
"tags": [],
"label": "sort",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortTimelineInput",
"text": "SortTimelineInput"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineInput.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineItem",
"type": "Interface",
"tags": [],
"label": "TimelineItem",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineItem._id",
"type": "string",
"tags": [],
"label": "_id",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineItem._index",
"type": "CompoundType",
"tags": [],
"label": "_index",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineItem.data",
"type": "Array",
"tags": [],
"label": "data",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineNonEcsData",
"text": "TimelineNonEcsData"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineItem.ecs",
"type": "Object",
"tags": [],
"label": "ecs",
"description": [],
"signature": [
"Ecs"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineKpiStrategyResponse",
"type": "Interface",
"tags": [],
"label": "TimelineKpiStrategyResponse",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineKpiStrategyResponse",
"text": "TimelineKpiStrategyResponse"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchResponse",
"text": "IEsSearchResponse"
},
"<any>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineKpiStrategyResponse.destinationIpCount",
"type": "number",
"tags": [],
"label": "destinationIpCount",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineKpiStrategyResponse.inspect",
"type": "CompoundType",
"tags": [],
"label": "inspect",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Inspect",
"text": "Inspect"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineKpiStrategyResponse.hostCount",
"type": "number",
"tags": [],
"label": "hostCount",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineKpiStrategyResponse.processCount",
"type": "number",
"tags": [],
"label": "processCount",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineKpiStrategyResponse.sourceIpCount",
"type": "number",
"tags": [],
"label": "sourceIpCount",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineKpiStrategyResponse.userCount",
"type": "number",
"tags": [],
"label": "userCount",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineNonEcsData",
"type": "Interface",
"tags": [],
"label": "TimelineNonEcsData",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineNonEcsData.field",
"type": "string",
"tags": [],
"label": "field",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineNonEcsData.value",
"type": "CompoundType",
"tags": [],
"label": "value",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/all/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput",
"type": "Interface",
"tags": [],
"label": "TimelinePersistInput",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.id",
"type": "string",
"tags": [],
"label": "id",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.dataProviders",
"type": "Array",
"tags": [],
"label": "dataProviders",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProvider",
"text": "DataProvider"
},
"[] | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.dateRange",
"type": "Object",
"tags": [],
"label": "dateRange",
"description": [],
"signature": [
"{ start: string; end: string; } | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.excludedRowRendererIds",
"type": "Array",
"tags": [],
"label": "excludedRowRendererIds",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.expandedDetail",
"type": "Object",
"tags": [],
"label": "expandedDetail",
"description": [],
"signature": [
"Partial<Record<string, ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineExpandedDetailType",
"text": "TimelineExpandedDetailType"
},
">> | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.filters",
"type": "Array",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.columns",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderOptions",
"text": "ColumnHeaderOptions"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.itemsPerPage",
"type": "number",
"tags": [],
"label": "itemsPerPage",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.indexNames",
"type": "Array",
"tags": [],
"label": "indexNames",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.kqlQuery",
"type": "Object",
"tags": [],
"label": "kqlQuery",
"description": [],
"signature": [
"{ filterQuery: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SerializedFilterQuery",
"text": "SerializedFilterQuery"
},
" | null; } | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.show",
"type": "CompoundType",
"tags": [],
"label": "show",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"({ columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[])[] | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.showCheckboxes",
"type": "CompoundType",
"tags": [],
"label": "showCheckboxes",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.timelineType",
"type": "CompoundType",
"tags": [],
"label": "timelineType",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.templateTimelineId",
"type": "CompoundType",
"tags": [],
"label": "templateTimelineId",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelinePersistInput.templateTimelineVersion",
"type": "CompoundType",
"tags": [],
"label": "templateTimelineVersion",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestBasicOptions",
"type": "Interface",
"tags": [],
"label": "TimelineRequestBasicOptions",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineRequestBasicOptions",
"text": "TimelineRequestBasicOptions"
},
" extends ",
{
"pluginId": "data",
"scope": "common",
"docId": "kibDataSearchPluginApi",
"section": "def-common.IEsSearchRequest",
"text": "IEsSearchRequest"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestBasicOptions.timerange",
"type": "Object",
"tags": [],
"label": "timerange",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimerangeInput",
"text": "TimerangeInput"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestBasicOptions.filterQuery",
"type": "CompoundType",
"tags": [],
"label": "filterQuery",
"description": [],
"signature": [
"string | ",
{
"pluginId": "@kbn/utility-types",
"scope": "server",
"docId": "kibKbnUtilityTypesPluginApi",
"section": "def-server.JsonObject",
"text": "JsonObject"
},
" | ",
"ESRangeQuery",
" | ",
"ESQueryStringQuery",
" | ",
"ESMatchQuery",
" | ",
"ESTermQuery",
" | ",
"ESBoolQuery",
" | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestBasicOptions.defaultIndex",
"type": "Array",
"tags": [],
"label": "defaultIndex",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestBasicOptions.docValueFields",
"type": "Array",
"tags": [],
"label": "docValueFields",
"description": [],
"signature": [
"SearchDocValueField",
"[] | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestBasicOptions.factoryQueryType",
"type": "CompoundType",
"tags": [],
"label": "factoryQueryType",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
},
" | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestBasicOptions.entityType",
"type": "CompoundType",
"tags": [],
"label": "entityType",
"description": [],
"signature": [
"\"alerts\" | \"events\" | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestOptionsPaginated",
"type": "Interface",
"tags": [],
"label": "TimelineRequestOptionsPaginated",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineRequestOptionsPaginated",
"text": "TimelineRequestOptionsPaginated"
},
"<Field> extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineRequestBasicOptions",
"text": "TimelineRequestBasicOptions"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestOptionsPaginated.pagination",
"type": "Object",
"tags": [],
"label": "pagination",
"description": [],
"signature": [
"{ activePage: number; querySize: number; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestOptionsPaginated.sort",
"type": "Array",
"tags": [],
"label": "sort",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineRequestSortField",
"text": "TimelineRequestSortField"
},
"<Field>[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestSortField",
"type": "Interface",
"tags": [],
"label": "TimelineRequestSortField",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineRequestSortField",
"text": "TimelineRequestSortField"
},
"<Field> extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortField",
"text": "SortField"
},
"<Field>"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineRequestSortField.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult",
"type": "Interface",
"tags": [],
"label": "TimelineResult",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.columns",
"type": "CompoundType",
"tags": [],
"label": "columns",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderResult",
"text": "ColumnHeaderResult"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.created",
"type": "CompoundType",
"tags": [],
"label": "created",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.createdBy",
"type": "CompoundType",
"tags": [],
"label": "createdBy",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.dataProviders",
"type": "CompoundType",
"tags": [],
"label": "dataProviders",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderResult",
"text": "DataProviderResult"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.dateRange",
"type": "CompoundType",
"tags": [],
"label": "dateRange",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DateRangePickerResult",
"text": "DateRangePickerResult"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.description",
"type": "CompoundType",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.eqlOptions",
"type": "CompoundType",
"tags": [],
"label": "eqlOptions",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.EqlOptionsResult",
"text": "EqlOptionsResult"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.eventIdToNoteIds",
"type": "CompoundType",
"tags": [],
"label": "eventIdToNoteIds",
"description": [],
"signature": [
"NoteResult",
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.eventType",
"type": "CompoundType",
"tags": [],
"label": "eventType",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.excludedRowRendererIds",
"type": "CompoundType",
"tags": [],
"label": "excludedRowRendererIds",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.favorite",
"type": "CompoundType",
"tags": [],
"label": "favorite",
"description": [],
"signature": [
"{ fullName?: string | null | undefined; userName?: string | null | undefined; favoriteDate?: number | null | undefined; }[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.filters",
"type": "CompoundType",
"tags": [],
"label": "filters",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.FilterTimelineResult",
"text": "FilterTimelineResult"
},
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.kqlMode",
"type": "CompoundType",
"tags": [],
"label": "kqlMode",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.kqlQuery",
"type": "CompoundType",
"tags": [],
"label": "kqlQuery",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SerializedFilterQueryResult",
"text": "SerializedFilterQueryResult"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.indexNames",
"type": "CompoundType",
"tags": [],
"label": "indexNames",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.notes",
"type": "CompoundType",
"tags": [],
"label": "notes",
"description": [],
"signature": [
"NoteResult",
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.noteIds",
"type": "CompoundType",
"tags": [],
"label": "noteIds",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.pinnedEventIds",
"type": "CompoundType",
"tags": [],
"label": "pinnedEventIds",
"description": [],
"signature": [
"string[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.pinnedEventsSaveObject",
"type": "CompoundType",
"tags": [],
"label": "pinnedEventsSaveObject",
"description": [],
"signature": [
"PinnedEvent",
"[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.savedQueryId",
"type": "CompoundType",
"tags": [],
"label": "savedQueryId",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.savedObjectId",
"type": "string",
"tags": [],
"label": "savedObjectId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.sort",
"type": "CompoundType",
"tags": [],
"label": "sort",
"description": [],
"signature": [
"{ columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.status",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.title",
"type": "CompoundType",
"tags": [],
"label": "title",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.templateTimelineId",
"type": "CompoundType",
"tags": [],
"label": "templateTimelineId",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.templateTimelineVersion",
"type": "CompoundType",
"tags": [],
"label": "templateTimelineVersion",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.timelineType",
"type": "CompoundType",
"tags": [],
"label": "timelineType",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.updated",
"type": "CompoundType",
"tags": [],
"label": "updated",
"description": [],
"signature": [
"number | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.updatedBy",
"type": "CompoundType",
"tags": [],
"label": "updatedBy",
"description": [],
"signature": [
"string | null | undefined"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResult.version",
"type": "string",
"tags": [],
"label": "version",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimerangeFilter",
"type": "Interface",
"tags": [],
"label": "TimerangeFilter",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimerangeFilter.range",
"type": "Object",
"tags": [],
"label": "range",
"description": [],
"signature": [
"{ [timestamp: string]: { gte: string; lte: string; format: string; }; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimerangeInput",
"type": "Interface",
"tags": [],
"label": "TimerangeInput",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TimerangeInput.interval",
"type": "string",
"tags": [],
"label": "interval",
"description": [
"The interval string to use for last bucket. The format is '{value}{unit}'. For example '5m' would return the metrics for the last 5 minutes of the timespan."
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimerangeInput.to",
"type": "string",
"tags": [],
"label": "to",
"description": [
"The end of the timerange"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimerangeInput.from",
"type": "string",
"tags": [],
"label": "from",
"description": [
"The beginning of the timerange"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TotalValue",
"type": "Interface",
"tags": [],
"label": "TotalValue",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TotalValue.value",
"type": "number",
"tags": [],
"label": "value",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TotalValue.relation",
"type": "string",
"tags": [],
"label": "relation",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
}
],
"enums": [
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderType",
"type": "Enum",
"tags": [],
"label": "DataProviderType",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.Direction",
"type": "Enum",
"tags": [],
"label": "Direction",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FlowDirection",
"type": "Enum",
"tags": [],
"label": "FlowDirection",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.LastEventIndexKey",
"type": "Enum",
"tags": [],
"label": "LastEventIndexKey",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/last_event_time/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.RowRendererId",
"type": "Enum",
"tags": [],
"label": "RowRendererId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortFieldTimeline",
"type": "Enum",
"tags": [],
"label": "SortFieldTimeline",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TemplateTimelineType",
"type": "Enum",
"tags": [],
"label": "TemplateTimelineType",
"description": [
"\nTimeline template type"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsQueries",
"type": "Enum",
"tags": [],
"label": "TimelineEventsQueries",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineId",
"type": "Enum",
"tags": [],
"label": "TimelineId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineStatus",
"type": "Enum",
"tags": [],
"label": "TimelineStatus",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineTabs",
"type": "Enum",
"tags": [],
"label": "TimelineTabs",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineType",
"type": "Enum",
"tags": [],
"label": "TimelineType",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"misc": [
{
"parentPluginId": "timelines",
"id": "def-common.AlertStatus",
"type": "Type",
"tags": [],
"label": "AlertStatus",
"description": [],
"signature": [
"\"open\" | \"in-progress\" | \"acknowledged\" | \"closed\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.AlertWorkflowStatus",
"type": "Type",
"tags": [],
"label": "AlertWorkflowStatus",
"description": [],
"signature": [
"\"open\" | \"acknowledged\" | \"closed\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.AllTimelineSavedObject",
"type": "Type",
"tags": [],
"label": "AllTimelineSavedObject",
"description": [],
"signature": [
"{ total: number; data: { columns?: { aggregatable?: boolean | null | undefined; category?: string | null | undefined; columnHeaderType?: string | null | undefined; description?: string | null | undefined; example?: string | null | undefined; indexes?: string[] | null | undefined; id?: string | null | undefined; name?: string | null | undefined; placeholder?: string | null | undefined; searchable?: boolean | null | undefined; type?: string | null | undefined; }[] | null | undefined; dataProviders?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; and?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; }[] | null | undefined; type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined; }[] | null | undefined; description?: string | null | undefined; eqlOptions?: { eventCategoryField?: string | null | undefined; query?: string | null | undefined; tiebreakerField?: string | null | undefined; timestampField?: string | null | undefined; size?: string | number | null | undefined; } | null | undefined; eventType?: string | null | undefined; excludedRowRendererIds?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined; favorite?: { keySearch?: string | null | undefined; favoriteDate?: number | null | undefined; fullName?: string | null | undefined; userName?: string | null | undefined; }[] | null | undefined; filters?: { exists?: string | null | undefined; meta?: { alias?: string | null | undefined; controlledBy?: string | null | undefined; disabled?: boolean | null | undefined; field?: string | null | undefined; formattedValue?: string | null | undefined; index?: string | null | undefined; key?: string | null | undefined; negate?: boolean | null | undefined; params?: string | null | undefined; type?: string | null | undefined; value?: string | null | undefined; } | null | undefined; match_all?: string | null | undefined; missing?: string | null | undefined; query?: string | null | undefined; range?: string | null | undefined; script?: string | null | undefined; }[] | null | undefined; indexNames?: string[] | null | undefined; kqlMode?: string | null | undefined; kqlQuery?: { filterQuery?: { kuery?: { kind?: string | null | undefined; expression?: string | null | undefined; } | null | undefined; serializedQuery?: string | null | undefined; } | null | undefined; } | null | undefined; title?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; dateRange?: { start?: string | number | null | undefined; end?: string | number | null | undefined; } | null | undefined; savedQueryId?: string | null | undefined; sort?: { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { savedObjectId: string; version: string; } & { eventIdToNoteIds?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; noteIds?: string[] | undefined; notes?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; pinnedEventIds?: string[] | undefined; pinnedEventsSaveObject?: ({ pinnedEventId: string; version: string; } & { timelineId: string; eventId: string; } & { created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { timelineVersion?: string | null | undefined; })[] | undefined; }; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.AllTimelinesResponse",
"type": "Type",
"tags": [],
"label": "AllTimelinesResponse",
"description": [],
"signature": [
"{ timeline: ({ columns?: { aggregatable?: boolean | null | undefined; category?: string | null | undefined; columnHeaderType?: string | null | undefined; description?: string | null | undefined; example?: string | null | undefined; indexes?: string[] | null | undefined; id?: string | null | undefined; name?: string | null | undefined; placeholder?: string | null | undefined; searchable?: boolean | null | undefined; type?: string | null | undefined; }[] | null | undefined; dataProviders?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; and?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; }[] | null | undefined; type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined; }[] | null | undefined; description?: string | null | undefined; eqlOptions?: { eventCategoryField?: string | null | undefined; query?: string | null | undefined; tiebreakerField?: string | null | undefined; timestampField?: string | null | undefined; size?: string | number | null | undefined; } | null | undefined; eventType?: string | null | undefined; excludedRowRendererIds?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined; favorite?: { keySearch?: string | null | undefined; favoriteDate?: number | null | undefined; fullName?: string | null | undefined; userName?: string | null | undefined; }[] | null | undefined; filters?: { exists?: string | null | undefined; meta?: { alias?: string | null | undefined; controlledBy?: string | null | undefined; disabled?: boolean | null | undefined; field?: string | null | undefined; formattedValue?: string | null | undefined; index?: string | null | undefined; key?: string | null | undefined; negate?: boolean | null | undefined; params?: string | null | undefined; type?: string | null | undefined; value?: string | null | undefined; } | null | undefined; match_all?: string | null | undefined; missing?: string | null | undefined; query?: string | null | undefined; range?: string | null | undefined; script?: string | null | undefined; }[] | null | undefined; indexNames?: string[] | null | undefined; kqlMode?: string | null | undefined; kqlQuery?: { filterQuery?: { kuery?: { kind?: string | null | undefined; expression?: string | null | undefined; } | null | undefined; serializedQuery?: string | null | undefined; } | null | undefined; } | null | undefined; title?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; dateRange?: { start?: string | number | null | undefined; end?: string | number | null | undefined; } | null | undefined; savedQueryId?: string | null | undefined; sort?: { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { savedObjectId: string; version: string; } & { eventIdToNoteIds?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; noteIds?: string[] | undefined; notes?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; pinnedEventIds?: string[] | undefined; pinnedEventsSaveObject?: ({ pinnedEventId: string; version: string; } & { timelineId: string; eventId: string; } & { created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { timelineVersion?: string | null | undefined; })[] | undefined; })[]; totalCount: number; } & { defaultTimelineCount: number; templateTimelineCount: number; elasticTemplateTimelineCount: number; customTemplateTimelineCount: number; favoriteCount: number; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ARIA_COLINDEX_ATTRIBUTE",
"type": "string",
"tags": [],
"label": "ARIA_COLINDEX_ATTRIBUTE",
"description": [
"\nThe name of the ARIA attribute representing a column, used in conjunction with\nthe ARIA: grid role https://www.w3.org/TR/wai-aria-practices-1.1/examples/grid/dataGrids.html"
],
"signature": [
"\"aria-colindex\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ARIA_ROWINDEX_ATTRIBUTE",
"type": "string",
"tags": [],
"label": "ARIA_ROWINDEX_ATTRIBUTE",
"description": [
"\nThe name of the ARIA attribute representing a row, used in conjunction with\nthe ARIA: grid role https://www.w3.org/TR/wai-aria-practices-1.1/examples/grid/dataGrids.html"
],
"signature": [
"\"aria-rowindex\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BeatFields",
"type": "Type",
"tags": [],
"label": "BeatFields",
"description": [],
"signature": [
"{ [x: string]: FieldInfo; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BeatFieldsFactoryQueryType",
"type": "Type",
"tags": [],
"label": "BeatFieldsFactoryQueryType",
"description": [],
"signature": [
"\"beatFields\""
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BrowserFields",
"type": "Type",
"tags": [],
"label": "BrowserFields",
"description": [],
"signature": [
"{ readonly [x: string]: Partial<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.BulkActionsProp",
"type": "Type",
"tags": [],
"label": "BulkActionsProp",
"description": [],
"signature": [
"boolean | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BulkActionsObjectProp",
"text": "BulkActionsObjectProp"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.CellValueElementProps",
"type": "Type",
"tags": [],
"label": "CellValueElementProps",
"description": [
"The following props are provided to the function called by `renderCellValue`"
],
"signature": [
"EuiDataGridCellValueElementProps",
" & { asPlainText?: boolean | undefined; browserFields?: Readonly<Record<string, Partial<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">>> | undefined; data: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineNonEcsData",
"text": "TimelineNonEcsData"
},
"[]; ecsData?: ",
"Ecs",
" | undefined; eventId: string; globalFilters?: ",
{
"pluginId": "@kbn/es-query",
"scope": "common",
"docId": "kibKbnEsQueryPluginApi",
"section": "def-common.Filter",
"text": "Filter"
},
"[] | undefined; header: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderOptions",
"text": "ColumnHeaderOptions"
},
"; isDraggable: boolean; linkValues: string[] | undefined; rowRenderers?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRenderer",
"text": "RowRenderer"
},
"[] | undefined; setFlyoutAlert?: ((data: any) => void) | undefined; timelineId: string; truncate?: boolean | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/cells/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderOptions",
"type": "Type",
"tags": [],
"label": "ColumnHeaderOptions",
"description": [
"The specification of a column header"
],
"signature": [
"Pick<",
"EuiDataGridColumn",
", \"id\" | \"schema\" | \"display\" | \"actions\" | \"defaultSortDirection\" | \"displayAsText\" | \"initialWidth\" | \"isSortable\"> & { aggregatable?: boolean | undefined; tGridCellActions?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TGridCellAction",
"text": "TGridCellAction"
},
"[] | undefined; category?: string | undefined; columnHeaderType: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderType",
"text": "ColumnHeaderType"
},
"; description?: string | undefined; example?: string | undefined; format?: string | undefined; linkField?: string | undefined; placeholder?: string | undefined; subType?: ",
"IFieldSubTypeMultiOptional",
" | ",
"IFieldSubTypeNestedOptional",
" | undefined; type?: string | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnHeaderType",
"type": "Type",
"tags": [],
"label": "ColumnHeaderType",
"description": [],
"signature": [
"\"not-filtered\" | \"text-filter\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ColumnId",
"type": "Type",
"tags": [],
"label": "ColumnId",
"description": [
"Uniquely identifies a column"
],
"signature": [
"string"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ControlColumnProps",
"type": "Type",
"tags": [],
"label": "ControlColumnProps",
"description": [],
"signature": [
"Pick<",
"EuiDataGridControlColumn",
", never> & Partial<AdditionalControlColumnProps>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DATA_COLINDEX_ATTRIBUTE",
"type": "string",
"tags": [],
"label": "DATA_COLINDEX_ATTRIBUTE",
"description": [
"\nThis alternative attribute to `aria-colindex` is used to decorate the data\nin existing `EuiTable`s to enable keyboard navigation with minimal\nrefactoring of existing code until we're ready to migrate to `EuiDataGrid`.\nIt may be applied directly to keyboard-focusable elements and thus doesn't\nhave exactly the same semantics as `aria-colindex`."
],
"signature": [
"\"data-colindex\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DATA_ROWINDEX_ATTRIBUTE",
"type": "string",
"tags": [],
"label": "DATA_ROWINDEX_ATTRIBUTE",
"description": [
"\nThis alternative attribute to `aria-rowindex` is used to decorate the data\nin existing `EuiTable`s to enable keyboard navigation with minimal\nrefactoring of existing code until we're ready to migrate to `EuiDataGrid`.\nIt's typically applied to `<tr>` elements via `EuiTable`'s `rowProps` prop."
],
"signature": [
"\"data-rowindex\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProvidersAnd",
"type": "Type",
"tags": [],
"label": "DataProvidersAnd",
"description": [],
"signature": [
"{ type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | undefined; id: string; name: string; enabled: boolean; excluded: boolean; kqlQuery: string; queryMatch: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.QueryMatch",
"text": "QueryMatch"
},
"; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DocValueFields",
"type": "Type",
"tags": [],
"label": "DocValueFields",
"description": [],
"signature": [
"SearchDocValueField"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EMPTY_DOCVALUE_FIELD",
"type": "Array",
"tags": [],
"label": "EMPTY_DOCVALUE_FIELD",
"description": [],
"signature": [
"SearchDocValueField",
"[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EntityType",
"type": "Type",
"tags": [],
"label": "EntityType",
"description": [],
"signature": [
"\"alerts\" | \"events\""
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ErrorSchema",
"type": "Type",
"tags": [],
"label": "ErrorSchema",
"description": [],
"signature": [
"{ error: { status_code: number; message: string; }; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EXISTS_OPERATOR",
"type": "string",
"tags": [],
"label": "EXISTS_OPERATOR",
"description": [
"The `exists` operator in a KQL query"
],
"signature": [
"\":*\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ExportedEventNotes",
"type": "Type",
"tags": [],
"label": "ExportedEventNotes",
"description": [],
"signature": [
"NoteSavedObject",
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ExportedGlobalNotes",
"type": "Type",
"tags": [],
"label": "ExportedGlobalNotes",
"description": [
"\nImport/export timelines"
],
"signature": [
"NoteSavedObject",
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ExportedTimelines",
"type": "Type",
"tags": [],
"label": "ExportedTimelines",
"description": [],
"signature": [
"{ columns?: { aggregatable?: boolean | null | undefined; category?: string | null | undefined; columnHeaderType?: string | null | undefined; description?: string | null | undefined; example?: string | null | undefined; indexes?: string[] | null | undefined; id?: string | null | undefined; name?: string | null | undefined; placeholder?: string | null | undefined; searchable?: boolean | null | undefined; type?: string | null | undefined; }[] | null | undefined; dataProviders?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; and?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; }[] | null | undefined; type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined; }[] | null | undefined; description?: string | null | undefined; eqlOptions?: { eventCategoryField?: string | null | undefined; query?: string | null | undefined; tiebreakerField?: string | null | undefined; timestampField?: string | null | undefined; size?: string | number | null | undefined; } | null | undefined; eventType?: string | null | undefined; excludedRowRendererIds?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined; favorite?: { keySearch?: string | null | undefined; favoriteDate?: number | null | undefined; fullName?: string | null | undefined; userName?: string | null | undefined; }[] | null | undefined; filters?: { exists?: string | null | undefined; meta?: { alias?: string | null | undefined; controlledBy?: string | null | undefined; disabled?: boolean | null | undefined; field?: string | null | undefined; formattedValue?: string | null | undefined; index?: string | null | undefined; key?: string | null | undefined; negate?: boolean | null | undefined; params?: string | null | undefined; type?: string | null | undefined; value?: string | null | undefined; } | null | undefined; match_all?: string | null | undefined; missing?: string | null | undefined; query?: string | null | undefined; range?: string | null | undefined; script?: string | null | undefined; }[] | null | undefined; indexNames?: string[] | null | undefined; kqlMode?: string | null | undefined; kqlQuery?: { filterQuery?: { kuery?: { kind?: string | null | undefined; expression?: string | null | undefined; } | null | undefined; serializedQuery?: string | null | undefined; } | null | undefined; } | null | undefined; title?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; dateRange?: { start?: string | number | null | undefined; end?: string | number | null | undefined; } | null | undefined; savedQueryId?: string | null | undefined; sort?: { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { savedObjectId: string; version: string; } & { eventIdToNoteIds?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; noteIds?: string[] | undefined; notes?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; pinnedEventIds?: string[] | undefined; pinnedEventsSaveObject?: ({ pinnedEventId: string; version: string; } & { timelineId: string; eventId: string; } & { created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { timelineVersion?: string | null | undefined; })[] | undefined; } & ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ExportedNotes",
"text": "ExportedNotes"
},
" & { pinnedEventIds: string[]; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FavoriteTimelineResult",
"type": "Type",
"tags": [],
"label": "FavoriteTimelineResult",
"description": [],
"signature": [
"{ fullName?: string | null | undefined; userName?: string | null | undefined; favoriteDate?: number | null | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FieldsEqlOptions",
"type": "Type",
"tags": [],
"label": "FieldsEqlOptions",
"description": [],
"signature": [
"\"query\" | \"size\" | \"eventCategoryField\" | \"tiebreakerField\" | \"timestampField\""
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/eql/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FIRST_ARIA_INDEX",
"type": "number",
"tags": [],
"label": "FIRST_ARIA_INDEX",
"description": [
"`aria-colindex` and `aria-rowindex` start at one"
],
"signature": [
"1"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.FocusableElement",
"type": "Type",
"tags": [],
"label": "FocusableElement",
"description": [],
"signature": [
"HTMLDivElement | HTMLButtonElement | HTMLInputElement | HTMLAnchorElement | HTMLFormElement | HTMLAudioElement | HTMLAreaElement | HTMLSelectElement | HTMLTextAreaElement | HTMLVideoElement"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.GenericActionRowCellRenderProps",
"type": "Type",
"tags": [],
"label": "GenericActionRowCellRenderProps",
"description": [],
"signature": [
"{ columnId: string; rowIndex: number; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.GetFocusedCell",
"type": "Type",
"tags": [],
"label": "GetFocusedCell",
"description": [],
"signature": [
"({ containerElement, tableClassName, }: { containerElement: HTMLElement | null; tableClassName: string; }) => HTMLDivElement | null"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.GetFocusedCell.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ containerElement: HTMLElement | null; tableClassName: string; }"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.GetTimelinesArgs",
"type": "Type",
"tags": [],
"label": "GetTimelinesArgs",
"description": [],
"signature": [
"{ onlyUserFavorite?: boolean | null | undefined; pageInfo?: { pageIndex: number; pageSize: number; } | null | undefined; search?: string | null | undefined; sort?: { sortField: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
"; sortOrder: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
},
"; } | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.HeaderCellRender",
"type": "Type",
"tags": [],
"label": "HeaderCellRender",
"description": [],
"signature": [
"React.ComponentClass<{}, any> | React.FunctionComponent<{}> | React.ComponentClass<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.HeaderActionProps",
"text": "HeaderActionProps"
},
", any> | React.FunctionComponent<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.HeaderActionProps",
"text": "HeaderActionProps"
},
">"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ImportTimelineResultSchema",
"type": "Type",
"tags": [],
"label": "ImportTimelineResultSchema",
"description": [],
"signature": [
"{ success: boolean; success_count: number; timelines_installed: number; timelines_updated: number; errors: { error: { status_code: number; message: string; }; }[]; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.InProgressStatus",
"type": "Type",
"tags": [
"deprecated"
],
"label": "InProgressStatus",
"description": [],
"signature": [
"\"in-progress\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": true,
"references": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.IS_OPERATOR",
"type": "string",
"tags": [],
"label": "IS_OPERATOR",
"description": [
"Represents the Timeline data providers\nThe `is` operator in a KQL query"
],
"signature": [
"\":\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.KueryFilterQueryKind",
"type": "Type",
"tags": [],
"label": "KueryFilterQueryKind",
"description": [],
"signature": [
"\"eql\" | \"lucene\" | \"kuery\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.Maybe",
"type": "Type",
"tags": [],
"label": "Maybe",
"description": [],
"signature": [
"T | null"
],
"path": "x-pack/plugins/timelines/common/search_strategy/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.NotesAndPinnedEventsByTimelineId",
"type": "Type",
"tags": [],
"label": "NotesAndPinnedEventsByTimelineId",
"description": [],
"signature": [
"{ [x: string]: { notes: ",
"NoteSavedObject",
"[]; pinnedEvents: ",
"PinnedEventSavedObject",
"[]; }; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnChangePage",
"type": "Type",
"tags": [],
"label": "OnChangePage",
"description": [
"Invoked when a user clicks to load more item"
],
"signature": [
"(nextPage: number) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnChangePage.$1",
"type": "number",
"tags": [],
"label": "nextPage",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnFocused",
"type": "Type",
"tags": [],
"label": "OnColumnFocused",
"description": [],
"signature": [
"({ newFocusedColumn, newFocusedColumnAriaColindex, }: { newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }) => void"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnFocused.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ newFocusedColumn: HTMLDivElement | null; newFocusedColumnAriaColindex: number | null; }"
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnRemoved",
"type": "Type",
"tags": [],
"label": "OnColumnRemoved",
"description": [],
"signature": [
"(columnId: string) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnRemoved.$1",
"type": "string",
"tags": [],
"label": "columnId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnResized",
"type": "Type",
"tags": [],
"label": "OnColumnResized",
"description": [],
"signature": [
"({ columnId, delta }: { columnId: string; delta: number; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnResized.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ columnId: string; delta: number; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnSorted",
"type": "Type",
"tags": [],
"label": "OnColumnSorted",
"description": [
"Invoked when a column is sorted"
],
"signature": [
"(sorted: { columnId: string; sortDirection: ",
{
"pluginId": "securitySolution",
"scope": "common",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-common.SortDirection",
"text": "SortDirection"
},
"; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnSorted.$1",
"type": "Object",
"tags": [],
"label": "sorted",
"description": [],
"signature": [
"{ columnId: string; sortDirection: ",
{
"pluginId": "securitySolution",
"scope": "common",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-common.SortDirection",
"text": "SortDirection"
},
"; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnsSorted",
"type": "Type",
"tags": [],
"label": "OnColumnsSorted",
"description": [],
"signature": [
"(sorted: { columnId: string; sortDirection: ",
{
"pluginId": "securitySolution",
"scope": "common",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-common.SortDirection",
"text": "SortDirection"
},
"; }[]) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnColumnsSorted.$1",
"type": "Array",
"tags": [],
"label": "sorted",
"description": [],
"signature": [
"{ columnId: string; sortDirection: ",
{
"pluginId": "securitySolution",
"scope": "common",
"docId": "kibSecuritySolutionPluginApi",
"section": "def-common.SortDirection",
"text": "SortDirection"
},
"; }[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnPinEvent",
"type": "Type",
"tags": [],
"label": "OnPinEvent",
"description": [
"Invoked when a user pins an event"
],
"signature": [
"(eventId: string) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnPinEvent.$1",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnRowSelected",
"type": "Type",
"tags": [],
"label": "OnRowSelected",
"description": [
"Invoked when a user checks/un-checks a row"
],
"signature": [
"({ eventIds, isSelected, }: { eventIds: string[]; isSelected: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnRowSelected.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ eventIds: string[]; isSelected: boolean; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnSelectAll",
"type": "Type",
"tags": [],
"label": "OnSelectAll",
"description": [
"Invoked when a user checks/un-checks the select all checkbox"
],
"signature": [
"({ isSelected }: { isSelected: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnSelectAll.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ isSelected: boolean; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnUnPinEvent",
"type": "Type",
"tags": [],
"label": "OnUnPinEvent",
"description": [
"Invoked when a user unpins an event"
],
"signature": [
"(eventId: string) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnUnPinEvent.$1",
"type": "string",
"tags": [],
"label": "eventId",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnUpdateAlertStatusError",
"type": "Type",
"tags": [],
"label": "OnUpdateAlertStatusError",
"description": [],
"signature": [
"(status: ",
{
"pluginId": "@kbn/rule-data-utils",
"scope": "server",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-server.STATUS_VALUES",
"text": "STATUS_VALUES"
},
", error: Error) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnUpdateAlertStatusError.$1",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"\"open\" | \"in-progress\" | \"acknowledged\" | \"closed\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnUpdateAlertStatusError.$2",
"type": "Object",
"tags": [],
"label": "error",
"description": [],
"signature": [
"Error"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnUpdateAlertStatusSuccess",
"type": "Type",
"tags": [],
"label": "OnUpdateAlertStatusSuccess",
"description": [],
"signature": [
"(updated: number, conflicts: number, status: ",
{
"pluginId": "@kbn/rule-data-utils",
"scope": "server",
"docId": "kibKbnRuleDataUtilsPluginApi",
"section": "def-server.STATUS_VALUES",
"text": "STATUS_VALUES"
},
") => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnUpdateAlertStatusSuccess.$1",
"type": "number",
"tags": [],
"label": "updated",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnUpdateAlertStatusSuccess.$2",
"type": "number",
"tags": [],
"label": "conflicts",
"description": [],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnUpdateAlertStatusSuccess.$3",
"type": "CompoundType",
"tags": [],
"label": "status",
"description": [],
"signature": [
"\"open\" | \"in-progress\" | \"acknowledged\" | \"closed\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.OnUpdateColumns",
"type": "Type",
"tags": [],
"label": "OnUpdateColumns",
"description": [
"Invoked when columns are updated"
],
"signature": [
"(columns: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderOptions",
"text": "ColumnHeaderOptions"
},
"[]) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.OnUpdateColumns.$1",
"type": "Array",
"tags": [],
"label": "columns",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderOptions",
"text": "ColumnHeaderOptions"
},
"[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.PLUGIN_ID",
"type": "string",
"tags": [],
"label": "PLUGIN_ID",
"description": [],
"signature": [
"\"timelines\""
],
"path": "x-pack/plugins/timelines/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.PLUGIN_NAME",
"type": "string",
"tags": [],
"label": "PLUGIN_NAME",
"description": [],
"signature": [
"\"timelines\""
],
"path": "x-pack/plugins/timelines/common/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.QueryOperator",
"type": "Type",
"tags": [],
"label": "QueryOperator",
"description": [
"The operator applied to a field"
],
"signature": [
"\":\" | \":*\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/data_provider/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ResponseFavoriteTimeline",
"type": "Type",
"tags": [],
"label": "ResponseFavoriteTimeline",
"description": [],
"signature": [
"{ savedObjectId?: string | undefined; version?: string | undefined; code?: number | null | undefined; message?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; favorite?: { fullName?: string | null | undefined; userName?: string | null | undefined; favoriteDate?: number | null | undefined; }[] | null | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ResponseTimelines",
"type": "Type",
"tags": [],
"label": "ResponseTimelines",
"description": [],
"signature": [
"{ timeline: ({ columns?: { aggregatable?: boolean | null | undefined; category?: string | null | undefined; columnHeaderType?: string | null | undefined; description?: string | null | undefined; example?: string | null | undefined; indexes?: string[] | null | undefined; id?: string | null | undefined; name?: string | null | undefined; placeholder?: string | null | undefined; searchable?: boolean | null | undefined; type?: string | null | undefined; }[] | null | undefined; dataProviders?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; and?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; }[] | null | undefined; type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined; }[] | null | undefined; description?: string | null | undefined; eqlOptions?: { eventCategoryField?: string | null | undefined; query?: string | null | undefined; tiebreakerField?: string | null | undefined; timestampField?: string | null | undefined; size?: string | number | null | undefined; } | null | undefined; eventType?: string | null | undefined; excludedRowRendererIds?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined; favorite?: { keySearch?: string | null | undefined; favoriteDate?: number | null | undefined; fullName?: string | null | undefined; userName?: string | null | undefined; }[] | null | undefined; filters?: { exists?: string | null | undefined; meta?: { alias?: string | null | undefined; controlledBy?: string | null | undefined; disabled?: boolean | null | undefined; field?: string | null | undefined; formattedValue?: string | null | undefined; index?: string | null | undefined; key?: string | null | undefined; negate?: boolean | null | undefined; params?: string | null | undefined; type?: string | null | undefined; value?: string | null | undefined; } | null | undefined; match_all?: string | null | undefined; missing?: string | null | undefined; query?: string | null | undefined; range?: string | null | undefined; script?: string | null | undefined; }[] | null | undefined; indexNames?: string[] | null | undefined; kqlMode?: string | null | undefined; kqlQuery?: { filterQuery?: { kuery?: { kind?: string | null | undefined; expression?: string | null | undefined; } | null | undefined; serializedQuery?: string | null | undefined; } | null | undefined; } | null | undefined; title?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; dateRange?: { start?: string | number | null | undefined; end?: string | number | null | undefined; } | null | undefined; savedQueryId?: string | null | undefined; sort?: { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { savedObjectId: string; version: string; } & { eventIdToNoteIds?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; noteIds?: string[] | undefined; notes?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; pinnedEventIds?: string[] | undefined; pinnedEventsSaveObject?: ({ pinnedEventId: string; version: string; } & { timelineId: string; eventId: string; } & { created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { timelineVersion?: string | null | undefined; })[] | undefined; })[]; totalCount: number; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.RowCellRender",
"type": "Type",
"tags": [],
"label": "RowCellRender",
"description": [],
"signature": [
"((props: Pick<",
"EuiDataGridCellValueElementProps",
", \"columnId\" | \"rowIndex\">) => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: Pick<",
"EuiDataGridCellValueElementProps",
", \"columnId\" | \"rowIndex\">) => React.Component<Pick<",
"EuiDataGridCellValueElementProps",
", \"columnId\" | \"rowIndex\">, any, any>) | ((props: Pick<",
"EuiDataGridCellValueElementProps",
", \"columnId\" | \"rowIndex\">) => JSX.Element) | ((props: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ActionProps",
"text": "ActionProps"
},
") => React.ReactElement<any, string | ((props: any) => React.ReactElement<any, string | any | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: any) => React.Component<any, any, any>)> | null) | (new (props: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ActionProps",
"text": "ActionProps"
},
") => React.Component<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ActionProps",
"text": "ActionProps"
},
", any, any>) | ((props: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ActionProps",
"text": "ActionProps"
},
") => JSX.Element)"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SavedTimeline",
"type": "Type",
"tags": [],
"label": "SavedTimeline",
"description": [],
"signature": [
"{ columns?: { aggregatable?: boolean | null | undefined; category?: string | null | undefined; columnHeaderType?: string | null | undefined; description?: string | null | undefined; example?: string | null | undefined; indexes?: string[] | null | undefined; id?: string | null | undefined; name?: string | null | undefined; placeholder?: string | null | undefined; searchable?: boolean | null | undefined; type?: string | null | undefined; }[] | null | undefined; dataProviders?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; and?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; }[] | null | undefined; type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined; }[] | null | undefined; description?: string | null | undefined; eqlOptions?: { eventCategoryField?: string | null | undefined; query?: string | null | undefined; tiebreakerField?: string | null | undefined; timestampField?: string | null | undefined; size?: string | number | null | undefined; } | null | undefined; eventType?: string | null | undefined; excludedRowRendererIds?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined; favorite?: { keySearch?: string | null | undefined; favoriteDate?: number | null | undefined; fullName?: string | null | undefined; userName?: string | null | undefined; }[] | null | undefined; filters?: { exists?: string | null | undefined; meta?: { alias?: string | null | undefined; controlledBy?: string | null | undefined; disabled?: boolean | null | undefined; field?: string | null | undefined; formattedValue?: string | null | undefined; index?: string | null | undefined; key?: string | null | undefined; negate?: boolean | null | undefined; params?: string | null | undefined; type?: string | null | undefined; value?: string | null | undefined; } | null | undefined; match_all?: string | null | undefined; missing?: string | null | undefined; query?: string | null | undefined; range?: string | null | undefined; script?: string | null | undefined; }[] | null | undefined; indexNames?: string[] | null | undefined; kqlMode?: string | null | undefined; kqlQuery?: { filterQuery?: { kuery?: { kind?: string | null | undefined; expression?: string | null | undefined; } | null | undefined; serializedQuery?: string | null | undefined; } | null | undefined; } | null | undefined; title?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; dateRange?: { start?: string | number | null | undefined; end?: string | number | null | undefined; } | null | undefined; savedQueryId?: string | null | undefined; sort?: { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SavedTimelineNote",
"type": "Type",
"tags": [],
"label": "SavedTimelineNote",
"description": [],
"signature": [
"{ columns?: { aggregatable?: boolean | null | undefined; category?: string | null | undefined; columnHeaderType?: string | null | undefined; description?: string | null | undefined; example?: string | null | undefined; indexes?: string[] | null | undefined; id?: string | null | undefined; name?: string | null | undefined; placeholder?: string | null | undefined; searchable?: boolean | null | undefined; type?: string | null | undefined; }[] | null | undefined; dataProviders?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; and?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; }[] | null | undefined; type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined; }[] | null | undefined; description?: string | null | undefined; eqlOptions?: { eventCategoryField?: string | null | undefined; query?: string | null | undefined; tiebreakerField?: string | null | undefined; timestampField?: string | null | undefined; size?: string | number | null | undefined; } | null | undefined; eventType?: string | null | undefined; excludedRowRendererIds?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined; favorite?: { keySearch?: string | null | undefined; favoriteDate?: number | null | undefined; fullName?: string | null | undefined; userName?: string | null | undefined; }[] | null | undefined; filters?: { exists?: string | null | undefined; meta?: { alias?: string | null | undefined; controlledBy?: string | null | undefined; disabled?: boolean | null | undefined; field?: string | null | undefined; formattedValue?: string | null | undefined; index?: string | null | undefined; key?: string | null | undefined; negate?: boolean | null | undefined; params?: string | null | undefined; type?: string | null | undefined; value?: string | null | undefined; } | null | undefined; match_all?: string | null | undefined; missing?: string | null | undefined; query?: string | null | undefined; range?: string | null | undefined; script?: string | null | undefined; }[] | null | undefined; indexNames?: string[] | null | undefined; kqlMode?: string | null | undefined; kqlQuery?: { filterQuery?: { kuery?: { kind?: string | null | undefined; expression?: string | null | undefined; } | null | undefined; serializedQuery?: string | null | undefined; } | null | undefined; } | null | undefined; title?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; dateRange?: { start?: string | number | null | undefined; end?: string | number | null | undefined; } | null | undefined; savedQueryId?: string | null | undefined; sort?: { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SearchTypes",
"type": "Type",
"tags": [],
"label": "SearchTypes",
"description": [],
"signature": [
"string | number | boolean | object | string[] | number[] | boolean[] | object[] | undefined"
],
"path": "x-pack/plugins/timelines/common/search_strategy/eql/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SetEventsDeleted",
"type": "Type",
"tags": [],
"label": "SetEventsDeleted",
"description": [],
"signature": [
"(params: { eventIds: string[]; isDeleted: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SetEventsDeleted.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ eventIds: string[]; isDeleted: boolean; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SetEventsLoading",
"type": "Type",
"tags": [],
"label": "SetEventsLoading",
"description": [],
"signature": [
"(params: { eventIds: string[]; isLoading: boolean; }) => void"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.SetEventsLoading.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [],
"signature": [
"{ eventIds: string[]; isLoading: boolean; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/actions/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SingleTimelineResponse",
"type": "Type",
"tags": [],
"label": "SingleTimelineResponse",
"description": [],
"signature": [
"{ data: { getOneTimeline: { columns?: { aggregatable?: boolean | null | undefined; category?: string | null | undefined; columnHeaderType?: string | null | undefined; description?: string | null | undefined; example?: string | null | undefined; indexes?: string[] | null | undefined; id?: string | null | undefined; name?: string | null | undefined; placeholder?: string | null | undefined; searchable?: boolean | null | undefined; type?: string | null | undefined; }[] | null | undefined; dataProviders?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; and?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; }[] | null | undefined; type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined; }[] | null | undefined; description?: string | null | undefined; eqlOptions?: { eventCategoryField?: string | null | undefined; query?: string | null | undefined; tiebreakerField?: string | null | undefined; timestampField?: string | null | undefined; size?: string | number | null | undefined; } | null | undefined; eventType?: string | null | undefined; excludedRowRendererIds?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined; favorite?: { keySearch?: string | null | undefined; favoriteDate?: number | null | undefined; fullName?: string | null | undefined; userName?: string | null | undefined; }[] | null | undefined; filters?: { exists?: string | null | undefined; meta?: { alias?: string | null | undefined; controlledBy?: string | null | undefined; disabled?: boolean | null | undefined; field?: string | null | undefined; formattedValue?: string | null | undefined; index?: string | null | undefined; key?: string | null | undefined; negate?: boolean | null | undefined; params?: string | null | undefined; type?: string | null | undefined; value?: string | null | undefined; } | null | undefined; match_all?: string | null | undefined; missing?: string | null | undefined; query?: string | null | undefined; range?: string | null | undefined; script?: string | null | undefined; }[] | null | undefined; indexNames?: string[] | null | undefined; kqlMode?: string | null | undefined; kqlQuery?: { filterQuery?: { kuery?: { kind?: string | null | undefined; expression?: string | null | undefined; } | null | undefined; serializedQuery?: string | null | undefined; } | null | undefined; } | null | undefined; title?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; dateRange?: { start?: string | number | null | undefined; end?: string | number | null | undefined; } | null | undefined; savedQueryId?: string | null | undefined; sort?: { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { savedObjectId: string; version: string; } & { eventIdToNoteIds?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; noteIds?: string[] | undefined; notes?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; pinnedEventIds?: string[] | undefined; pinnedEventsSaveObject?: ({ pinnedEventId: string; version: string; } & { timelineId: string; eventId: string; } & { created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { timelineVersion?: string | null | undefined; })[] | undefined; }; }; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SKIP_FOCUS_BACKWARDS",
"type": "Type",
"tags": [],
"label": "SKIP_FOCUS_BACKWARDS",
"description": [],
"signature": [
"\"SKIP_FOCUS_BACKWARDS\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SKIP_FOCUS_FORWARD",
"type": "Type",
"tags": [],
"label": "SKIP_FOCUS_FORWARD",
"description": [],
"signature": [
"\"SKIP_FOCUS_FORWARD\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SKIP_FOCUS_NOOP",
"type": "Type",
"tags": [],
"label": "SKIP_FOCUS_NOOP",
"description": [],
"signature": [
"\"SKIP_FOCUS_NOOP\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SkipFocus",
"type": "Type",
"tags": [],
"label": "SkipFocus",
"description": [],
"signature": [
"\"SKIP_FOCUS_BACKWARDS\" | \"SKIP_FOCUS_FORWARD\" | \"SKIP_FOCUS_NOOP\""
],
"path": "x-pack/plugins/timelines/common/utils/accessibility/helpers.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.Sort",
"type": "Type",
"tags": [],
"label": "Sort",
"description": [],
"signature": [
"{ columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[]"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SortDirection",
"type": "Type",
"tags": [],
"label": "SortDirection",
"description": [],
"signature": [
"\"none\" | \"asc\" | \"desc\" | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/store.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TemplateTimelineTypeLiteral",
"type": "Type",
"tags": [],
"label": "TemplateTimelineTypeLiteral",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TemplateTimelineType",
"text": "TemplateTimelineType"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TemplateTimelineTypeLiteralWithNull",
"type": "Type",
"tags": [],
"label": "TemplateTimelineTypeLiteralWithNull",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TemplateTimelineType",
"text": "TemplateTimelineType"
},
" | null"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TGridCellAction",
"type": "Type",
"tags": [],
"label": "TGridCellAction",
"description": [
"\nA `TGridCellAction` function accepts `data`, where each row of data is\nrepresented as a `TimelineNonEcsData[]`. For example, `data[0]` would\ncontain a `TimelineNonEcsData[]` with the first row of data.\n\nA `TGridCellAction` returns a function that has access to all the\n`EuiDataGridColumnCellActionProps`, _plus_ access to `data`,\n which enables code like the following example to be written:\n\nExample:\n```\n({ data }: { data: TimelineNonEcsData[][] }) => ({ rowIndex, columnId, Component }) => {\n const value = getMappedNonEcsValue({\n data: data[rowIndex], // access a specific row's values\n fieldName: columnId,\n });\n\n return (\n <Component onClick={() => alert(`row ${rowIndex} col ${columnId} has value ${value}`)} iconType=\"heart\">\n {'Love it'}\n </Component>\n );\n};\n```"
],
"signature": [
"({ browserFields, data, ecsData, header, pageSize, timelineId, }: { browserFields: Readonly<Record<string, Partial<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">>>; data: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineNonEcsData",
"text": "TimelineNonEcsData"
},
"[][]; ecsData: ",
"Ecs",
"[]; header?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderOptions",
"text": "ColumnHeaderOptions"
},
" | undefined; pageSize: number; timelineId: string; }) => (props: ",
"EuiDataGridColumnCellActionProps",
") => React.ReactNode"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false,
"returnComment": [],
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.TGridCellAction.$1",
"type": "Object",
"tags": [],
"label": "__0",
"description": [],
"signature": [
"{ browserFields: Readonly<Record<string, Partial<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.BrowserField",
"text": "BrowserField"
},
">>>; data: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineNonEcsData",
"text": "TimelineNonEcsData"
},
"[][]; ecsData: ",
"Ecs",
"[]; header?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.ColumnHeaderOptions",
"text": "ColumnHeaderOptions"
},
" | undefined; pageSize: number; timelineId: string; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/columns/index.tsx",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineErrorResponse",
"type": "Type",
"tags": [],
"label": "TimelineErrorResponse",
"description": [],
"signature": [
"{ status_code: number; message: string; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineEventsType",
"type": "Type",
"tags": [],
"label": "TimelineEventsType",
"description": [],
"signature": [
"\"all\" | \"custom\" | \"raw\" | \"alert\" | \"eql\" | \"signal\""
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineExpandedDetail",
"type": "Type",
"tags": [],
"label": "TimelineExpandedDetail",
"description": [],
"signature": [
"{ [x: string]: { panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
"Ecs",
" | undefined; } | undefined; } | Partial<Record<any, never>> | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; } | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineExpandedDetailType",
"type": "Type",
"tags": [],
"label": "TimelineExpandedDetailType",
"description": [],
"signature": [
"{ panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
"Ecs",
" | undefined; } | undefined; } | Partial<Record<any, never>> | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineExpandedEventType",
"type": "Type",
"tags": [],
"label": "TimelineExpandedEventType",
"description": [],
"signature": [
"{ panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
"Ecs",
" | undefined; } | undefined; } | Partial<Record<any, never>>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineExpandedHostType",
"type": "Type",
"tags": [],
"label": "TimelineExpandedHostType",
"description": [],
"signature": [
"Partial<Record<any, never>> | { panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineExpandedNetworkType",
"type": "Type",
"tags": [],
"label": "TimelineExpandedNetworkType",
"description": [],
"signature": [
"Partial<Record<any, never>> | { panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineFactoryQueryTypes",
"type": "Type",
"tags": [],
"label": "TimelineFactoryQueryTypes",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
}
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineIdLiteral",
"type": "Type",
"tags": [],
"label": "TimelineIdLiteral",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".hostsPageEvents | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".hostsPageExternalAlerts | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".detectionsRulesDetailsPage | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".detectionsPage | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".networkPageExternalAlerts | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".uebaPageExternalAlerts | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".active | ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".test"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResponse",
"type": "Type",
"tags": [],
"label": "TimelineResponse",
"description": [],
"signature": [
"{ data: { persistTimeline: { code?: number | null | undefined; message?: string | null | undefined; } & { timeline: { columns?: { aggregatable?: boolean | null | undefined; category?: string | null | undefined; columnHeaderType?: string | null | undefined; description?: string | null | undefined; example?: string | null | undefined; indexes?: string[] | null | undefined; id?: string | null | undefined; name?: string | null | undefined; placeholder?: string | null | undefined; searchable?: boolean | null | undefined; type?: string | null | undefined; }[] | null | undefined; dataProviders?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; and?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; }[] | null | undefined; type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined; }[] | null | undefined; description?: string | null | undefined; eqlOptions?: { eventCategoryField?: string | null | undefined; query?: string | null | undefined; tiebreakerField?: string | null | undefined; timestampField?: string | null | undefined; size?: string | number | null | undefined; } | null | undefined; eventType?: string | null | undefined; excludedRowRendererIds?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined; favorite?: { keySearch?: string | null | undefined; favoriteDate?: number | null | undefined; fullName?: string | null | undefined; userName?: string | null | undefined; }[] | null | undefined; filters?: { exists?: string | null | undefined; meta?: { alias?: string | null | undefined; controlledBy?: string | null | undefined; disabled?: boolean | null | undefined; field?: string | null | undefined; formattedValue?: string | null | undefined; index?: string | null | undefined; key?: string | null | undefined; negate?: boolean | null | undefined; params?: string | null | undefined; type?: string | null | undefined; value?: string | null | undefined; } | null | undefined; match_all?: string | null | undefined; missing?: string | null | undefined; query?: string | null | undefined; range?: string | null | undefined; script?: string | null | undefined; }[] | null | undefined; indexNames?: string[] | null | undefined; kqlMode?: string | null | undefined; kqlQuery?: { filterQuery?: { kuery?: { kind?: string | null | undefined; expression?: string | null | undefined; } | null | undefined; serializedQuery?: string | null | undefined; } | null | undefined; } | null | undefined; title?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; dateRange?: { start?: string | number | null | undefined; end?: string | number | null | undefined; } | null | undefined; savedQueryId?: string | null | undefined; sort?: { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { savedObjectId: string; version: string; } & { eventIdToNoteIds?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; noteIds?: string[] | undefined; notes?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; pinnedEventIds?: string[] | undefined; pinnedEventsSaveObject?: ({ pinnedEventId: string; version: string; } & { timelineId: string; eventId: string; } & { created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { timelineVersion?: string | null | undefined; })[] | undefined; }; }; }; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineSavedObject",
"type": "Type",
"tags": [],
"label": "TimelineSavedObject",
"description": [],
"signature": [
"{ columns?: { aggregatable?: boolean | null | undefined; category?: string | null | undefined; columnHeaderType?: string | null | undefined; description?: string | null | undefined; example?: string | null | undefined; indexes?: string[] | null | undefined; id?: string | null | undefined; name?: string | null | undefined; placeholder?: string | null | undefined; searchable?: boolean | null | undefined; type?: string | null | undefined; }[] | null | undefined; dataProviders?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; and?: { id?: string | null | undefined; name?: string | null | undefined; enabled?: boolean | null | undefined; excluded?: boolean | null | undefined; kqlQuery?: string | null | undefined; queryMatch?: { field?: string | null | undefined; displayField?: string | null | undefined; value?: string | null | undefined; displayValue?: string | null | undefined; operator?: string | null | undefined; } | null | undefined; }[] | null | undefined; type?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
" | null | undefined; }[] | null | undefined; description?: string | null | undefined; eqlOptions?: { eventCategoryField?: string | null | undefined; query?: string | null | undefined; tiebreakerField?: string | null | undefined; timestampField?: string | null | undefined; size?: string | number | null | undefined; } | null | undefined; eventType?: string | null | undefined; excludedRowRendererIds?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
"[] | null | undefined; favorite?: { keySearch?: string | null | undefined; favoriteDate?: number | null | undefined; fullName?: string | null | undefined; userName?: string | null | undefined; }[] | null | undefined; filters?: { exists?: string | null | undefined; meta?: { alias?: string | null | undefined; controlledBy?: string | null | undefined; disabled?: boolean | null | undefined; field?: string | null | undefined; formattedValue?: string | null | undefined; index?: string | null | undefined; key?: string | null | undefined; negate?: boolean | null | undefined; params?: string | null | undefined; type?: string | null | undefined; value?: string | null | undefined; } | null | undefined; match_all?: string | null | undefined; missing?: string | null | undefined; query?: string | null | undefined; range?: string | null | undefined; script?: string | null | undefined; }[] | null | undefined; indexNames?: string[] | null | undefined; kqlMode?: string | null | undefined; kqlQuery?: { filterQuery?: { kuery?: { kind?: string | null | undefined; expression?: string | null | undefined; } | null | undefined; serializedQuery?: string | null | undefined; } | null | undefined; } | null | undefined; title?: string | null | undefined; templateTimelineId?: string | null | undefined; templateTimelineVersion?: number | null | undefined; timelineType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null | undefined; dateRange?: { start?: string | number | null | undefined; end?: string | number | null | undefined; } | null | undefined; savedQueryId?: string | null | undefined; sort?: { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; } | { columnId?: string | null | undefined; columnType?: string | null | undefined; sortDirection?: string | null | undefined; }[] | null | undefined; status?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { savedObjectId: string; version: string; } & { eventIdToNoteIds?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; noteIds?: string[] | undefined; notes?: ({ timelineId: string | null; } & { eventId?: string | null | undefined; note?: string | null | undefined; created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { noteId: string; version: string; } & { timelineVersion?: string | null | undefined; })[] | undefined; pinnedEventIds?: string[] | undefined; pinnedEventsSaveObject?: ({ pinnedEventId: string; version: string; } & { timelineId: string; eventId: string; } & { created?: number | null | undefined; createdBy?: string | null | undefined; updated?: number | null | undefined; updatedBy?: string | null | undefined; } & { timelineVersion?: string | null | undefined; })[] | undefined; }"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineStatusLiteral",
"type": "Type",
"tags": [],
"label": "TimelineStatusLiteral",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineStatusLiteralWithNull",
"type": "Type",
"tags": [],
"label": "TimelineStatusLiteralWithNull",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
" | null"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineStrategyRequestType",
"type": "Type",
"tags": [],
"label": "TimelineStrategyRequestType",
"description": [],
"signature": [
"T extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
},
".all ? ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsAllRequestOptions",
"text": "TimelineEventsAllRequestOptions"
},
" : T extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
},
".details ? ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsDetailsRequestOptions",
"text": "TimelineEventsDetailsRequestOptions"
},
" : T extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
},
".kpi ? ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineRequestBasicOptions",
"text": "TimelineRequestBasicOptions"
},
" : T extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
},
".lastEventTime ? ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsLastEventTimeRequestOptions",
"text": "TimelineEventsLastEventTimeRequestOptions"
},
" : never"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineStrategyResponseType",
"type": "Type",
"tags": [],
"label": "TimelineStrategyResponseType",
"description": [],
"signature": [
"T extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
},
".all ? ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsAllStrategyResponse",
"text": "TimelineEventsAllStrategyResponse"
},
" : T extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
},
".details ? ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsDetailsStrategyResponse",
"text": "TimelineEventsDetailsStrategyResponse"
},
" : T extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
},
".kpi ? ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineKpiStrategyResponse",
"text": "TimelineKpiStrategyResponse"
},
" : T extends ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsQueries",
"text": "TimelineEventsQueries"
},
".lastEventTime ? ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineEventsLastEventTimeStrategyResponse",
"text": "TimelineEventsLastEventTimeStrategyResponse"
},
" : never"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineTypeLiteral",
"type": "Type",
"tags": [],
"label": "TimelineTypeLiteral",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
}
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineTypeLiteralWithNull",
"type": "Type",
"tags": [],
"label": "TimelineTypeLiteralWithNull",
"description": [],
"signature": [
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
" | null"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.ToggleDetailPanel",
"type": "Type",
"tags": [],
"label": "ToggleDetailPanel",
"description": [],
"signature": [
"({ panelView?: \"eventDetail\" | undefined; params?: { eventId: string; indexName: string; ecsData?: ",
"Ecs",
" | undefined; } | undefined; } & { tabType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineTabs",
"text": "TimelineTabs"
},
" | undefined; timelineId: string; }) | (Partial<Record<any, never>> & { tabType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineTabs",
"text": "TimelineTabs"
},
" | undefined; timelineId: string; }) | ({ panelView?: \"hostDetail\" | undefined; params?: { hostName: string; } | undefined; } & { tabType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineTabs",
"text": "TimelineTabs"
},
" | undefined; timelineId: string; }) | ({ panelView?: \"networkDetail\" | undefined; params?: { ip: string; flowTarget: FlowTarget; } | undefined; } & { tabType?: ",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineTabs",
"text": "TimelineTabs"
},
" | undefined; timelineId: string; })"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "timelines",
"id": "def-common.AllTimelineSavedObjectRuntimeType",
"type": "Object",
"tags": [],
"label": "AllTimelineSavedObjectRuntimeType",
"description": [
"\nAll Timeline Saved object type with metadata"
],
"signature": [
"TypeC",
"<{ total: ",
"NumberC",
"; data: ",
"IntersectionC",
"<[",
"PartialC",
"<{ columns: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ aggregatable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnHeaderType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; example: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; indexes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; placeholder: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; searchable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; dataProviders: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; and: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".template>]>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; eqlOptions: ",
"UnionC",
"<[",
"PartialC",
"<{ eventCategoryField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; tiebreakerField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; timestampField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; size: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; eventType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; excludedRowRendererIds: ",
"UnionC",
"<[",
"ArrayC",
"<",
"Type",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
", string, unknown>>, ",
"NullC",
"]>; favorite: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ keySearch: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; favoriteDate: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; fullName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; userName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; filters: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ exists: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; meta: ",
"UnionC",
"<[",
"PartialC",
"<{ alias: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; controlledBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; disabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; formattedValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; index: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; key: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; negate: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; params: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; match_all: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; missing: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; range: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; script: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; indexNames: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; kqlMode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ filterQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kind: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; expression: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; serializedQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; title: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineVersion: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; timelineType: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>; dateRange: ",
"UnionC",
"<[",
"PartialC",
"<{ start: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; end: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; savedQueryId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sort: ",
"UnionC",
"<[",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"NullC",
"]>; status: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".draft>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".immutable>]>, ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ savedObjectId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ eventIdToNoteIds: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; noteIds: ",
"ArrayC",
"<",
"StringC",
">; notes: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; pinnedEventIds: ",
"ArrayC",
"<",
"StringC",
">; pinnedEventsSaveObject: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ pinnedEventId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"StringC",
"; eventId: ",
"StringC",
"; }>, ",
"PartialC",
"<{ created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; }>]>; }>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.allTimelinesResponse",
"type": "Object",
"tags": [],
"label": "allTimelinesResponse",
"description": [],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ timeline: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"PartialC",
"<{ columns: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ aggregatable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnHeaderType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; example: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; indexes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; placeholder: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; searchable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; dataProviders: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; and: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".template>]>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; eqlOptions: ",
"UnionC",
"<[",
"PartialC",
"<{ eventCategoryField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; tiebreakerField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; timestampField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; size: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; eventType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; excludedRowRendererIds: ",
"UnionC",
"<[",
"ArrayC",
"<",
"Type",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
", string, unknown>>, ",
"NullC",
"]>; favorite: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ keySearch: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; favoriteDate: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; fullName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; userName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; filters: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ exists: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; meta: ",
"UnionC",
"<[",
"PartialC",
"<{ alias: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; controlledBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; disabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; formattedValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; index: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; key: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; negate: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; params: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; match_all: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; missing: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; range: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; script: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; indexNames: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; kqlMode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ filterQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kind: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; expression: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; serializedQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; title: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineVersion: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; timelineType: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>; dateRange: ",
"UnionC",
"<[",
"PartialC",
"<{ start: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; end: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; savedQueryId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sort: ",
"UnionC",
"<[",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"NullC",
"]>; status: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".draft>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".immutable>]>, ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ savedObjectId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ eventIdToNoteIds: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; noteIds: ",
"ArrayC",
"<",
"StringC",
">; notes: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; pinnedEventIds: ",
"ArrayC",
"<",
"StringC",
">; pinnedEventsSaveObject: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ pinnedEventId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"StringC",
"; eventId: ",
"StringC",
"; }>, ",
"PartialC",
"<{ created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; }>]>>; totalCount: ",
"NumberC",
"; }>, ",
"TypeC",
"<{ defaultTimelineCount: ",
"NumberC",
"; templateTimelineCount: ",
"NumberC",
"; elasticTemplateTimelineCount: ",
"NumberC",
"; customTemplateTimelineCount: ",
"NumberC",
"; favoriteCount: ",
"NumberC",
"; }>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.DataProviderTypeLiteralRt",
"type": "Object",
"tags": [],
"label": "DataProviderTypeLiteralRt",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".template>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.direction",
"type": "Object",
"tags": [],
"label": "direction",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
},
".asc>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
},
".desc>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EMPTY_BROWSER_FIELDS",
"type": "Object",
"tags": [],
"label": "EMPTY_BROWSER_FIELDS",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"children": [],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EMPTY_INDEX_PATTERN",
"type": "Object",
"tags": [],
"label": "EMPTY_INDEX_PATTERN",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false,
"children": [
{
"parentPluginId": "timelines",
"id": "def-common.EMPTY_INDEX_PATTERN.fields",
"type": "Array",
"tags": [],
"label": "fields",
"description": [],
"signature": [
"never[]"
],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EMPTY_INDEX_PATTERN.title",
"type": "string",
"tags": [],
"label": "title",
"description": [],
"path": "x-pack/plugins/timelines/common/search_strategy/index_fields/index.ts",
"deprecated": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.EntityType",
"type": "Object",
"tags": [],
"label": "EntityType",
"description": [],
"signature": [
"{ readonly ALERTS: \"alerts\"; readonly EVENTS: \"events\"; }"
],
"path": "x-pack/plugins/timelines/common/search_strategy/timeline/events/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.getTimelinesArgs",
"type": "Object",
"tags": [],
"label": "getTimelinesArgs",
"description": [],
"signature": [
"PartialC",
"<{ onlyUserFavorite: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; pageInfo: ",
"UnionC",
"<[",
"TypeC",
"<{ pageIndex: ",
"NumberC",
"; pageSize: ",
"NumberC",
"; }>, ",
"NullC",
"]>; search: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sort: ",
"UnionC",
"<[",
"TypeC",
"<{ sortField: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".title>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".description>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".updated>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".created>]>; sortOrder: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
},
".asc>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
},
".desc>]>; }>, ",
"NullC",
"]>; status: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".draft>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".immutable>]>, ",
"NullC",
"]>; timelineType: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>; }>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.importTimelineResultSchema",
"type": "Object",
"tags": [],
"label": "importTimelineResultSchema",
"description": [],
"signature": [
"ExactC",
"<",
"TypeC",
"<{ success: ",
"BooleanC",
"; success_count: ",
"NumberC",
"; timelines_installed: ",
"NumberC",
"; timelines_updated: ",
"NumberC",
"; errors: ",
"ArrayC",
"<",
"ExactC",
"<",
"TypeC",
"<{ error: ",
"TypeC",
"<{ status_code: ",
"NumberC",
"; message: ",
"StringC",
"; }>; }>>>; }>>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.pageInfoTimeline",
"type": "Object",
"tags": [],
"label": "pageInfoTimeline",
"description": [],
"signature": [
"TypeC",
"<{ pageIndex: ",
"NumberC",
"; pageSize: ",
"NumberC",
"; }>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.responseFavoriteTimeline",
"type": "Object",
"tags": [],
"label": "responseFavoriteTimeline",
"description": [],
"signature": [
"PartialC",
"<{ savedObjectId: ",
"StringC",
"; version: ",
"StringC",
"; code: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; message: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineVersion: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; timelineType: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>; favorite: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ fullName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; userName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; favoriteDate: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; }>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.RowRendererIdRuntimeType",
"type": "Object",
"tags": [],
"label": "RowRendererIdRuntimeType",
"description": [],
"signature": [
"Type",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
", string, unknown>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SavedTimelineRuntimeType",
"type": "Object",
"tags": [],
"label": "SavedTimelineRuntimeType",
"description": [],
"signature": [
"PartialC",
"<{ columns: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ aggregatable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnHeaderType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; example: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; indexes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; placeholder: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; searchable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; dataProviders: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; and: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".template>]>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; eqlOptions: ",
"UnionC",
"<[",
"PartialC",
"<{ eventCategoryField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; tiebreakerField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; timestampField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; size: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; eventType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; excludedRowRendererIds: ",
"UnionC",
"<[",
"ArrayC",
"<",
"Type",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
", string, unknown>>, ",
"NullC",
"]>; favorite: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ keySearch: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; favoriteDate: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; fullName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; userName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; filters: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ exists: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; meta: ",
"UnionC",
"<[",
"PartialC",
"<{ alias: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; controlledBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; disabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; formattedValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; index: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; key: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; negate: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; params: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; match_all: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; missing: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; range: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; script: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; indexNames: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; kqlMode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ filterQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kind: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; expression: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; serializedQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; title: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineVersion: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; timelineType: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>; dateRange: ",
"UnionC",
"<[",
"PartialC",
"<{ start: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; end: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; savedQueryId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sort: ",
"UnionC",
"<[",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"NullC",
"]>; status: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".draft>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".immutable>]>, ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.SingleTimelineResponseType",
"type": "Object",
"tags": [],
"label": "SingleTimelineResponseType",
"description": [],
"signature": [
"TypeC",
"<{ data: ",
"TypeC",
"<{ getOneTimeline: ",
"IntersectionC",
"<[",
"PartialC",
"<{ columns: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ aggregatable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnHeaderType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; example: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; indexes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; placeholder: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; searchable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; dataProviders: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; and: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".template>]>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; eqlOptions: ",
"UnionC",
"<[",
"PartialC",
"<{ eventCategoryField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; tiebreakerField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; timestampField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; size: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; eventType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; excludedRowRendererIds: ",
"UnionC",
"<[",
"ArrayC",
"<",
"Type",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
", string, unknown>>, ",
"NullC",
"]>; favorite: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ keySearch: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; favoriteDate: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; fullName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; userName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; filters: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ exists: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; meta: ",
"UnionC",
"<[",
"PartialC",
"<{ alias: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; controlledBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; disabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; formattedValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; index: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; key: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; negate: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; params: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; match_all: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; missing: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; range: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; script: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; indexNames: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; kqlMode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ filterQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kind: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; expression: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; serializedQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; title: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineVersion: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; timelineType: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>; dateRange: ",
"UnionC",
"<[",
"PartialC",
"<{ start: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; end: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; savedQueryId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sort: ",
"UnionC",
"<[",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"NullC",
"]>; status: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".draft>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".immutable>]>, ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ savedObjectId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ eventIdToNoteIds: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; noteIds: ",
"ArrayC",
"<",
"StringC",
">; notes: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; pinnedEventIds: ",
"ArrayC",
"<",
"StringC",
">; pinnedEventsSaveObject: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ pinnedEventId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"StringC",
"; eventId: ",
"StringC",
"; }>, ",
"PartialC",
"<{ created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; }>]>; }>; }>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.sortFieldTimeline",
"type": "Object",
"tags": [],
"label": "sortFieldTimeline",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".title>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".description>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".updated>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".created>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.sortTimeline",
"type": "Object",
"tags": [],
"label": "sortTimeline",
"description": [],
"signature": [
"TypeC",
"<{ sortField: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".title>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".description>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".updated>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.SortFieldTimeline",
"text": "SortFieldTimeline"
},
".created>]>; sortOrder: ",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
},
".asc>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.Direction",
"text": "Direction"
},
".desc>]>; }>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TemplateTimelineTypeLiteralRt",
"type": "Object",
"tags": [],
"label": "TemplateTimelineTypeLiteralRt",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TemplateTimelineType",
"text": "TemplateTimelineType"
},
".elastic>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TemplateTimelineType",
"text": "TemplateTimelineType"
},
".custom>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TemplateTimelineTypeLiteralWithNullRt",
"type": "Object",
"tags": [],
"label": "TemplateTimelineTypeLiteralWithNullRt",
"description": [],
"signature": [
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TemplateTimelineType",
"text": "TemplateTimelineType"
},
".elastic>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TemplateTimelineType",
"text": "TemplateTimelineType"
},
".custom>]>, ",
"NullC",
"]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineErrorResponseType",
"type": "Object",
"tags": [],
"label": "TimelineErrorResponseType",
"description": [],
"signature": [
"TypeC",
"<{ status_code: ",
"NumberC",
"; message: ",
"StringC",
"; }>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineIdLiteralRt",
"type": "Object",
"tags": [],
"label": "TimelineIdLiteralRt",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".hostsPageEvents>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".hostsPageExternalAlerts>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".detectionsRulesDetailsPage>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".detectionsPage>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".networkPageExternalAlerts>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".uebaPageExternalAlerts>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineId",
"text": "TimelineId"
},
".test>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineResponseType",
"type": "Object",
"tags": [],
"label": "TimelineResponseType",
"description": [
"\nAll Timeline Saved object type with metadata"
],
"signature": [
"TypeC",
"<{ data: ",
"TypeC",
"<{ persistTimeline: ",
"IntersectionC",
"<[",
"PartialC",
"<{ code: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; message: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ timeline: ",
"IntersectionC",
"<[",
"PartialC",
"<{ columns: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ aggregatable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnHeaderType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; example: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; indexes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; placeholder: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; searchable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; dataProviders: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; and: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".template>]>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; eqlOptions: ",
"UnionC",
"<[",
"PartialC",
"<{ eventCategoryField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; tiebreakerField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; timestampField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; size: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; eventType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; excludedRowRendererIds: ",
"UnionC",
"<[",
"ArrayC",
"<",
"Type",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
", string, unknown>>, ",
"NullC",
"]>; favorite: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ keySearch: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; favoriteDate: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; fullName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; userName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; filters: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ exists: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; meta: ",
"UnionC",
"<[",
"PartialC",
"<{ alias: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; controlledBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; disabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; formattedValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; index: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; key: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; negate: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; params: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; match_all: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; missing: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; range: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; script: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; indexNames: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; kqlMode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ filterQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kind: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; expression: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; serializedQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; title: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineVersion: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; timelineType: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>; dateRange: ",
"UnionC",
"<[",
"PartialC",
"<{ start: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; end: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; savedQueryId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sort: ",
"UnionC",
"<[",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"NullC",
"]>; status: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".draft>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".immutable>]>, ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ savedObjectId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ eventIdToNoteIds: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; noteIds: ",
"ArrayC",
"<",
"StringC",
">; notes: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; pinnedEventIds: ",
"ArrayC",
"<",
"StringC",
">; pinnedEventsSaveObject: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ pinnedEventId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"StringC",
"; eventId: ",
"StringC",
"; }>, ",
"PartialC",
"<{ created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; }>]>; }>]>; }>; }>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineSavedObjectRuntimeType",
"type": "Object",
"tags": [],
"label": "TimelineSavedObjectRuntimeType",
"description": [
"\nTimeline Saved object type with metadata"
],
"signature": [
"IntersectionC",
"<[",
"TypeC",
"<{ id: ",
"StringC",
"; attributes: ",
"PartialC",
"<{ columns: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ aggregatable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnHeaderType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; example: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; indexes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; placeholder: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; searchable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; dataProviders: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; and: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".template>]>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; eqlOptions: ",
"UnionC",
"<[",
"PartialC",
"<{ eventCategoryField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; tiebreakerField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; timestampField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; size: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; eventType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; excludedRowRendererIds: ",
"UnionC",
"<[",
"ArrayC",
"<",
"Type",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
", string, unknown>>, ",
"NullC",
"]>; favorite: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ keySearch: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; favoriteDate: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; fullName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; userName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; filters: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ exists: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; meta: ",
"UnionC",
"<[",
"PartialC",
"<{ alias: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; controlledBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; disabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; formattedValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; index: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; key: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; negate: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; params: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; match_all: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; missing: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; range: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; script: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; indexNames: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; kqlMode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ filterQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kind: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; expression: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; serializedQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; title: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineVersion: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; timelineType: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>; dateRange: ",
"UnionC",
"<[",
"PartialC",
"<{ start: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; end: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; savedQueryId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sort: ",
"UnionC",
"<[",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"NullC",
"]>; status: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".draft>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".immutable>]>, ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ savedObjectId: ",
"StringC",
"; }>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineSavedToReturnObjectRuntimeType",
"type": "Object",
"tags": [],
"label": "TimelineSavedToReturnObjectRuntimeType",
"description": [],
"signature": [
"IntersectionC",
"<[",
"PartialC",
"<{ columns: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ aggregatable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; category: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnHeaderType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; example: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; indexes: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; placeholder: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; searchable: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; dataProviders: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; and: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ id: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; name: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; enabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; excluded: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; queryMatch: ",
"UnionC",
"<[",
"PartialC",
"<{ field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; displayValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; operator: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.DataProviderType",
"text": "DataProviderType"
},
".template>]>, ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; description: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; eqlOptions: ",
"UnionC",
"<[",
"PartialC",
"<{ eventCategoryField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; tiebreakerField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; timestampField: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; size: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; eventType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; excludedRowRendererIds: ",
"UnionC",
"<[",
"ArrayC",
"<",
"Type",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.RowRendererId",
"text": "RowRendererId"
},
", string, unknown>>, ",
"NullC",
"]>; favorite: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ keySearch: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; favoriteDate: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; fullName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; userName: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; filters: ",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ exists: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; meta: ",
"UnionC",
"<[",
"PartialC",
"<{ alias: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; controlledBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; disabled: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; field: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; formattedValue: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; index: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; key: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; negate: ",
"UnionC",
"<[",
"BooleanC",
", ",
"NullC",
"]>; params: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; type: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; value: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; match_all: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; missing: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; query: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; range: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; script: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"NullC",
"]>; indexNames: ",
"UnionC",
"<[",
"ArrayC",
"<",
"StringC",
">, ",
"NullC",
"]>; kqlMode: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; kqlQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ filterQuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kuery: ",
"UnionC",
"<[",
"PartialC",
"<{ kind: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; expression: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; serializedQuery: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; title: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; templateTimelineVersion: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; timelineType: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>; dateRange: ",
"UnionC",
"<[",
"PartialC",
"<{ start: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; end: ",
"UnionC",
"<[",
"UnionC",
"<[",
"StringC",
", ",
"NumberC",
"]>, ",
"NullC",
"]>; }>, ",
"NullC",
"]>; savedQueryId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sort: ",
"UnionC",
"<[",
"UnionC",
"<[",
"ArrayC",
"<",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>>, ",
"PartialC",
"<{ columnId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; columnType: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; sortDirection: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"NullC",
"]>; status: ",
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".draft>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".immutable>]>, ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"TypeC",
"<{ savedObjectId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ eventIdToNoteIds: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; noteIds: ",
"ArrayC",
"<",
"StringC",
">; notes: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>, ",
"PartialC",
"<{ eventId: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; note: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"TypeC",
"<{ noteId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; pinnedEventIds: ",
"ArrayC",
"<",
"StringC",
">; pinnedEventsSaveObject: ",
"ArrayC",
"<",
"IntersectionC",
"<[",
"TypeC",
"<{ pinnedEventId: ",
"StringC",
"; version: ",
"StringC",
"; }>, ",
"IntersectionC",
"<[",
"TypeC",
"<{ timelineId: ",
"StringC",
"; eventId: ",
"StringC",
"; }>, ",
"PartialC",
"<{ created: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; createdBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; updated: ",
"UnionC",
"<[",
"NumberC",
", ",
"NullC",
"]>; updatedBy: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>, ",
"PartialC",
"<{ timelineVersion: ",
"UnionC",
"<[",
"StringC",
", ",
"NullC",
"]>; }>]>>; }>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineStatusLiteralRt",
"type": "Object",
"tags": [],
"label": "TimelineStatusLiteralRt",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".active>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".draft>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineStatus",
"text": "TimelineStatus"
},
".immutable>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineTypeLiteralRt",
"type": "Object",
"tags": [],
"label": "TimelineTypeLiteralRt",
"description": [],
"signature": [
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
},
{
"parentPluginId": "timelines",
"id": "def-common.TimelineTypeLiteralWithNullRt",
"type": "Object",
"tags": [],
"label": "TimelineTypeLiteralWithNullRt",
"description": [],
"signature": [
"UnionC",
"<[",
"UnionC",
"<[",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".template>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".default>, ",
"LiteralC",
"<",
{
"pluginId": "timelines",
"scope": "common",
"docId": "kibTimelinesPluginApi",
"section": "def-common.TimelineType",
"text": "TimelineType"
},
".test>]>, ",
"NullC",
"]>"
],
"path": "x-pack/plugins/timelines/common/types/timeline/index.ts",
"deprecated": false,
"initialIsOpen": false
}
]
}
}