mirror of
https://github.com/grafana/grafana.git
synced 2025-02-14 01:23:32 -06:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
68 lines
1.6 KiB
Markdown
68 lines
1.6 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "LocationUpdate"
|
|
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## LocationUpdate interface
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface LocationUpdate
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { LocationUpdate } from '@grafana/runtime';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [partial](#partial-property) | <code>boolean</code> | If set to true, the query argument will be added to the existing URL. |
|
|
| [path](#path-property) | <code>string</code> | Target path where you automatically wants to navigate the user. |
|
|
| [query](#query-property) | <code>UrlQueryMap</code> | Specify this value if you want to add values to the query string of the URL. |
|
|
| [replace](#replace-property) | <code>boolean</code> | |
|
|
|
|
### partial property
|
|
|
|
If set to true, the query argument will be added to the existing URL.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
partial?: boolean;
|
|
```
|
|
|
|
### path property
|
|
|
|
Target path where you automatically wants to navigate the user.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
path?: string;
|
|
```
|
|
|
|
### query property
|
|
|
|
Specify this value if you want to add values to the query string of the URL.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
query?: UrlQueryMap;
|
|
```
|
|
|
|
### replace property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
replace?: boolean;
|
|
```
|