mirror of
https://github.com/grafana/grafana.git
synced 2025-07-31 10:32:42 +08:00
6bc369629d
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
130 lines
3.0 KiB
Markdown
130 lines
3.0 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "DataSourceInstanceSettings"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
draft = true
|
|
+++
|
|
|
|
## DataSourceInstanceSettings interface
|
|
|
|
Frontend settings model that is passed to Datasource constructor. This differs a bit from the model above as this data model is available to every user who has access to a data source (Viewers+). This is loaded in bootData (on page load), or from: /api/frontend/settings
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface DataSourceInstanceSettings<T extends DataSourceJsonData = DataSourceJsonData>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { DataSourceInstanceSettings } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [basicAuth](#basicauth-property) | <code>string</code> | This is the full Authorization header if basic auth is ennabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username & password is never exposted to browser/Frontend so this will be empty then. |
|
|
| [database](#database-property) | <code>string</code> | |
|
|
| [id](#id-property) | <code>number</code> | |
|
|
| [jsonData](#jsondata-property) | <code>T</code> | |
|
|
| [meta](#meta-property) | <code>DataSourcePluginMeta</code> | |
|
|
| [name](#name-property) | <code>string</code> | |
|
|
| [password](#password-property) | <code>string</code> | |
|
|
| [type](#type-property) | <code>string</code> | |
|
|
| [url](#url-property) | <code>string</code> | |
|
|
| [username](#username-property) | <code>string</code> | |
|
|
| [withCredentials](#withcredentials-property) | <code>boolean</code> | |
|
|
|
|
### basicAuth property
|
|
|
|
This is the full Authorization header if basic auth is ennabled. Only available here when access is Browser (direct), when access is Server (proxy) The basic auth header, username & password is never exposted to browser/Frontend so this will be empty then.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
basicAuth?: string;
|
|
```
|
|
|
|
### database property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
database?: string;
|
|
```
|
|
|
|
### id property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
id: number;
|
|
```
|
|
|
|
### jsonData property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
jsonData: T;
|
|
```
|
|
|
|
### meta property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
meta: DataSourcePluginMeta;
|
|
```
|
|
|
|
### name property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
name: string;
|
|
```
|
|
|
|
### password property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
password?: string;
|
|
```
|
|
|
|
### type property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
type: string;
|
|
```
|
|
|
|
### url property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
url?: string;
|
|
```
|
|
|
|
### username property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
username?: string;
|
|
```
|
|
|
|
### withCredentials property
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
withCredentials?: boolean;
|
|
```
|