Skip to content

(beta) OpenSearch Dashboards Dev Docs

Query state syncing utilities

Initializing search

(beta) OpenSearch Dashboards Dev Docs

Welcome to OpenSearch Dashboards Dev Docs
Nulla currum
Deep clean
Static Files
Core plugins
Core plugins
- Console
  Console
  - Console Plugin
Debugging and troubleshooting
Debugging and troubleshooting
- Investigating Security Issues
Development
Development
- Using bundled plugins in local development
External plugins
External plugins
- I18n plugin
  I18n plugin
Generated api docs
Generated api docs
- Markdown
  Markdown
Packages
Packages
- Osdpm
Plugins
Plugins
Releasing
Releasing
- Building OpenSearch Dashboards
- Release Cycle
Services
Services
- Chrome
  Chrome
  - Breadcrumbs
Source
Source
- Apis
  Apis
- Readmes
  Readmes
  - Index
  - Examples
    Examples
    
    Dashboard embeddable examples
    Dashboard embeddable examples
    
    Index
    
    Developer examples
    Developer examples
    
    Index
    
    Embeddable examples
    Embeddable examples
    
    Public
    Public
    
    Todo
    Todo
    
    Index
    
    Expressions example
    Expressions example
    
    expressions_example
    
    Routing example
    Routing example
    
    Index
    
    Search examples
    Search examples
    
    search_examples
    
    Ui action examples
    Ui action examples
    
    Index
    
    Ui actions explorer
    Ui actions explorer
    
    Index
    
    Url generators examples
    Url generators examples
    
    Index
    
    Url generators explorer
    Url generators explorer
    
    Index
  - Packages
    Packages
    
    OpenSearch Dashboards-related packages
    
    Opensearch eslint config opensearch dashboards
    Opensearch eslint config opensearch dashboards
    
    opensearch-eslint-config-opensearch-dashboards
    
    Opensearch safer lodash set
    Opensearch safer lodash set
    
    @elastic/safer-lodash-set
    
    Osd ace
    Osd ace
    
    @osd/ace
    
    Osd apm config loader
    Osd apm config loader
    
    @osd/apm-config-loader
    
    Osd babel preset
    Osd babel preset
    
    @osd/babel-preset
    
    Osd config
    Osd config
    
    `@osd/config` — OpenSearch Dashboards configuration file loader
    
    Osd config schema
    Osd config schema
    
    `@osd/config-schema` — The OpenSearch Dashboards config validation library
    
    Osd dev utils
    Osd dev utils
    
    dev utils
    
    Certs
    Certs
    
    Development certificates
    
    Src
    Src
    
    Ci stats reporter
    Ci stats reporter
    
    OpenSearch Dashboards CI Stats reporter
    
    Run
    Run
    
    @osd/dev-utils > run()
    
    Osd eslint import resolver opensearch dashboards
    Osd eslint import resolver opensearch dashboards
    
    @osd/eslint-import-resolver-opensearch-dashboards
    
    Osd eslint plugin eslint
    Osd eslint plugin eslint
    
    Custom ESLint rules for OpenSearch Dashboards
    
    Osd expect
    Osd expect
    
    Index
    
    Osd i18n
    Osd i18n
    
    I18n
    
    Osd logging
    Osd logging
    
    osd-logging
    
    Osd monaco
    Osd monaco
    
    @osd/monaco
    
    Src
    Src
    
    Xjson
    Xjson
    
    README
    
    Osd opensearch
    Osd opensearch
    
    @osd/opensearch
    
    Osd optimizer
    Osd optimizer
    
    @osd/optimizer
    
    Osd plugin generator
    Osd plugin generator
    
    OpenSearch Dashboards Plugin Generator
    
    Osd plugin helpers
    Osd plugin helpers
    
    @osd/plugin-helpers
    
    Osd pm
    Osd pm
    
    `@osd/pm` — The OpenSearch Dashboards project management tool
    
    Osd spec to console
    Osd spec to console
    
    Index
    
    Osd std
    Osd std
    
    `@osd/std` — OpenSearch Dashboards standard library
    
    Osd telemetry tools
    Osd telemetry tools
    
    Telemetry Tools
    
    Osd test
    Osd test
    
    Index
    
    Src
    Src
    
    Failed tests reporter
    Failed tests reporter
    
    failed tests reporter
    
    Functional test runner
    Functional test runner
    
    Lib
    Lib
    
    Docker servers
    Docker servers
    
    Functional Test Runner - Docker Servers
    
    Types
    Types
    
    @osd/test/types
    
    Osd test subj selector
    Osd test subj selector
    
    test-subj-selector
    
    Osd ui framework
    Osd ui framework
    
    OpenSearch Dashboards UI Framework - Deprecation Notice
    
    Osd ui shared deps
    Osd ui shared deps
    
    `@osd/ui-shared-deps`
    
    Osd utility types
    Osd utility types
    
    `@osd/utility-types`
    
    Osd utils
    Osd utils
    
    @osd/utils
  - Scripts
    Scripts
    
    OpenSearch Dashboards Dev Scripts
  - Src
    Src
    
    Core
    Core
    
    Core
    
    Public
    Public
    
    Chrome
    Chrome
    
    Index
    
    Server
    Server
    
    Logging
    Logging
    
    Logging
    
    Saved objects
    Saved objects
    
    Migrations
    Migrations
    
    Saved Object Migrations
    
    Utils
    Utils
    
    Crypto
    Crypto
    
    fixtures
    fixtures
    
    PKCS12 Test Fixtures
    
    Dev
    Dev
    
    Build
    Build
    
    dev/build
    
    I18n
    I18n
    
    I18n Tools
    
    Plugins
    Plugins
    
    Bfetch
    Bfetch
    
    `bfetch` plugin
    
    Charts
    Charts
    
    Charts
    
    Public
    Public
    
    Services
    Services
    
    Theme
    Theme
    
    Theme Service
    
    Console
    Console
    
    Public
    Public
    
    Application
    Application
    
    Hooks
    Hooks
    
    Index
    
    Dashboard
    Dashboard
    
    Index
    
    Data
    Data
    
    data
    
    Public
    Public
    
    Query
    Query
    
    State sync
    State sync
    
    Query state syncing utilities
    
    Server
    Server
    
    Search
    Search
    
    search
    
    Dev tools
    Dev tools
    
    Dev tools plugin
    
    Discover
    Discover
    
    Index
    
    Embeddable
    Embeddable
    
    Embeddables
    
    Docs
    Docs
    
    Embeddable Docs, Guides & Caveats
    
    Expressions
    Expressions
    
    `expressions` plugin
    
    Home
    Home
    
    home plugin
    
    Input control vis
    Input control vis
    
    Index
    
    Inspector
    Inspector
    
    Inspector
    
    Navigation
    Navigation
    
    navigation
    
    Opensearch dashboards legacy
    Opensearch dashboards legacy
    
    OpenSearch-Dashboards-legacy
    
    Opensearch dashboards overview
    Opensearch dashboards overview
    
    opensearch-dashboards-overview
    
    Opensearch dashboards react
    Opensearch dashboards react
    
    `opensearch-dashboards-react`
    
    Public
    Public
    
    Code editor
    Code editor
    
    Code Editor Component
    
    Opensearch dashboards usage collection
    Opensearch dashboards usage collection
    
    OpenSearch Dashboards Usage Collection
    
    Server
    Server
    
    Collectors
    Collectors
    
    Application usage
    Application usage
    
    Application Usage
    
    Opensearch dashboards utils
    Opensearch dashboards utils
    
    opensearch-dashboards-utils
    
    Common
    Common
    
    State containers
    State containers
    
    Index
    
    Docs
    Docs
    
    State containers
    State containers
    
    State containers
    
    State sync
    State sync
    
    State Syncing Utilities
    
    Storages
    Storages
    
    State Storage
    
    Public
    Public
    
    State sync
    State sync
    
    Index
    
    Opensearch ui shared
    Opensearch ui shared
    
    Public
    Public
    
    Forms
    Forms
    
    Form wizard
    Form wizard
    
    FormWizard
    
    Multi content
    Multi content
    
    MultiContent
    
    Saved objects management
    Saved objects management
    
    Saved objects management
    
    Share
    Share
    
    Share plugin
    
    Public
    Public
    
    Url generators
    Url generators
    
    Index
    
    Telemetry
    Telemetry
    
    OpenSearch Dashboards Telemetry Service
    
    Telemetry collection manager
    Telemetry collection manager
    
    Telemetry Collection Manager
    
    Telemetry management section
    Telemetry management section
    
    Telemetry Management Section
    
    Timeline
    Timeline
    
    Index
    
    Ui actions
    Ui actions
    
    UI Actions
    
    Public
    Public
    
    Tests
    Tests
    
    Index
    
    Url forwarding
    Url forwarding
    
    url-forwarding
    
    Usage collection
    Usage collection
    
    OpenSearch Dashboards Usage Collection Service
    
    Server
    Server
    
    Routes
    Routes
    
    Stats
    Stats
    
    `/api/stats`
    
    Vis default editor
    Vis default editor
    
    Visualization Deafult Editor plugin
    
    Vis type markdown
    Vis type markdown
    
    Index
    
    Vis type metric
    Vis type metric
    
    Index
    
    Vis type table
    Vis type table
    
    Index
    
    Vis type tagcloud
    Vis type tagcloud
    
    Index
    
    Vis type timeline
    Vis type timeline
    
    Vis type Timeline
    
    Vis type timeseries
    Vis type timeseries
    
    Index
    
    Vis type vega
    Vis type vega
    
    Index
    
    Vis type vislib
    Vis type vislib
    
    Index
    
    Vis type xy
    Vis type xy
    
    Index
    
    Visualizations
    Visualizations
    
    Index
    
    Visualize
    Visualize
    
    Index
    
    Wizard
    Wizard
    
    Wizard
  - Test
    Test
    
    Examples
    Examples
    
    Example plugin functional tests
    
    Functional
    Functional
    
    Fixtures
    Fixtures
    
    Opensearch archiver
    Opensearch archiver
    
    Index
    
    Interpreter functional
    Interpreter functional
    
    Interpreter Functional Tests
    
    Plugin functional
    Plugin functional
    
    Plugin Functional Tests
    
    Plugins
    Plugins
    
    Osd tp custom visualizations
    Osd tp custom visualizations
    
    Custom visualizations
    
    Server integration
    Server integration
    
    fixtures
    fixtures
    
    HTTP SSL Test Fixtures
