Marcus Andersson
a2d741f60f
* regenerated packages docs. * fixed spelling issues. * fixed spelling issues.
48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "LocationSrv"
|
|
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## LocationSrv interface
|
|
|
|
If you need to automatically navigate the user to a new place in the application this should be done via the LocationSrv and it will make sure to update the application state accordingly.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface LocationSrv
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { LocationSrv } from '@grafana/runtime';
|
|
```
|
|
<b>Methods</b>
|
|
|
|
| Method | Description |
|
|
| --- | --- |
|
|
| [update(options)](#update-method) | |
|
|
|
|
### update method
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
update(options: LocationUpdate): void;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| options | <code>LocationUpdate</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`void`
|
|
|