kibana/api_docs/kbn_ml_url_state.devdocs.json

762 lines
No EOL
25 KiB
JSON

{
"id": "@kbn/ml-url-state",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService",
"type": "Class",
"tags": [],
"label": "UrlStateService",
"description": [
"\nService for managing URL state of particular page."
],
"signature": [
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.UrlStateService",
"text": "UrlStateService"
},
"<T>"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService.getUrlState$",
"type": "Function",
"tags": [],
"label": "getUrlState$",
"description": [
"\nProvides updates for the page URL state."
],
"signature": [
"() => ",
"Observable",
"<T>"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService.getUrlState",
"type": "Function",
"tags": [],
"label": "getUrlState",
"description": [],
"signature": [
"() => T | null"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService.updateUrlState",
"type": "Function",
"tags": [],
"label": "updateUrlState",
"description": [],
"signature": [
"(update: Partial<T>, replaceState?: boolean | undefined) => void"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService.updateUrlState.$1",
"type": "Object",
"tags": [],
"label": "update",
"description": [],
"signature": [
"Partial<T>"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService.updateUrlState.$2",
"type": "CompoundType",
"tags": [],
"label": "replaceState",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService.setCurrentState",
"type": "Function",
"tags": [],
"label": "setCurrentState",
"description": [
"\nPopulates internal subject with currently active state."
],
"signature": [
"(currentState: T) => void"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService.setCurrentState.$1",
"type": "Uncategorized",
"tags": [],
"label": "currentState",
"description": [],
"signature": [
"T"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService.setUpdateCallback",
"type": "Function",
"tags": [],
"label": "setUpdateCallback",
"description": [
"\nSets the callback for the state update."
],
"signature": [
"(callback: (update: Partial<T>, replaceState?: boolean | undefined) => void) => void"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateService.setUpdateCallback.$1",
"type": "Function",
"tags": [],
"label": "callback",
"description": [],
"signature": [
"(update: Partial<T>, replaceState?: boolean | undefined) => void"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.isRisonSerializationRequired",
"type": "Function",
"tags": [],
"label": "isRisonSerializationRequired",
"description": [
"\nChecks if the URL query parameter requires rison serialization."
],
"signature": [
"(queryParam: string) => boolean"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.isRisonSerializationRequired.$1",
"type": "string",
"tags": [],
"label": "queryParam",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.parseUrlState",
"type": "Function",
"tags": [],
"label": "parseUrlState",
"description": [],
"signature": [
"(search: string) => ",
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.Dictionary",
"text": "Dictionary"
},
"<any>"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.parseUrlState.$1",
"type": "string",
"tags": [],
"label": "search",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.Provider",
"type": "Function",
"tags": [],
"label": "Provider",
"description": [],
"signature": [
"React.ProviderExoticComponent<React.ProviderProps<",
"UrlState",
">>"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.Provider.$1",
"type": "Uncategorized",
"tags": [],
"label": "props",
"description": [],
"signature": [
"P"
],
"path": "node_modules/@types/react/ts5.0/index.d.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateProvider",
"type": "Function",
"tags": [],
"label": "UrlStateProvider",
"description": [],
"signature": [
"({ children }: { children?: React.ReactNode; }) => React.JSX.Element"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.UrlStateProvider.$1",
"type": "Object",
"tags": [],
"label": "{ children }",
"description": [],
"signature": [
"{ children?: React.ReactNode; }"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.usePageUrlState",
"type": "Function",
"tags": [],
"label": "usePageUrlState",
"description": [
"\nHook for managing the URL state of the page."
],
"signature": [
"<T extends ",
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.PageUrlState",
"text": "PageUrlState"
},
">(pageKey: T[\"pageKey\"], defaultState?: T[\"pageUrlState\"] | undefined) => [T[\"pageUrlState\"], (update: Partial<T[\"pageUrlState\"]>, replaceState?: boolean | undefined) => void, ",
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.UrlStateService",
"text": "UrlStateService"
},
"<T[\"pageUrlState\"]>]"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.usePageUrlState.$1",
"type": "Uncategorized",
"tags": [],
"label": "pageKey",
"description": [],
"signature": [
"T[\"pageKey\"]"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.usePageUrlState.$2",
"type": "Uncategorized",
"tags": [],
"label": "defaultState",
"description": [],
"signature": [
"T[\"pageUrlState\"] | undefined"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.useUrlState",
"type": "Function",
"tags": [],
"label": "useUrlState",
"description": [],
"signature": [
"(accessor: ",
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.Accessor",
"text": "Accessor"
},
") => [Record<string, any>, (attribute: string | ",
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.Dictionary",
"text": "Dictionary"
},
"<unknown>, value?: unknown, replaceState?: boolean | undefined) => void]"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.useUrlState.$1",
"type": "CompoundType",
"tags": [],
"label": "accessor",
"description": [],
"signature": [
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.Accessor",
"text": "Accessor"
}
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.Dictionary",
"type": "Interface",
"tags": [],
"label": "Dictionary",
"description": [],
"signature": [
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.Dictionary",
"text": "Dictionary"
},
"<TValue>"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.Dictionary.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[id: string]: TValue",
"description": [],
"signature": [
"[id: string]: TValue"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.ListingPageUrlState",
"type": "Interface",
"tags": [],
"label": "ListingPageUrlState",
"description": [],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.ListingPageUrlState.pageSize",
"type": "number",
"tags": [],
"label": "pageSize",
"description": [],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.ListingPageUrlState.pageIndex",
"type": "number",
"tags": [],
"label": "pageIndex",
"description": [],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.ListingPageUrlState.sortField",
"type": "string",
"tags": [],
"label": "sortField",
"description": [],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.ListingPageUrlState.sortDirection",
"type": "string",
"tags": [],
"label": "sortDirection",
"description": [],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.ListingPageUrlState.queryText",
"type": "string",
"tags": [],
"label": "queryText",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.ListingPageUrlState.showPerPageOptions",
"type": "CompoundType",
"tags": [],
"label": "showPerPageOptions",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.ListingPageUrlState.showAll",
"type": "CompoundType",
"tags": [],
"label": "showAll",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.PageUrlState",
"type": "Interface",
"tags": [],
"label": "PageUrlState",
"description": [],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.PageUrlState.pageKey",
"type": "string",
"tags": [],
"label": "pageKey",
"description": [],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.PageUrlState.pageUrlState",
"type": "Uncategorized",
"tags": [],
"label": "pageUrlState",
"description": [],
"signature": [
"object"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.Accessor",
"type": "Type",
"tags": [],
"label": "Accessor",
"description": [],
"signature": [
"\"_a\" | \"_g\""
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.SetUrlState",
"type": "Type",
"tags": [],
"label": "SetUrlState",
"description": [],
"signature": [
"(accessor: ",
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.Accessor",
"text": "Accessor"
},
", attribute: string | ",
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.Dictionary",
"text": "Dictionary"
},
"<any>, value?: any, replaceState?: boolean | undefined) => void"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.SetUrlState.$1",
"type": "CompoundType",
"tags": [],
"label": "accessor",
"description": [],
"signature": [
"\"_a\" | \"_g\""
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.SetUrlState.$2",
"type": "CompoundType",
"tags": [],
"label": "attribute",
"description": [],
"signature": [
"string | ",
{
"pluginId": "@kbn/ml-url-state",
"scope": "common",
"docId": "kibKbnMlUrlStatePluginApi",
"section": "def-common.Dictionary",
"text": "Dictionary"
},
"<any>"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.SetUrlState.$3",
"type": "Any",
"tags": [],
"label": "value",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "@kbn/ml-url-state",
"id": "def-common.SetUrlState.$4",
"type": "CompoundType",
"tags": [],
"label": "replaceState",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/private/ml/url_state/src/url_state.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"objects": []
}
}