Upstream readmes
Upstream readmes
- Index
- Examples
  Examples
  - Dashboard embeddable examples
    Dashboard embeddable examples
    
    Index
  - Developer examples
    Developer examples
    
    Index
  - Embeddable examples
    Embeddable examples
    
    Public
    Public
    
    Todo
    Todo
    
    Index
  - Expressions example
    Expressions example
    
    expressions_example
  - Routing example
    Routing example
    
    Index
  - Search examples
    Search examples
    
    search_examples
  - Ui action examples
    Ui action examples
    
    Index
  - Ui actions explorer
    Ui actions explorer
    
    Index
  - Url generators examples
    Url generators examples
    
    Index
  - Url generators explorer
    Url generators explorer
    
    Index
- Packages
  Packages
  - OpenSearch Dashboards-related packages
  - Opensearch eslint config opensearch dashboards
    Opensearch eslint config opensearch dashboards
    
    opensearch-eslint-config-opensearch-dashboards
  - Opensearch safer lodash set
    Opensearch safer lodash set
    
    @elastic/safer-lodash-set
  - Osd ace
    Osd ace
    
    @osd/ace
  - Osd apm config loader
    Osd apm config loader
    
    @osd/apm-config-loader
  - Osd babel preset
    Osd babel preset
    
    @osd/babel-preset
  - Osd config
    Osd config
    
    `@osd/config` — OpenSearch Dashboards configuration file loader
  - Osd config schema
    Osd config schema
    
    `@osd/config-schema` — The OpenSearch Dashboards config validation library
  - Osd dev utils
    Osd dev utils
    
    dev utils
    
    Certs
    Certs
    
    Development certificates
    
    Src
    Src
    
    Ci stats reporter
    Ci stats reporter
    
    OpenSearch Dashboards CI Stats reporter
    
    Run
    Run
    
    @osd/dev-utils > run()
  - Osd eslint import resolver opensearch dashboards
    Osd eslint import resolver opensearch dashboards
    
    @osd/eslint-import-resolver-opensearch-dashboards
  - Osd eslint plugin eslint
    Osd eslint plugin eslint
    
    Custom ESLint rules for OpenSearch Dashboards
  - Osd expect
    Osd expect
    
    Index
  - Osd i18n
    Osd i18n
    
    I18n
  - Osd logging
    Osd logging
    
    osd-logging
  - Osd monaco
    Osd monaco
    
    @osd/monaco
    
    Src
    Src
    
    Xjson
    Xjson
    
    README
  - Osd opensearch
    Osd opensearch
    
    @osd/opensearch
  - Osd optimizer
    Osd optimizer
    
    @osd/optimizer
  - Osd plugin generator
    Osd plugin generator
    
    OpenSearch Dashboards Plugin Generator
  - Osd plugin helpers
    Osd plugin helpers
    
    @osd/plugin-helpers
  - Osd pm
    Osd pm
    
    `@osd/pm` — The OpenSearch Dashboards project management tool
  - Osd spec to console
    Osd spec to console
    
    Index
  - Osd std
    Osd std
    
    `@osd/std` — OpenSearch Dashboards standard library
  - Osd telemetry tools
    Osd telemetry tools
    
    Telemetry Tools
  - Osd test
    Osd test
    
    Index
    
    Src
    Src
    
    Failed tests reporter
    Failed tests reporter
    
    failed tests reporter
    
    Functional test runner
    Functional test runner
    
    Lib
    Lib
    
    Docker servers
    Docker servers
    
    Functional Test Runner - Docker Servers
    
    Types
    Types
    
    @osd/test/types
  - Osd test subj selector
    Osd test subj selector
    
    test-subj-selector
  - Osd ui framework
    Osd ui framework
    
    OpenSearch Dashboards UI Framework - Deprecation Notice
  - Osd ui shared deps
    Osd ui shared deps
    
    `@osd/ui-shared-deps`
  - Osd utility types
    Osd utility types
    
    `@osd/utility-types`
  - Osd utils
    Osd utils
    
    @osd/utils
- Scripts
  Scripts
  - OpenSearch Dashboards Dev Scripts
- Src
  Src
  - Core
    Core
    
    Core
    
    Public
    Public
    
    Chrome
    Chrome
    
    Index
    
    Server
    Server
    
    Logging
    Logging
    
    Logging
    
    Saved objects
    Saved objects
    
    Migrations
    Migrations
    
    Saved Object Migrations
    
    Utils
    Utils
    
    Crypto
    Crypto
    
    fixtures
    fixtures
    
    PKCS12 Test Fixtures
  - Dev
    Dev
    
    Build
    Build
    
    dev/build
    
    I18n
    I18n
    
    I18n Tools
  - Plugins
    Plugins
    
    Bfetch
    Bfetch
    
    `bfetch` plugin
    
    Charts
    Charts
    
    Charts
    
    Public
    Public
    
    Services
    Services
    
    Theme
    Theme
    
    Theme Service
    
    Console
    Console
    
    Public
    Public
    
    Application
    Application
    
    Hooks
    Hooks
    
    Index
    
    Dashboard
    Dashboard
    
    Index
    
    Data
    Data
    
    data
    
    Public
    Public
    
    Query
    Query
    
    State sync
    State sync
    
    Query state syncing utilities
    
    Server
    Server
    
    Search
    Search
    
    search
    
    Dev tools
    Dev tools
    
    Dev tools plugin
    
    Discover
    Discover
    
    Index
    
    Embeddable
    Embeddable
    
    Embeddables
    
    Docs
    Docs
    
    Embeddable Docs, Guides & Caveats
    
    Expressions
    Expressions
    
    `expressions` plugin
    
    Home
    Home
    
    home plugin
    
    Input control vis
    Input control vis
    
    Index
    
    Inspector
    Inspector
    
    Inspector
    
    Navigation
    Navigation
    
    navigation
    
    Opensearch dashboards legacy
    Opensearch dashboards legacy
    
    OpenSearch-Dashboards-legacy
    
    Opensearch dashboards overview
    Opensearch dashboards overview
    
    opensearch-dashboards-overview
    
    Opensearch dashboards react
    Opensearch dashboards react
    
    `opensearch-dashboards-react`
    
    Public
    Public
    
    Code editor
    Code editor
    
    Code Editor Component
    
    Opensearch dashboards usage collection
    Opensearch dashboards usage collection
    
    OpenSearch Dashboards Usage Collection
    
    Server
    Server
    
    Collectors
    Collectors
    
    Application usage
    Application usage
    
    Application Usage
    
    Opensearch dashboards utils
    Opensearch dashboards utils
    
    opensearch-dashboards-utils
    
    Common
    Common
    
    State containers
    State containers
    
    Index
    
    Docs
    Docs
    
    State containers
    State containers
    
    State containers
    
    State sync
    State sync
    
    State Syncing Utilities
    
    Storages
    Storages
    
    State Storage
    
    Public
    Public
    
    State sync
    State sync
    
    Index
    
    Opensearch ui shared
    Opensearch ui shared
    
    Public
    Public
    
    Forms
    Forms
    
    Form wizard
    Form wizard
    
    FormWizard
    
    Multi content
    Multi content
    
    MultiContent
    
    Share
    Share
    
    Share plugin
    
    Public
    Public
    
    Url generators
    Url generators
    
    Index
    
    Telemetry
    Telemetry
    
    OpenSearch Dashboards Telemetry Service
    
    Telemetry collection manager
    Telemetry collection manager
    
    Telemetry Collection Manager
    
    Telemetry management section
    Telemetry management section
    
    Telemetry Management Section
    
    Timeline
    Timeline
    
    Index
    
    Ui actions
    Ui actions
    
    UI Actions
    
    Public
    Public
    
    Tests
    Tests
    
    Index
    
    Url forwarding
    Url forwarding
    
    url-forwarding
    
    Usage collection
    Usage collection
    
    OpenSearch Dashboards Usage Collection Service
    
    Server
    Server
    
    Routes
    Routes
    
    Stats
    Stats
    
    `/api/stats`
    
    Vis default editor
    Vis default editor
    
    Visualization Deafult Editor plugin
    
    Vis type markdown
    Vis type markdown
    
    Index
    
    Vis type metric
    Vis type metric
    
    Index
    
    Vis type table
    Vis type table
    
    Index
    
    Vis type tagcloud
    Vis type tagcloud
    
    Index
    
    Vis type timeline
    Vis type timeline
    
    Vis type Timeline
    
    Vis type timeseries
    Vis type timeseries
    
    Index
    
    Vis type vega
    Vis type vega
    
    Index
    
    Vis type vislib
    Vis type vislib
    
    Index
    
    Vis type xy
    Vis type xy
    
    Index
    
    Visualizations
    Visualizations
    
    Index
    
    Visualize
    Visualize
    
    Index
- Test
  Test
  - Examples
    Examples
    
    Example plugin functional tests
  - Functional
    Functional
    
    Fixtures
    Fixtures
    
    Opensearch archiver
    Opensearch archiver
    
    Index
  - Interpreter functional
    Interpreter functional
    
    Interpreter Functional Tests
  - Plugin functional
    Plugin functional
    
    Plugin Functional Tests
    
    Plugins
    Plugins
    
    Osd tp custom visualizations
    Osd tp custom visualizations
    
    Custom visualizations
  - Server integration
    Server integration
    
    fixtures
    fixtures
    
    HTTP SSL Test Fixtures

Query state syncing utilities

Set of helpers to connect data services to state containers and state syncing utilities

Made with Material for MkDocs