Documentation for automated readers
A curated documentation index is available at: https://grafana.com/llms.txt
A complete documentation index is available at: https://grafana.com/llms-full.txt
These indexes can help with page discovery before fetching individual documents.
This page is also available in Markdown, which may be easier for automated readers and AI tools to parse than HTML. The Markdown version is available at https://grafana.com/docs/grafana/v8.4/packages_api/data/serializestatetourlparam.md, or by sending Accept: text/markdown to https://grafana.com/docs/grafana/v8.4/packages_api/data/serializestatetourlparam/. For broader documentation discovery, the curated index is available at https://grafana.com/llms.txt and the complete index is available at https://grafana.com/llms-full.txt.
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
serializeStateToUrlParam() function
serializeStateToUrlParam() function
Create an string that is used in URL to represent the Explore state. This is basically just a stringified json that is that used as a state of a single Explore pane so it does not represent full Explore URL.
Signature
export declare function serializeStateToUrlParam(urlState: ExploreUrlState, compact?: boolean): string;Import
import { serializeStateToUrlParam } from '@grafana/data';Parameters
| Parameter | Type | Description |
|---|---|---|
| urlState | ExploreUrlState | |
| compact | boolean | this parameter is deprecated and will be removed in a future release. |
Returns:
string