{ "id": "controls", "client": { "classes": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer", "type": "Class", "tags": [], "label": "ControlGroupContainer", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupContainer", "text": "ControlGroupContainer" }, " extends ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.Container", "text": "Container" }, "<", "ControlInput", ", ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ", ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupOutput", "text": "ControlGroupOutput" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"control_group\"" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.anyControlOutputConsumerLoading$", "type": "Object", "tags": [], "label": "anyControlOutputConsumerLoading$", "description": [], "signature": [ "Subject", "" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.diffingSubscription", "type": "Object", "tags": [], "label": "diffingSubscription", "description": [], "signature": [ "Subscription" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.select", "type": "Function", "tags": [], "label": "select", "description": [], "signature": [ "(selector: (state: ", "ControlGroupReduxState", ") => Selected, equalityFn?: ((previous: Selected, next: Selected) => boolean) | undefined) => Selected" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.select.$1", "type": "Function", "tags": [], "label": "selector", "description": [], "signature": [ "(state: ReduxStateType) => Selected" ], "path": "src/plugins/presentation_util/public/redux_tools/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.select.$1.$1", "type": "Uncategorized", "tags": [], "label": "state", "description": [], "signature": [ "ReduxStateType" ], "path": "src/plugins/presentation_util/public/redux_tools/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.select.$2", "type": "Function", "tags": [], "label": "equalityFn", "description": [], "signature": [ "((previous: Selected, next: Selected) => boolean) | undefined" ], "path": "src/plugins/presentation_util/public/redux_tools/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.getState", "type": "Function", "tags": [], "label": "getState", "description": [], "signature": [ "() => ", "ControlGroupReduxState" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.dispatch", "type": "Object", "tags": [], "label": "dispatch", "description": [], "signature": [ "{ setControlWithInvalidSelectionsId: (payload: string | undefined) => void; setLastSavedInput: (payload: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined) => void; setLastSavedFilters: (payload: ", "ControlGroupFilterOutput", " | undefined) => void; setUnpublishedFilters: (payload: ", "ControlGroupFilterOutput", " | undefined) => void; setControlStyle: (payload: ", "ControlStyle", ") => void; setChainingSystem: (payload: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupChainingSystem", "text": "ControlGroupChainingSystem" }, ") => void; setDefaultControlWidth: (payload: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlWidth", "text": "ControlWidth" }, " | undefined) => void; setDefaultControlGrow: (payload: boolean | undefined) => void; setControlWidth: (payload: { width: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlWidth", "text": "ControlWidth" }, "; embeddableId: string; }) => void; setControlGrow: (payload: { grow: boolean; embeddableId: string; }) => void; setControlOrders: (payload: { ids: string[]; }) => void; }" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.onStateChange", "type": "Function", "tags": [], "label": "onStateChange", "description": [], "signature": [ "(listener: () => void) => ", "Unsubscribe" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.onStateChange.$1", "type": "Function", "tags": [], "label": "listener", "description": [], "signature": [ "() => void" ], "path": "node_modules/redux/index.d.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] } ] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.onFiltersPublished$", "type": "Object", "tags": [], "label": "onFiltersPublished$", "description": [], "signature": [ "Subject", "<", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]>" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.onControlRemoved$", "type": "Object", "tags": [], "label": "onControlRemoved$", "description": [], "signature": [ "Subject", "" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.unsavedChanges", "type": "Object", "tags": [], "label": "unsavedChanges", "description": [ "This currently reports the **entire** persistable control group input on unsaved changes" ], "signature": [ "BehaviorSubject", "<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined>" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.fieldFilterPredicate", "type": "Function", "tags": [], "label": "fieldFilterPredicate", "description": [], "signature": [ "FieldFilterPredicate", " | undefined" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.Unnamed.$1", "type": "Object", "tags": [], "label": "reduxToolsPackage", "description": [], "signature": [ { "pluginId": "presentationUtil", "scope": "public", "docId": "kibPresentationUtilPluginApi", "section": "def-public.ReduxToolsPackage", "text": "ReduxToolsPackage" } ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.Unnamed.$2", "type": "Object", "tags": [], "label": "initialInput", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" } ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.Unnamed.$3", "type": "Object", "tags": [], "label": "parent", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.Container", "text": "Container" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.Unnamed.$4", "type": "CompoundType", "tags": [], "label": "initialComponentState", "description": [], "signature": [ "ControlGroupComponentState", " | undefined" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.Unnamed.$5", "type": "Function", "tags": [], "label": "fieldFilterPredicate", "description": [], "signature": [ "FieldFilterPredicate", " | undefined" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.canShowInvalidSelectionsWarning", "type": "Function", "tags": [], "label": "canShowInvalidSelectionsWarning", "description": [], "signature": [ "() => boolean" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.suppressInvalidSelectionsWarning", "type": "Function", "tags": [], "label": "suppressInvalidSelectionsWarning", "description": [], "signature": [ "() => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.reportInvalidSelections", "type": "Function", "tags": [], "label": "reportInvalidSelections", "description": [], "signature": [ "({ id, hasInvalidSelections, }: { id: string; hasInvalidSelections: boolean; }) => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.reportInvalidSelections.$1", "type": "Object", "tags": [], "label": "{\n id,\n hasInvalidSelections,\n }", "description": [], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.reportInvalidSelections.$1.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.reportInvalidSelections.$1.hasInvalidSelections", "type": "boolean", "tags": [], "label": "hasInvalidSelections", "description": [], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.setSavedState", "type": "Function", "tags": [], "label": "setSavedState", "description": [], "signature": [ "(lastSavedInput: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined) => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.setSavedState.$1", "type": "Object", "tags": [], "label": "lastSavedInput", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.resetToLastSavedState", "type": "Function", "tags": [], "label": "resetToLastSavedState", "description": [], "signature": [ "() => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.reload", "type": "Function", "tags": [], "label": "reload", "description": [], "signature": [ "() => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.getPersistableInput", "type": "Function", "tags": [], "label": "getPersistableInput", "description": [], "signature": [ "() => Pick, \"id\" | \"chainingSystem\" | \"ignoreParentSettings\" | \"panels\" | \"controlStyle\" | \"showApplySelections\">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.updateInputAndReinitialize", "type": "Function", "tags": [], "label": "updateInputAndReinitialize", "description": [], "signature": [ "(newInput: Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">) => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.updateInputAndReinitialize.$1", "type": "Object", "tags": [], "label": "newInput", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.setLastUsedDataViewId", "type": "Function", "tags": [], "label": "setLastUsedDataViewId", "description": [], "signature": [ "(lastUsedDataViewId: string) => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.setLastUsedDataViewId.$1", "type": "string", "tags": [], "label": "lastUsedDataViewId", "description": [], "signature": [ "string" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.setRelevantDataViewId", "type": "Function", "tags": [], "label": "setRelevantDataViewId", "description": [], "signature": [ "(newRelevantDataViewId: string) => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.setRelevantDataViewId.$1", "type": "string", "tags": [], "label": "newRelevantDataViewId", "description": [], "signature": [ "string" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.getMostRelevantDataViewId", "type": "Function", "tags": [], "label": "getMostRelevantDataViewId", "description": [], "signature": [ "() => string | undefined" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.closeAllFlyouts", "type": "Function", "tags": [], "label": "closeAllFlyouts", "description": [], "signature": [ "() => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.addDataControlFromField", "type": "Function", "tags": [], "label": "addDataControlFromField", "description": [], "signature": [ "(controlProps: ", "AddDataControlProps", ") => Promise<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", any> | ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.addDataControlFromField.$1", "type": "Object", "tags": [], "label": "controlProps", "description": [], "signature": [ "AddDataControlProps" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.addOptionsListControl", "type": "Function", "tags": [], "label": "addOptionsListControl", "description": [], "signature": [ "(controlProps: ", "AddOptionsListControlProps", ") => Promise<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", any> | ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.addOptionsListControl.$1", "type": "CompoundType", "tags": [], "label": "controlProps", "description": [], "signature": [ "AddOptionsListControlProps" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.addRangeSliderControl", "type": "Function", "tags": [], "label": "addRangeSliderControl", "description": [], "signature": [ "(controlProps: ", "AddRangeSliderControlProps", ") => Promise<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", any> | ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.addRangeSliderControl.$1", "type": "CompoundType", "tags": [], "label": "controlProps", "description": [], "signature": [ "AddRangeSliderControlProps" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.addTimeSliderControl", "type": "Function", "tags": [], "label": "addTimeSliderControl", "description": [], "signature": [ "() => Promise<", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", any> | ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ErrorEmbeddable", "text": "ErrorEmbeddable" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.openAddDataControlFlyout", "type": "Function", "tags": [], "label": "openAddDataControlFlyout", "description": [], "signature": [ "(this: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupContainer", "text": "ControlGroupContainer" }, ", options?: { controlInputTransform?: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlInputTransform", "text": "ControlInputTransform" }, " | undefined; onSave?: ((id: string) => void) | undefined; } | undefined) => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.openAddDataControlFlyout.$1", "type": "Object", "tags": [], "label": "options", "description": [], "signature": [ "{ controlInputTransform?: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlInputTransform", "text": "ControlInputTransform" }, " | undefined; onSave?: ((id: string) => void) | undefined; } | undefined" ], "path": "src/plugins/controls/public/control_group/editor/open_add_data_control_flyout.tsx", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.openEditControlGroupFlyout", "type": "Function", "tags": [], "label": "openEditControlGroupFlyout", "description": [], "signature": [ "(this: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupContainer", "text": "ControlGroupContainer" }, ") => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.getPanelCount", "type": "Function", "tags": [], "label": "getPanelCount", "description": [], "signature": [ "() => number" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.updateFilterContext", "type": "Function", "tags": [], "label": "updateFilterContext", "description": [], "signature": [ "(filters: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]) => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.updateFilterContext.$1", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[]" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.publishFilters", "type": "Function", "tags": [], "label": "publishFilters", "description": [], "signature": [ "({ filters, timeslice }: ", "ControlGroupFilterOutput", ") => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.publishFilters.$1", "type": "CompoundType", "tags": [], "label": "{ filters, timeslice }", "description": [], "signature": [ "ControlGroupFilterOutput" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.createNewPanelState", "type": "Function", "tags": [], "label": "createNewPanelState", "description": [], "signature": [ "(factory: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, "<", "ControlInput", ", ", "ControlOutput", ", ", "ControlEmbeddable", "<", "ControlInput", ", ", "ControlOutput", ">, ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.FinderAttributes", "text": "FinderAttributes" }, ">, partial: Partial | undefined, otherPanels: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlsPanels", "text": "ControlsPanels" }, ") => { newPanel: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlPanelState", "text": "ControlPanelState" }, "; otherPanels: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlsPanels", "text": "ControlsPanels" }, "; }" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.createNewPanelState.$1", "type": "Object", "tags": [], "label": "factory", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactory", "text": "EmbeddableFactory" }, "<", "ControlInput", ", ", "ControlOutput", ", ", "ControlEmbeddable", "<", "ControlInput", ", ", "ControlOutput", ">, ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.FinderAttributes", "text": "FinderAttributes" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.createNewPanelState.$2", "type": "Object", "tags": [], "label": "partial", "description": [], "signature": [ "Partial" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.createNewPanelState.$3", "type": "Object", "tags": [], "label": "otherPanels", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlsPanels", "text": "ControlsPanels" } ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.removePanel", "type": "Function", "tags": [], "label": "removePanel", "description": [], "signature": [ "(id: string) => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.removePanel.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.onRemoveEmbeddable", "type": "Function", "tags": [], "label": "onRemoveEmbeddable", "description": [], "signature": [ "(idToRemove: string) => ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlsPanels", "text": "ControlsPanels" } ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.onRemoveEmbeddable.$1", "type": "string", "tags": [], "label": "idToRemove", "description": [], "signature": [ "string" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.getInheritedInput", "type": "Function", "tags": [], "label": "getInheritedInput", "description": [], "signature": [ "(id: string) => ", "ControlInput" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.getInheritedInput.$1", "type": "string", "tags": [], "label": "id", "description": [], "signature": [ "string" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.untilAllChildrenReady", "type": "Function", "tags": [], "label": "untilAllChildrenReady", "description": [], "signature": [ "() => Promise" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.untilInitialized", "type": "Function", "tags": [], "label": "untilInitialized", "description": [], "signature": [ "() => Promise" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.render", "type": "Function", "tags": [], "label": "render", "description": [], "signature": [ "(dom: HTMLElement) => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.render.$1", "type": "Object", "tags": [], "label": "dom", "description": [], "signature": [ "HTMLElement" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainer.destroy", "type": "Function", "tags": [], "label": "destroy", "description": [], "signature": [ "() => void" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container.tsx", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory", "type": "Class", "tags": [], "label": "ControlGroupContainerFactory", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupContainerFactory", "text": "ControlGroupContainerFactory" }, " implements ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableFactoryDefinition", "text": "EmbeddableFactoryDefinition" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.IEmbeddable", "text": "IEmbeddable" }, "<", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ", ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.EmbeddableOutput", "text": "EmbeddableOutput" }, ", any>, ", { "pluginId": "savedObjectsFinder", "scope": "common", "docId": "kibSavedObjectsFinderPluginApi", "section": "def-common.FinderAttributes", "text": "FinderAttributes" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.isContainerType", "type": "boolean", "tags": [], "label": "isContainerType", "description": [], "signature": [ "true" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"control_group\"" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.inject", "type": "Function", "tags": [], "label": "inject", "description": [], "signature": [ "(state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ", references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]) => ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" } ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.inject.$1", "type": "Uncategorized", "tags": [], "label": "state", "description": [], "signature": [ "P" ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.inject.$2", "type": "Array", "tags": [], "label": "references", "description": [], "signature": [ { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]" ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.extract", "type": "Function", "tags": [], "label": "extract", "description": [], "signature": [ "(state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, ") => { state: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableStateWithType", "text": "EmbeddableStateWithType" }, "; references: ", { "pluginId": "@kbn/core-saved-objects-common", "scope": "common", "docId": "kibKbnCoreSavedObjectsCommonPluginApi", "section": "def-common.SavedObjectReference", "text": "SavedObjectReference" }, "[]; }" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.extract.$1", "type": "Uncategorized", "tags": [], "label": "state", "description": [], "signature": [ "P" ], "path": "src/plugins/kibana_utils/common/persistable_state/types.ts", "deprecated": false, "trackAdoption": false } ] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.Unnamed", "type": "Function", "tags": [], "label": "Constructor", "description": [], "signature": [ "any" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.Unnamed.$1", "type": "Object", "tags": [], "label": "persistableStateService", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddablePersistableStateService", "text": "EmbeddablePersistableStateService" } ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.isEditable", "type": "Function", "tags": [], "label": "isEditable", "description": [], "signature": [ "() => Promise" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.getDisplayName", "type": "Function", "tags": [], "label": "getDisplayName", "description": [], "signature": [ "() => string" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.getDefaultInput", "type": "Function", "tags": [], "label": "getDefaultInput", "description": [], "signature": [ "() => Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.create", "type": "Function", "tags": [], "label": "create", "description": [], "signature": [ "(initialInput: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ", parent?: ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.Container", "text": "Container" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined, initialComponentState?: ", "ControlGroupComponentState", " | undefined, fieldFilterPredicate?: ", "FieldFilterPredicate", " | undefined) => Promise<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupContainer", "text": "ControlGroupContainer" }, ">" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.create.$1", "type": "Object", "tags": [], "label": "initialInput", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" } ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.create.$2", "type": "Object", "tags": [], "label": "parent", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.Container", "text": "Container" }, "<{}, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerInput", "text": "ContainerInput" }, "<{}>, ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, "> | undefined" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.create.$3", "type": "CompoundType", "tags": [], "label": "initialComponentState", "description": [], "signature": [ "ControlGroupComponentState", " | undefined" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupContainerFactory.create.$4", "type": "Function", "tags": [], "label": "fieldFilterPredicate", "description": [], "signature": [ "FieldFilterPredicate", " | undefined" ], "path": "src/plugins/controls/public/control_group/embeddable/control_group_container_factory.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "initialIsOpen": false } ], "functions": [ { "parentPluginId": "controls", "id": "def-public.LazyControlGroupRenderer", "type": "Function", "tags": [], "label": "LazyControlGroupRenderer", "description": [], "signature": [ "(props: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRendererProps", "text": "ControlGroupRendererProps" }, ") => JSX.Element" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer_lazy.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.LazyControlGroupRenderer.$1", "type": "Object", "tags": [], "label": "props", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRendererProps", "text": "ControlGroupRendererProps" } ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer_lazy.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupCreationOptions", "type": "Interface", "tags": [], "label": "ControlGroupCreationOptions", "description": [], "path": "src/plugins/controls/public/control_group/external_api/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupCreationOptions.initialState", "type": "Object", "tags": [], "label": "initialState", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">> | undefined" ], "path": "src/plugins/controls/public/control_group/external_api/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupCreationOptions.editorConfig", "type": "Object", "tags": [], "label": "editorConfig", "description": [], "signature": [ "ControlGroupEditorConfig", " | undefined" ], "path": "src/plugins/controls/public/control_group/external_api/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupInput", "type": "Interface", "tags": [], "label": "ControlGroupInput", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, " extends ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ",", "ControlInput" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupInput.chainingSystem", "type": "CompoundType", "tags": [], "label": "chainingSystem", "description": [], "signature": [ "\"NONE\" | \"HIERARCHICAL\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupInput.defaultControlWidth", "type": "CompoundType", "tags": [], "label": "defaultControlWidth", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlWidth", "text": "ControlWidth" }, " | undefined" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupInput.defaultControlGrow", "type": "CompoundType", "tags": [], "label": "defaultControlGrow", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupInput.controlStyle", "type": "CompoundType", "tags": [], "label": "controlStyle", "description": [], "signature": [ "\"twoLine\" | \"oneLine\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupInput.panels", "type": "Object", "tags": [], "label": "panels", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlsPanels", "text": "ControlsPanels" } ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupInput.showApplySelections", "type": "CompoundType", "tags": [], "label": "showApplySelections", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps", "type": "Interface", "tags": [], "label": "ControlGroupRendererProps", "description": [], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.onApiAvailable", "type": "Function", "tags": [], "label": "onApiAvailable", "description": [], "signature": [ "(api: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRendererApi", "text": "ControlGroupRendererApi" }, ") => void" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.onApiAvailable.$1", "type": "CompoundType", "tags": [], "label": "api", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRendererApi", "text": "ControlGroupRendererApi" } ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.getCreationOptions", "type": "Function", "tags": [], "label": "getCreationOptions", "description": [], "signature": [ "((initialState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, builder: { addDataControlFromField: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.DefaultDataControlState", "text": "DefaultDataControlState" }, ", controlId?: string | undefined) => Promise; addOptionsListControl: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.OptionsListControlState", "text": "OptionsListControlState" }, ", controlId?: string | undefined) => void; addRangeSliderControl: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", "RangesliderControlState", ", controlId?: string | undefined) => void; addTimeSliderControl: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlId?: string | undefined) => void; }) => Promise>) | undefined" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.getCreationOptions.$1", "type": "Object", "tags": [], "label": "initialState", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.getCreationOptions.$2", "type": "Object", "tags": [], "label": "builder", "description": [], "signature": [ "{ addDataControlFromField: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.DefaultDataControlState", "text": "DefaultDataControlState" }, ", controlId?: string | undefined) => Promise; addOptionsListControl: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.OptionsListControlState", "text": "OptionsListControlState" }, ", controlId?: string | undefined) => void; addRangeSliderControl: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", "RangesliderControlState", ", controlId?: string | undefined) => void; addTimeSliderControl: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlId?: string | undefined) => void; }" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.viewMode", "type": "CompoundType", "tags": [], "label": "viewMode", "description": [], "signature": [ { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.ViewMode", "text": "ViewMode" }, " | undefined" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.filters", "type": "Array", "tags": [], "label": "filters", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.timeRange", "type": "Object", "tags": [], "label": "timeRange", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.query", "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererProps.dataLoading", "type": "CompoundType", "tags": [], "label": "dataLoading", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_renderer.tsx", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRuntimeState", "type": "Interface", "tags": [], "label": "ControlGroupRuntimeState", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupRuntimeState.chainingSystem", "type": "CompoundType", "tags": [], "label": "chainingSystem", "description": [], "signature": [ "\"NONE\" | \"HIERARCHICAL\"" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRuntimeState.labelPosition", "type": "CompoundType", "tags": [], "label": "labelPosition", "description": [], "signature": [ "\"twoLine\" | \"oneLine\"" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRuntimeState.autoApplySelections", "type": "boolean", "tags": [], "label": "autoApplySelections", "description": [], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRuntimeState.ignoreParentSettings", "type": "Object", "tags": [], "label": "ignoreParentSettings", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ParentIgnoreSettings", "text": "ParentIgnoreSettings" }, " | undefined" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRuntimeState.initialChildControlState", "type": "Object", "tags": [], "label": "initialChildControlState", "description": [], "signature": [ "ControlPanelsState", "" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRuntimeState.editorConfig", "type": "Object", "tags": [], "label": "editorConfig", "description": [], "signature": [ "ControlGroupEditorConfig", " | undefined" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupSerializedState", "type": "Interface", "tags": [], "label": "ControlGroupSerializedState", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupSerializedState", "text": "ControlGroupSerializedState" }, " extends Pick<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">, \"chainingSystem\" | \"editorConfig\">" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.ControlGroupSerializedState.panelsJSON", "type": "string", "tags": [], "label": "panelsJSON", "description": [], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupSerializedState.ignoreParentSettingsJSON", "type": "string", "tags": [], "label": "ignoreParentSettingsJSON", "description": [], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupSerializedState.controlStyle", "type": "CompoundType", "tags": [], "label": "controlStyle", "description": [], "signature": [ "\"twoLine\" | \"oneLine\"" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupSerializedState.showApplySelections", "type": "CompoundType", "tags": [], "label": "showApplySelections", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.DataControlFactory", "type": "Interface", "tags": [], "label": "DataControlFactory", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.DataControlFactory", "text": "DataControlFactory" }, " extends ", "ControlFactory", "" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.DataControlFactory.isFieldCompatible", "type": "Function", "tags": [], "label": "isFieldCompatible", "description": [], "signature": [ "(field: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewField", "text": "DataViewField" }, ") => boolean" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.DataControlFactory.isFieldCompatible.$1", "type": "Object", "tags": [], "label": "field", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewField", "text": "DataViewField" } ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.DataControlFactory.CustomOptionsComponent", "type": "Function", "tags": [], "label": "CustomOptionsComponent", "description": [], "signature": [ "React.FC<", "CustomOptionsComponentProps", "> | undefined" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.DataControlServices", "type": "Interface", "tags": [], "label": "DataControlServices", "description": [], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.DataControlServices.core", "type": "Object", "tags": [], "label": "core", "description": [], "signature": [ { "pluginId": "@kbn/core-lifecycle-browser", "scope": "public", "docId": "kibKbnCoreLifecycleBrowserPluginApi", "section": "def-public.CoreStart", "text": "CoreStart" } ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.DataControlServices.data", "type": "Object", "tags": [], "label": "data", "description": [], "signature": [ { "pluginId": "data", "scope": "public", "docId": "kibDataPluginApi", "section": "def-public.DataPublicPluginStart", "text": "DataPublicPluginStart" } ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.DataControlServices.dataViews", "type": "Object", "tags": [], "label": "dataViews", "description": [], "signature": [ { "pluginId": "dataViews", "scope": "public", "docId": "kibDataViewsPluginApi", "section": "def-public.DataViewsServicePublic", "text": "DataViewsServicePublic" } ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.DefaultDataControlState", "type": "Interface", "tags": [], "label": "DefaultDataControlState", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.DefaultDataControlState", "text": "DefaultDataControlState" }, " extends ", "DefaultControlState" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.DefaultDataControlState.dataViewId", "type": "string", "tags": [], "label": "dataViewId", "description": [], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.DefaultDataControlState.fieldName", "type": "string", "tags": [], "label": "fieldName", "description": [], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.DefaultDataControlState.title", "type": "string", "tags": [], "label": "title", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.OptionsListControlState", "type": "Interface", "tags": [], "label": "OptionsListControlState", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.OptionsListControlState", "text": "OptionsListControlState" }, " extends ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.DefaultDataControlState", "text": "DefaultDataControlState" }, ",", "OptionsListDisplaySettings" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.OptionsListControlState.searchTechnique", "type": "CompoundType", "tags": [], "label": "searchTechnique", "description": [], "signature": [ "OptionsListSearchTechnique", " | undefined" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.OptionsListControlState.sort", "type": "Object", "tags": [], "label": "sort", "description": [], "signature": [ "OptionsListSortingType", " | undefined" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.OptionsListControlState.selectedOptions", "type": "Array", "tags": [], "label": "selectedOptions", "description": [], "signature": [ "OptionsListSelection", "[] | undefined" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.OptionsListControlState.existsSelected", "type": "CompoundType", "tags": [], "label": "existsSelected", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.OptionsListControlState.runPastTimeout", "type": "CompoundType", "tags": [], "label": "runPastTimeout", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.OptionsListControlState.singleSelect", "type": "CompoundType", "tags": [], "label": "singleSelect", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.OptionsListControlState.exclude", "type": "CompoundType", "tags": [], "label": "exclude", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/options_list_control/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "controls", "id": "def-public.ACTION_DELETE_CONTROL", "type": "string", "tags": [], "label": "ACTION_DELETE_CONTROL", "description": [], "signature": [ "\"deleteControl\"" ], "path": "src/plugins/controls/public/control_group/actions/index.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ACTION_EDIT_CONTROL", "type": "string", "tags": [], "label": "ACTION_EDIT_CONTROL", "description": [], "signature": [ "\"editDataControl\"" ], "path": "src/plugins/controls/public/react_controls/actions/edit_control_action/edit_control_action.tsx", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.CONTROL_GROUP_TYPE", "type": "string", "tags": [], "label": "CONTROL_GROUP_TYPE", "description": [], "signature": [ "\"control_group\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupApi", "type": "Type", "tags": [], "label": "ControlGroupApi", "description": [], "signature": [ { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.PresentationContainer", "text": "PresentationContainer" }, " & ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.DefaultEmbeddableApi", "text": "DefaultEmbeddableApi" }, "<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupSerializedState", "text": "ControlGroupSerializedState" }, ", ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">> & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesFilters", "text": "PublishesFilters" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDataViews", "text": "PublishesDataViews" }, " & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.HasSerializedChildState", "text": "HasSerializedChildState" }, "<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlPanelState", "text": "ControlPanelState" }, "<", "DefaultControlState", ">> & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasEditCapabilities", "text": "HasEditCapabilities" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDataLoading", "text": "PublishesDataLoading" }, " & Pick<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesUnsavedChanges", "text": "PublishesUnsavedChanges" }, "<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, \"unsavedChanges\"> & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesTimeslice", "text": "PublishesTimeslice" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDisabledActionIds", "text": "PublishesDisabledActionIds" }, " & Partial<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasParentApi", "text": "HasParentApi" }, "<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesUnifiedSearch", "text": "PublishesUnifiedSearch" }, "> & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.HasSaveNotification", "text": "HasSaveNotification" }, " & ", "PublishesReload", "> & { allowExpensiveQueries$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; autoApplySelections$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; ignoreParentSettings$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ParentIgnoreSettings", "text": "ParentIgnoreSettings" }, " | undefined>; labelPosition: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "<", "ControlStyle", ">; asyncResetUnsavedChanges: () => Promise; controlFetch$: (controlUuid: string) => ", "Observable", "<", "ControlFetchContext", ">; openAddDataControlFlyout: (options?: { controlStateTransform?: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlStateTransform", "text": "ControlStateTransform" }, "<", "DefaultControlState", "> | undefined; onSave?: (() => void) | undefined; } | undefined) => void; untilInitialized: () => Promise; getEditorConfig: () => ", "ControlGroupEditorConfig", " | undefined; getLastSavedControlState: (controlUuid: string) => object; setChainingSystem: (chainingSystem: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupChainingSystem", "text": "ControlGroupChainingSystem" }, ") => void; }" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupOutput", "type": "Type", "tags": [], "label": "ControlGroupOutput", "description": [], "signature": [ { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.ContainerOutput", "text": "ContainerOutput" }, " & ", "ControlFilterOutput", " & ", "ControlTimesliceOutput", " & { dataViewIds: string[]; }" ], "path": "src/plugins/controls/public/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupRendererApi", "type": "Type", "tags": [], "label": "ControlGroupRendererApi", "description": [], "signature": [ { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.PresentationContainer", "text": "PresentationContainer" }, " & ", { "pluginId": "embeddable", "scope": "public", "docId": "kibEmbeddablePluginApi", "section": "def-public.DefaultEmbeddableApi", "text": "DefaultEmbeddableApi" }, "<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupSerializedState", "text": "ControlGroupSerializedState" }, ", ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">> & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesFilters", "text": "PublishesFilters" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDataViews", "text": "PublishesDataViews" }, " & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.HasSerializedChildState", "text": "HasSerializedChildState" }, "<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlPanelState", "text": "ControlPanelState" }, "<", "DefaultControlState", ">> & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasEditCapabilities", "text": "HasEditCapabilities" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDataLoading", "text": "PublishesDataLoading" }, " & Pick<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesUnsavedChanges", "text": "PublishesUnsavedChanges" }, "<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, \"unsavedChanges\"> & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesTimeslice", "text": "PublishesTimeslice" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDisabledActionIds", "text": "PublishesDisabledActionIds" }, " & Partial<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasParentApi", "text": "HasParentApi" }, "<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesUnifiedSearch", "text": "PublishesUnifiedSearch" }, "> & ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.HasSaveNotification", "text": "HasSaveNotification" }, " & ", "PublishesReload", "> & { allowExpensiveQueries$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; autoApplySelections$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; ignoreParentSettings$: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ParentIgnoreSettings", "text": "ParentIgnoreSettings" }, " | undefined>; labelPosition: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "<", "ControlStyle", ">; asyncResetUnsavedChanges: () => Promise; controlFetch$: (controlUuid: string) => ", "Observable", "<", "ControlFetchContext", ">; openAddDataControlFlyout: (options?: { controlStateTransform?: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlStateTransform", "text": "ControlStateTransform" }, "<", "DefaultControlState", "> | undefined; onSave?: (() => void) | undefined; } | undefined) => void; untilInitialized: () => Promise; getEditorConfig: () => ", "ControlGroupEditorConfig", " | undefined; getLastSavedControlState: (controlUuid: string) => object; setChainingSystem: (chainingSystem: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupChainingSystem", "text": "ControlGroupChainingSystem" }, ") => void; } & { reload: () => void; updateInput: (input: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>) => void; getInput$: () => ", "BehaviorSubject", "<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>; }" ], "path": "src/plugins/controls/public/control_group/external_api/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlGroupStateBuilder", "type": "Type", "tags": [], "label": "ControlGroupStateBuilder", "description": [], "signature": [ "{ addDataControlFromField: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.DefaultDataControlState", "text": "DefaultDataControlState" }, ", controlId?: string | undefined) => Promise; addOptionsListControl: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.OptionsListControlState", "text": "OptionsListControlState" }, ", controlId?: string | undefined) => void; addRangeSliderControl: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", "RangesliderControlState", ", controlId?: string | undefined) => void; addTimeSliderControl: (controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlId?: string | undefined) => void; }" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlPanelState", "type": "Type", "tags": [], "label": "ControlPanelState", "description": [], "signature": [ "State & { type: string; order: number; }" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlStateTransform", "type": "Type", "tags": [], "label": "ControlStateTransform", "description": [ "\n----------------------------------------------------------------\nControl group API\n----------------------------------------------------------------" ], "signature": [ "(newState: Partial, controlType: string) => Partial" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "controls", "id": "def-public.ControlStateTransform.$1", "type": "Object", "tags": [], "label": "newState", "description": [], "signature": [ "{ [P in keyof State]?: State[P] | undefined; }" ], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-public.ControlStateTransform.$2", "type": "string", "tags": [], "label": "controlType", "description": [], "path": "src/plugins/controls/public/react_controls/control_group/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlStyle", "type": "Type", "tags": [], "label": "ControlStyle", "description": [], "signature": [ "\"twoLine\" | \"oneLine\"" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.ControlWidth", "type": "Type", "tags": [], "label": "ControlWidth", "description": [], "signature": [ "\"small\" | \"medium\" | \"large\"" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.DataControlApi", "type": "Type", "tags": [], "label": "DataControlApi", "description": [], "signature": [ { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDataLoading", "text": "PublishesDataLoading" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesBlockingError", "text": "PublishesBlockingError" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesUnsavedChanges", "text": "PublishesUnsavedChanges" }, " & Partial<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesPanelTitle", "text": "PublishesPanelTitle" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDisabledActionIds", "text": "PublishesDisabledActionIds" }, " & ", "HasCustomPrepend", "> & ", "CanClearSelections", " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasType", "text": "HasType" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasUniqueId", "text": "HasUniqueId" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasParentApi", "text": "HasParentApi" }, "<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupApi", "text": "ControlGroupApi" }, "> & { serializeState: () => ", { "pluginId": "@kbn/presentation-containers", "scope": "public", "docId": "kibKbnPresentationContainersPluginApi", "section": "def-public.SerializedPanelState", "text": "SerializedPanelState" }, "<", "DefaultControlState", ">; setDataLoading: (loading: boolean) => void; setBlockingError: (error: Error | undefined) => void; grow: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "; width: ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishingSubject", "text": "PublishingSubject" }, "<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlWidth", "text": "ControlWidth" }, " | undefined>; } & Omit<", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesPanelTitle", "text": "PublishesPanelTitle" }, ", \"hidePanelTitle\"> & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.HasEditCapabilities", "text": "HasEditCapabilities" }, " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesDataViews", "text": "PublishesDataViews" }, " & ", "PublishesField", " & ", { "pluginId": "@kbn/presentation-publishing", "scope": "public", "docId": "kibKbnPresentationPublishingPluginApi", "section": "def-public.PublishesFilters", "text": "PublishesFilters" }, " & { untilFiltersReady: () => Promise; }" ], "path": "src/plugins/controls/public/react_controls/controls/data_controls/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.OPTIONS_LIST_CONTROL", "type": "string", "tags": [], "label": "OPTIONS_LIST_CONTROL", "description": [], "signature": [ "\"optionsListControl\"" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.RANGE_SLIDER_CONTROL", "type": "string", "tags": [], "label": "RANGE_SLIDER_CONTROL", "description": [], "signature": [ "\"rangeSliderControl\"" ], "path": "src/plugins/controls/common/range_slider/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.TIME_SLIDER_CONTROL", "type": "string", "tags": [], "label": "TIME_SLIDER_CONTROL", "description": [], "signature": [ "\"timeSlider\"" ], "path": "src/plugins/controls/common/time_slider/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [ { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder", "type": "Object", "tags": [], "label": "controlGroupInputBuilder", "description": [], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addDataControlFromField", "type": "Function", "tags": [], "label": "addDataControlFromField", "description": [], "signature": [ "(initialInput: Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">, controlProps: ", "AddDataControlProps", ") => Promise" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addDataControlFromField.$1", "type": "Object", "tags": [], "label": "initialInput", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addDataControlFromField.$2", "type": "Object", "tags": [], "label": "controlProps", "description": [], "signature": [ "AddDataControlProps" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addOptionsListControl", "type": "Function", "tags": [], "label": "addOptionsListControl", "description": [], "signature": [ "(initialInput: Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">, controlProps: ", "AddOptionsListControlProps", ") => void" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addOptionsListControl.$1", "type": "Object", "tags": [], "label": "initialInput", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addOptionsListControl.$2", "type": "CompoundType", "tags": [], "label": "controlProps", "description": [], "signature": [ "AddOptionsListControlProps" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addRangeSliderControl", "type": "Function", "tags": [], "label": "addRangeSliderControl", "description": [], "signature": [ "(initialInput: Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">, controlProps: ", "AddRangeSliderControlProps", ") => void" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addRangeSliderControl.$1", "type": "Object", "tags": [], "label": "initialInput", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addRangeSliderControl.$2", "type": "CompoundType", "tags": [], "label": "controlProps", "description": [], "signature": [ "AddRangeSliderControlProps" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addTimeSliderControl", "type": "Function", "tags": [], "label": "addTimeSliderControl", "description": [], "signature": [ "(initialInput: Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">) => void" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupInputBuilder.addTimeSliderControl.$1", "type": "Object", "tags": [], "label": "initialInput", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ">" ], "path": "src/plugins/controls/public/control_group/external_api/control_group_input_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [] } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder", "type": "Object", "tags": [], "label": "controlGroupStateBuilder", "description": [], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addDataControlFromField", "type": "Function", "tags": [], "label": "addDataControlFromField", "description": [], "signature": [ "(controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.DefaultDataControlState", "text": "DefaultDataControlState" }, ", controlId?: string | undefined) => Promise" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addDataControlFromField.$1", "type": "Object", "tags": [], "label": "controlGroupState", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addDataControlFromField.$2", "type": "Object", "tags": [], "label": "controlState", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.DefaultDataControlState", "text": "DefaultDataControlState" } ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addDataControlFromField.$3", "type": "string", "tags": [], "label": "controlId", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addOptionsListControl", "type": "Function", "tags": [], "label": "addOptionsListControl", "description": [], "signature": [ "(controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.OptionsListControlState", "text": "OptionsListControlState" }, ", controlId?: string | undefined) => void" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addOptionsListControl.$1", "type": "Object", "tags": [], "label": "controlGroupState", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addOptionsListControl.$2", "type": "Object", "tags": [], "label": "controlState", "description": [], "signature": [ { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.OptionsListControlState", "text": "OptionsListControlState" } ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addOptionsListControl.$3", "type": "string", "tags": [], "label": "controlId", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addRangeSliderControl", "type": "Function", "tags": [], "label": "addRangeSliderControl", "description": [], "signature": [ "(controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlState: ", "RangesliderControlState", ", controlId?: string | undefined) => void" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addRangeSliderControl.$1", "type": "Object", "tags": [], "label": "controlGroupState", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addRangeSliderControl.$2", "type": "Object", "tags": [], "label": "controlState", "description": [], "signature": [ "RangesliderControlState" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addRangeSliderControl.$3", "type": "string", "tags": [], "label": "controlId", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addTimeSliderControl", "type": "Function", "tags": [], "label": "addTimeSliderControl", "description": [], "signature": [ "(controlGroupState: Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>, controlId?: string | undefined) => void" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addTimeSliderControl.$1", "type": "Object", "tags": [], "label": "controlGroupState", "description": [], "signature": [ "Partial<", { "pluginId": "controls", "scope": "public", "docId": "kibControlsPluginApi", "section": "def-public.ControlGroupRuntimeState", "text": "ControlGroupRuntimeState" }, "<", "DefaultControlState", ">>" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "controls", "id": "def-public.controlGroupStateBuilder.addTimeSliderControl.$2", "type": "string", "tags": [], "label": "controlId", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/controls/public/react_controls/control_group/utils/control_group_state_builder.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [] } ], "initialIsOpen": false } ] }, "server": { "classes": [], "functions": [ { "parentPluginId": "controls", "id": "def-server.initializeControlGroupTelemetry", "type": "Function", "tags": [], "label": "initializeControlGroupTelemetry", "description": [], "signature": [ "(statsSoFar: Record) => ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupTelemetry", "text": "ControlGroupTelemetry" } ], "path": "src/plugins/controls/server/control_group/control_group_telemetry.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-server.initializeControlGroupTelemetry.$1", "type": "Object", "tags": [], "label": "statsSoFar", "description": [], "signature": [ "Record" ], "path": "src/plugins/controls/server/control_group/control_group_telemetry.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "controls", "id": "def-common.getDefaultControlGroupInput", "type": "Function", "tags": [], "label": "getDefaultControlGroupInput", "description": [], "signature": [ "() => Omit<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, ", \"id\">" ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.getDefaultControlGroupPersistableInput", "type": "Function", "tags": [], "label": "getDefaultControlGroupPersistableInput", "description": [], "signature": [ "() => ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" } ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "children": [], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.persistableControlGroupInputIsEqual", "type": "Function", "tags": [], "label": "persistableControlGroupInputIsEqual", "description": [], "signature": [ "(a: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined, b: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined, compareSelections?: boolean) => boolean" ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.persistableControlGroupInputIsEqual.$1", "type": "Object", "tags": [], "label": "a", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined" ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "controls", "id": "def-common.persistableControlGroupInputIsEqual.$2", "type": "Object", "tags": [], "label": "b", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined" ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "controls", "id": "def-common.persistableControlGroupInputIsEqual.$3", "type": "boolean", "tags": [], "label": "compareSelections", "description": [], "signature": [ "boolean" ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.rawControlGroupAttributesToControlGroupInput", "type": "Function", "tags": [], "label": "rawControlGroupAttributesToControlGroupInput", "description": [], "signature": [ "(rawControlGroupAttributes: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.RawControlGroupAttributes", "text": "RawControlGroupAttributes" }, ") => ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, " | undefined" ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.rawControlGroupAttributesToControlGroupInput.$1", "type": "CompoundType", "tags": [], "label": "rawControlGroupAttributes", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.RawControlGroupAttributes", "text": "RawControlGroupAttributes" } ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.rawControlGroupAttributesToSerializable", "type": "Function", "tags": [], "label": "rawControlGroupAttributesToSerializable", "description": [], "signature": [ "(rawControlGroupAttributes: Omit<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.RawControlGroupAttributes", "text": "RawControlGroupAttributes" }, ", \"id\">) => ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" } ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.rawControlGroupAttributesToSerializable.$1", "type": "Object", "tags": [], "label": "rawControlGroupAttributes", "description": [], "signature": [ "Omit<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.RawControlGroupAttributes", "text": "RawControlGroupAttributes" }, ", \"id\">" ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.serializableToRawControlGroupAttributes", "type": "Function", "tags": [], "label": "serializableToRawControlGroupAttributes", "description": [], "signature": [ "(serializable: ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, ") => Omit<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.RawControlGroupAttributes", "text": "RawControlGroupAttributes" }, ", \"id\" | \"type\">" ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.serializableToRawControlGroupAttributes.$1", "type": "Object", "tags": [], "label": "serializable", "description": [], "signature": [ { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" } ], "path": "src/plugins/controls/common/control_group/control_group_persistence.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "controls", "id": "def-common.ControlGroupInput", "type": "Interface", "tags": [], "label": "ControlGroupInput", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupInput", "text": "ControlGroupInput" }, " extends ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.EmbeddableInput", "text": "EmbeddableInput" }, ",", "ControlInput" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.ControlGroupInput.chainingSystem", "type": "CompoundType", "tags": [], "label": "chainingSystem", "description": [], "signature": [ "\"NONE\" | \"HIERARCHICAL\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupInput.defaultControlWidth", "type": "CompoundType", "tags": [], "label": "defaultControlWidth", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlWidth", "text": "ControlWidth" }, " | undefined" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupInput.defaultControlGrow", "type": "CompoundType", "tags": [], "label": "defaultControlGrow", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupInput.controlStyle", "type": "CompoundType", "tags": [], "label": "controlStyle", "description": [], "signature": [ "\"twoLine\" | \"oneLine\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupInput.panels", "type": "Object", "tags": [], "label": "panels", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlsPanels", "text": "ControlsPanels" } ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupInput.showApplySelections", "type": "CompoundType", "tags": [], "label": "showApplySelections", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupTelemetry", "type": "Interface", "tags": [], "label": "ControlGroupTelemetry", "description": [], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.ControlGroupTelemetry.total", "type": "number", "tags": [], "label": "total", "description": [], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupTelemetry.chaining_system", "type": "Object", "tags": [], "label": "chaining_system", "description": [], "signature": [ "{ [key: string]: number; }" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupTelemetry.label_position", "type": "Object", "tags": [], "label": "label_position", "description": [], "signature": [ "{ [key: string]: number; }" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupTelemetry.ignore_settings", "type": "Object", "tags": [], "label": "ignore_settings", "description": [], "signature": [ "{ [key: string]: number; }" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupTelemetry.by_type", "type": "Object", "tags": [], "label": "by_type", "description": [], "signature": [ "{ [key: string]: { total: number; details: { [key: string]: number; }; }; }" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.ControlPanelState", "type": "Interface", "tags": [], "label": "ControlPanelState", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlPanelState", "text": "ControlPanelState" }, " extends ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.PanelState", "text": "PanelState" }, "" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.ControlPanelState.order", "type": "number", "tags": [], "label": "order", "description": [], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlPanelState.width", "type": "CompoundType", "tags": [], "label": "width", "description": [], "signature": [ "\"small\" | \"medium\" | \"large\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlPanelState.grow", "type": "boolean", "tags": [], "label": "grow", "description": [], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.ControlsPanels", "type": "Interface", "tags": [], "label": "ControlsPanels", "description": [], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.ControlsPanels.Unnamed", "type": "IndexSignature", "tags": [], "label": "[panelId: string]: ControlPanelState", "description": [], "signature": [ "[panelId: string]: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlPanelState", "text": "ControlPanelState" }, "<", "ControlInput", ">" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput", "type": "Interface", "tags": [], "label": "OptionsListEmbeddableInput", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.OptionsListEmbeddableInput", "text": "OptionsListEmbeddableInput" }, " extends ", "DataControlInput" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.searchTechnique", "type": "CompoundType", "tags": [], "label": "searchTechnique", "description": [], "signature": [ "OptionsListSearchTechnique", " | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.sort", "type": "Object", "tags": [], "label": "sort", "description": [], "signature": [ "OptionsListSortingType", " | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.selectedOptions", "type": "Array", "tags": [], "label": "selectedOptions", "description": [], "signature": [ "OptionsListSelection", "[] | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.existsSelected", "type": "CompoundType", "tags": [], "label": "existsSelected", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.runPastTimeout", "type": "CompoundType", "tags": [], "label": "runPastTimeout", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.singleSelect", "type": "CompoundType", "tags": [], "label": "singleSelect", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.hideActionBar", "type": "CompoundType", "tags": [], "label": "hideActionBar", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.hideExclude", "type": "CompoundType", "tags": [], "label": "hideExclude", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.hideExists", "type": "CompoundType", "tags": [], "label": "hideExists", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.placeholder", "type": "string", "tags": [], "label": "placeholder", "description": [], "signature": [ "string | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.hideSort", "type": "CompoundType", "tags": [], "label": "hideSort", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.OptionsListEmbeddableInput.exclude", "type": "CompoundType", "tags": [], "label": "exclude", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.ParentIgnoreSettings", "type": "Interface", "tags": [], "label": "ParentIgnoreSettings", "description": [], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.ParentIgnoreSettings.ignoreFilters", "type": "CompoundType", "tags": [], "label": "ignoreFilters", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ParentIgnoreSettings.ignoreQuery", "type": "CompoundType", "tags": [], "label": "ignoreQuery", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ParentIgnoreSettings.ignoreTimerange", "type": "CompoundType", "tags": [], "label": "ignoreTimerange", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ParentIgnoreSettings.ignoreValidations", "type": "CompoundType", "tags": [], "label": "ignoreValidations", "description": [], "signature": [ "boolean | undefined" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.RangeSliderEmbeddableInput", "type": "Interface", "tags": [], "label": "RangeSliderEmbeddableInput", "description": [], "signature": [ { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.RangeSliderEmbeddableInput", "text": "RangeSliderEmbeddableInput" }, " extends ", "DataControlInput" ], "path": "src/plugins/controls/common/range_slider/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "controls", "id": "def-common.RangeSliderEmbeddableInput.value", "type": "Object", "tags": [], "label": "value", "description": [], "signature": [ "RangeValue", " | undefined" ], "path": "src/plugins/controls/common/range_slider/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.RangeSliderEmbeddableInput.step", "type": "number", "tags": [], "label": "step", "description": [], "signature": [ "number | undefined" ], "path": "src/plugins/controls/common/range_slider/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [], "misc": [ { "parentPluginId": "controls", "id": "def-common.CONTROL_GROUP_TYPE", "type": "string", "tags": [], "label": "CONTROL_GROUP_TYPE", "description": [], "signature": [ "\"control_group\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.ControlGroupChainingSystem", "type": "Type", "tags": [], "label": "ControlGroupChainingSystem", "description": [], "signature": [ "\"NONE\" | \"HIERARCHICAL\"" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.ControlInputTransform", "type": "Type", "tags": [], "label": "ControlInputTransform", "description": [], "signature": [ "(newState: Partial<", "ControlInput", ">, controlType: string) => Partial<", "ControlInput", ">" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false, "returnComment": [], "children": [ { "parentPluginId": "controls", "id": "def-common.ControlInputTransform.$1", "type": "Object", "tags": [], "label": "newState", "description": [], "signature": [ "{ version?: string | undefined; viewMode?: ", { "pluginId": "embeddable", "scope": "common", "docId": "kibEmbeddablePluginApi", "section": "def-common.ViewMode", "text": "ViewMode" }, " | undefined; title?: string | undefined; description?: string | undefined; id?: string | undefined; lastReloadRequestTime?: number | undefined; hidePanelTitles?: boolean | undefined; enhancements?: ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, " | undefined; disabledActions?: string[] | undefined; disableTriggers?: boolean | undefined; searchSessionId?: string | undefined; syncColors?: boolean | undefined; syncCursor?: boolean | undefined; syncTooltips?: boolean | undefined; executionContext?: ", { "pluginId": "@kbn/core-execution-context-common", "scope": "common", "docId": "kibKbnCoreExecutionContextCommonPluginApi", "section": "def-common.KibanaExecutionContext", "text": "KibanaExecutionContext" }, " | undefined; query?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Query", "text": "Query" }, " | undefined; filters?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.Filter", "text": "Filter" }, "[] | undefined; timeRange?: ", { "pluginId": "@kbn/es-query", "scope": "common", "docId": "kibKbnEsQueryPluginApi", "section": "def-common.TimeRange", "text": "TimeRange" }, " | undefined; timeslice?: ", "TimeSlice", " | undefined; controlStyle?: ", "ControlStyle", " | undefined; ignoreParentSettings?: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ParentIgnoreSettings", "text": "ParentIgnoreSettings" }, " | undefined; }" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "controls", "id": "def-common.ControlInputTransform.$2", "type": "string", "tags": [], "label": "controlType", "description": [], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.ControlWidth", "type": "Type", "tags": [], "label": "ControlWidth", "description": [], "signature": [ "\"small\" | \"medium\" | \"large\"" ], "path": "src/plugins/controls/common/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.DEFAULT_CONTROL_GROW", "type": "boolean", "tags": [], "label": "DEFAULT_CONTROL_GROW", "description": [], "path": "src/plugins/controls/common/control_group/control_group_constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.DEFAULT_CONTROL_STYLE", "type": "CompoundType", "tags": [], "label": "DEFAULT_CONTROL_STYLE", "description": [], "signature": [ "\"twoLine\" | \"oneLine\"" ], "path": "src/plugins/controls/common/control_group/control_group_constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.DEFAULT_CONTROL_WIDTH", "type": "CompoundType", "tags": [], "label": "DEFAULT_CONTROL_WIDTH", "description": [], "signature": [ "\"small\" | \"medium\" | \"large\"" ], "path": "src/plugins/controls/common/control_group/control_group_constants.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.OPTIONS_LIST_CONTROL", "type": "string", "tags": [], "label": "OPTIONS_LIST_CONTROL", "description": [], "signature": [ "\"optionsListControl\"" ], "path": "src/plugins/controls/common/options_list/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.PersistableControlGroupInput", "type": "Type", "tags": [], "label": "PersistableControlGroupInput", "description": [], "signature": [ "{ chainingSystem: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlGroupChainingSystem", "text": "ControlGroupChainingSystem" }, "; ignoreParentSettings?: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ParentIgnoreSettings", "text": "ParentIgnoreSettings" }, " | undefined; panels: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlsPanels", "text": "ControlsPanels" }, "; controlStyle: ", "ControlStyle", "; showApplySelections?: boolean | undefined; }" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.persistableControlGroupInputKeys", "type": "Array", "tags": [], "label": "persistableControlGroupInputKeys", "description": [ "\nOnly parts of the Control Group Input should be persisted" ], "signature": [ "(\"chainingSystem\" | \"ignoreParentSettings\" | \"panels\" | \"controlStyle\" | \"showApplySelections\")[]" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.RANGE_SLIDER_CONTROL", "type": "string", "tags": [], "label": "RANGE_SLIDER_CONTROL", "description": [], "signature": [ "\"rangeSliderControl\"" ], "path": "src/plugins/controls/common/range_slider/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.RawControlGroupAttributes", "type": "Type", "tags": [], "label": "RawControlGroupAttributes", "description": [], "signature": [ "Omit<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, ", \"ignoreParentSettings\" | \"panels\"> & { ignoreParentSettingsJSON: string; panelsJSON: string; }" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.SerializableControlGroupInput", "type": "Type", "tags": [], "label": "SerializableControlGroupInput", "description": [ "\nSome use cases need the Persistable Control Group Input to conform to the SerializableRecord format which requires string index signatures in any objects" ], "signature": [ "Omit<", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.PersistableControlGroupInput", "text": "PersistableControlGroupInput" }, ", \"ignoreParentSettings\" | \"panels\"> & { panels: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ControlsPanels", "text": "ControlsPanels" }, " & ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, "; ignoreParentSettings: ", { "pluginId": "controls", "scope": "common", "docId": "kibControlsPluginApi", "section": "def-common.ParentIgnoreSettings", "text": "ParentIgnoreSettings" }, " & ", { "pluginId": "@kbn/utility-types", "scope": "common", "docId": "kibKbnUtilityTypesPluginApi", "section": "def-common.SerializableRecord", "text": "SerializableRecord" }, "; }" ], "path": "src/plugins/controls/common/control_group/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "controls", "id": "def-common.TIME_SLIDER_CONTROL", "type": "string", "tags": [], "label": "TIME_SLIDER_CONTROL", "description": [], "signature": [ "\"timeSlider\"" ], "path": "src/plugins/controls/common/time_slider/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }