grafana/docs/sources/packages_api/runtime/grafanabootconfig.md

393 lines
8.0 KiB
Markdown
Raw Normal View History

Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 03:03:53 -06:00
+++
# -----------------------------------------------------------------------
# Do not edit this file. It is automatically generated by API Documenter.
# -----------------------------------------------------------------------
title = "GrafanaBootConfig"
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
type = "docs"
+++
## GrafanaBootConfig class
<b>Signature</b>
```typescript
export declare class GrafanaBootConfig implements GrafanaConfig
Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 03:03:53 -06:00
```
<b>Import</b>
```typescript
import { GrafanaBootConfig } from '@grafana/runtime';
```
<b>Constructors</b>
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [constructor(options)](#constructor-options) | | Constructs a new instance of the <code>GrafanaBootConfig</code> class |
<b>Properties</b>
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [alertingEnabled](#alertingenabled-property) | | <code>boolean</code> | |
| [alertingErrorOrTimeout](#alertingerrorortimeout-property) | | <code>string</code> | |
| [alertingMinInterval](#alertingmininterval-property) | | <code>number</code> | |
| [alertingNoDataOrNullValues](#alertingnodataornullvalues-property) | | <code>string</code> | |
| [allowOrgCreate](#alloworgcreate-property) | | <code>boolean</code> | |
| [appSubUrl](#appsuburl-property) | | <code>string</code> | |
| [authProxyEnabled](#authproxyenabled-property) | | <code>boolean</code> | |
| [autoAssignOrg](#autoassignorg-property) | | <code>boolean</code> | |
| [bootData](#bootdata-property) | | <code>any</code> | |
| [buildInfo](#buildinfo-property) | | <code>BuildInfo</code> | |
| [datasources](#datasources-property) | | <code>{</code><br/><code> [str: string]: DataSourceInstanceSettings;</code><br/><code> }</code> | |
| [defaultDatasource](#defaultdatasource-property) | | <code>string</code> | |
| [disableLoginForm](#disableloginform-property) | | <code>boolean</code> | |
| [disableSanitizeHtml](#disablesanitizehtml-property) | | <code>boolean</code> | |
| [disableUserSignUp](#disableusersignup-property) | | <code>boolean</code> | |
| [editorsCanAdmin](#editorscanadmin-property) | | <code>boolean</code> | |
| [exploreEnabled](#exploreenabled-property) | | <code>boolean</code> | |
| [externalUserMngInfo](#externalusermnginfo-property) | | <code>string</code> | |
| [externalUserMngLinkName](#externalusermnglinkname-property) | | <code>string</code> | |
| [externalUserMngLinkUrl](#externalusermnglinkurl-property) | | <code>string</code> | |
| [featureToggles](#featuretoggles-property) | | <code>FeatureToggles</code> | |
| [ldapEnabled](#ldapenabled-property) | | <code>boolean</code> | |
| [licenseInfo](#licenseinfo-property) | | <code>LicenseInfo</code> | |
| [loginError](#loginerror-property) | | <code>any</code> | |
| [loginHint](#loginhint-property) | | <code>any</code> | |
| [minRefreshInterval](#minrefreshinterval-property) | | <code>string</code> | |
Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 03:03:53 -06:00
| [navTree](#navtree-property) | | <code>any</code> | |
| [newPanelTitle](#newpaneltitle-property) | | <code>string</code> | |
| [oauth](#oauth-property) | | <code>any</code> | |
| [panels](#panels-property) | | <code>{</code><br/><code> [key: string]: PanelPluginMeta;</code><br/><code> }</code> | |
| [passwordHint](#passwordhint-property) | | <code>any</code> | |
| [pluginsToPreload](#pluginstopreload-property) | | <code>string[]</code> | |
| [rendererAvailable](#rendereravailable-property) | | <code>boolean</code> | |
Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 03:03:53 -06:00
| [samlEnabled](#samlenabled-property) | | <code>boolean</code> | |
| [theme](#theme-property) | | <code>GrafanaTheme</code> | |
| [verifyEmailEnabled](#verifyemailenabled-property) | | <code>boolean</code> | |
| [viewersCanEdit](#viewerscanedit-property) | | <code>boolean</code> | |
| [windowTitlePrefix](#windowtitleprefix-property) | | <code>string</code> | |
### constructor(options)
Constructs a new instance of the `GrafanaBootConfig` class
<b>Signature</b>
```typescript
constructor(options: GrafanaBootConfig);
```
<b>Parameters</b>
| Parameter | Type | Description |
| --- | --- | --- |
| options | <code>GrafanaBootConfig</code> | |
### alertingEnabled property
<b>Signature</b>
```typescript
alertingEnabled: boolean;
```
### alertingErrorOrTimeout property
<b>Signature</b>
```typescript
alertingErrorOrTimeout: string;
```
### alertingMinInterval property
<b>Signature</b>
```typescript
alertingMinInterval: number;
```
### alertingNoDataOrNullValues property
<b>Signature</b>
```typescript
alertingNoDataOrNullValues: string;
```
### allowOrgCreate property
<b>Signature</b>
```typescript
allowOrgCreate: boolean;
```
### appSubUrl property
<b>Signature</b>
```typescript
appSubUrl: string;
```
### authProxyEnabled property
<b>Signature</b>
```typescript
authProxyEnabled: boolean;
```
### autoAssignOrg property
<b>Signature</b>
```typescript
autoAssignOrg: boolean;
```
### bootData property
<b>Signature</b>
```typescript
bootData: any;
```
### buildInfo property
<b>Signature</b>
```typescript
buildInfo: BuildInfo;
```
### datasources property
<b>Signature</b>
```typescript
datasources: {
[str: string]: DataSourceInstanceSettings;
};
```
### defaultDatasource property
<b>Signature</b>
```typescript
defaultDatasource: string;
```
### disableLoginForm property
<b>Signature</b>
```typescript
disableLoginForm: boolean;
```
### disableSanitizeHtml property
<b>Signature</b>
```typescript
disableSanitizeHtml: boolean;
```
### disableUserSignUp property
<b>Signature</b>
```typescript
disableUserSignUp: boolean;
```
### editorsCanAdmin property
<b>Signature</b>
```typescript
editorsCanAdmin: boolean;
```
### exploreEnabled property
<b>Signature</b>
```typescript
exploreEnabled: boolean;
```
### externalUserMngInfo property
<b>Signature</b>
```typescript
externalUserMngInfo: string;
```
### externalUserMngLinkName property
<b>Signature</b>
```typescript
externalUserMngLinkName: string;
```
### externalUserMngLinkUrl property
<b>Signature</b>
```typescript
externalUserMngLinkUrl: string;
```
### featureToggles property
<b>Signature</b>
```typescript
featureToggles: FeatureToggles;
```
### ldapEnabled property
<b>Signature</b>
```typescript
ldapEnabled: boolean;
```
### licenseInfo property
<b>Signature</b>
```typescript
licenseInfo: LicenseInfo;
```
### loginError property
<b>Signature</b>
```typescript
loginError: any;
```
### loginHint property
<b>Signature</b>
```typescript
loginHint: any;
```
### minRefreshInterval property
<b>Signature</b>
```typescript
minRefreshInterval: string;
```
Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 03:03:53 -06:00
### navTree property
<b>Signature</b>
```typescript
navTree: any;
```
### newPanelTitle property
<b>Signature</b>
```typescript
newPanelTitle: string;
```
### oauth property
<b>Signature</b>
```typescript
oauth: any;
```
### panels property
<b>Signature</b>
```typescript
panels: {
[key: string]: PanelPluginMeta;
};
```
### passwordHint property
<b>Signature</b>
```typescript
passwordHint: any;
```
### pluginsToPreload property
Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 03:03:53 -06:00
<b>Signature</b>
```typescript
pluginsToPreload: string[];
Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 03:03:53 -06:00
```
### rendererAvailable property
Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 03:03:53 -06:00
<b>Signature</b>
```typescript
rendererAvailable: boolean;
Docs: adding first version of the auto-generated packages API docs. (#22107) * 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.
2020-02-26 03:03:53 -06:00
```
### samlEnabled property
<b>Signature</b>
```typescript
samlEnabled: boolean;
```
### theme property
<b>Signature</b>
```typescript
theme: GrafanaTheme;
```
### verifyEmailEnabled property
<b>Signature</b>
```typescript
verifyEmailEnabled: boolean;
```
### viewersCanEdit property
<b>Signature</b>
```typescript
viewersCanEdit: boolean;
```
### windowTitlePrefix property
<b>Signature</b>
```typescript
windowTitlePrefix: string;
```