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.
3.0 KiB
+++
-----------------------------------------------------------------------
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
Signature
export interface DataSourceInstanceSettings<T extends DataSourceJsonData = DataSourceJsonData>
Import
import { DataSourceInstanceSettings } from '@grafana/data';
Properties
| Property | Type | Description |
|---|---|---|
| basicAuth | string |
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 | string |
|
| id | number |
|
| jsonData | T |
|
| meta | DataSourcePluginMeta |
|
| name | string |
|
| password | string |
|
| type | string |
|
| url | string |
|
| username | string |
|
| withCredentials | boolean |
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.
Signature
basicAuth?: string;
database property
Signature
database?: string;
id property
Signature
id: number;
jsonData property
Signature
jsonData: T;
meta property
Signature
meta: DataSourcePluginMeta;
name property
Signature
name: string;
password property
Signature
password?: string;
type property
Signature
type: string;
url property
Signature
url?: string;
username property
Signature
username?: string;
withCredentials property
Signature
withCredentials?: boolean;