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.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/runtimebreadcrumb arrow LocationUpdate
Enterprise Open source

LocationUpdate interface

Signature

typescript 
export interface LocationUpdate

Import

typescript 
import { LocationUpdate } from '@grafana/runtime';

Properties

PropertyTypeDescription
partialbooleanIf set to true, the query argument will be added to the existing URL.
pathstringTarget path where you automatically wants to navigate the user.
queryUrlQueryMapSpecify this value if you want to add values to the query string of the URL.
replaceboolean

partial property

If set to true, the query argument will be added to the existing URL.

Signature

typescript 
partial?: boolean;

path property

Target path where you automatically wants to navigate the user.

Signature

typescript 
path?: string;

query property

Specify this value if you want to add values to the query string of the URL.

Signature

typescript 
query?: UrlQueryMap;

replace property

Signature

typescript 
replace?: boolean;