API Reference@grafana/dataserializeStateToUrlParam

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