IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity
98da152f51
grafana/docs/sources/packages_api/runtime/grafanabootconfig.md
Marcus Andersson 6bc369629d
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 10:03:53 +01:00

7.8 KiB
Raw Blame History

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "GrafanaBootConfig" keywords = ["grafana","documentation","sdk","@grafana/runtime"] type = "docs" draft = true +++

GrafanaBootConfig class

Signature

export declare class GrafanaBootConfig

Import

import { GrafanaBootConfig } from '@grafana/runtime';

Constructors

Constructor Modifiers Description
constructor(options) Constructs a new instance of the GrafanaBootConfig class

Properties

Property Modifiers Type Description
alertingEnabled boolean
alertingErrorOrTimeout string
alertingMinInterval number
alertingNoDataOrNullValues string
allowOrgCreate boolean
appSubUrl string
authProxyEnabled boolean
autoAssignOrg boolean
bootData any
buildInfo BuildInfo
datasources {
[str: string]: DataSourceInstanceSettings;
}
defaultDatasource string
disableLoginForm boolean
disableSanitizeHtml boolean
disableUserSignUp boolean
editorsCanAdmin boolean
exploreEnabled boolean
externalUserMngInfo string
externalUserMngLinkName string
externalUserMngLinkUrl string
featureToggles FeatureToggles
ldapEnabled boolean
licenseInfo LicenseInfo
loginError any
loginHint any
navTree any
newPanelTitle string
oauth any
panels {
[key: string]: PanelPluginMeta;
}
passwordHint any
phantomJSRenderer boolean
pluginsToPreload string[]
samlEnabled boolean
theme GrafanaTheme
verifyEmailEnabled boolean
viewersCanEdit boolean
windowTitlePrefix string

constructor(options)

Constructs a new instance of the GrafanaBootConfig class

Signature

constructor(options: GrafanaBootConfig);

Parameters

Parameter Type Description
options GrafanaBootConfig

alertingEnabled property

Signature

alertingEnabled: boolean;

alertingErrorOrTimeout property

Signature

alertingErrorOrTimeout: string;

alertingMinInterval property

Signature

alertingMinInterval: number;

alertingNoDataOrNullValues property

Signature

alertingNoDataOrNullValues: string;

allowOrgCreate property

Signature

allowOrgCreate: boolean;

appSubUrl property

Signature

appSubUrl: string;

authProxyEnabled property

Signature

authProxyEnabled: boolean;

autoAssignOrg property

Signature

autoAssignOrg: boolean;

bootData property

Signature

bootData: any;

buildInfo property

Signature

buildInfo: BuildInfo;

datasources property

Signature

datasources: {
        [str: string]: DataSourceInstanceSettings;
    };

defaultDatasource property

Signature

defaultDatasource: string;

disableLoginForm property

Signature

disableLoginForm: boolean;

disableSanitizeHtml property

Signature

disableSanitizeHtml: boolean;

disableUserSignUp property

Signature

disableUserSignUp: boolean;

editorsCanAdmin property

Signature

editorsCanAdmin: boolean;

exploreEnabled property

Signature

exploreEnabled: boolean;

externalUserMngInfo property

Signature

externalUserMngInfo: string;

externalUserMngLinkName property

Signature

externalUserMngLinkName: string;

externalUserMngLinkUrl property

Signature

externalUserMngLinkUrl: string;

featureToggles property

Signature

featureToggles: FeatureToggles;

ldapEnabled property

Signature

ldapEnabled: boolean;

licenseInfo property

Signature

licenseInfo: LicenseInfo;

loginError property

Signature

loginError: any;

loginHint property

Signature

loginHint: any;

navTree property

Signature

navTree: any;

newPanelTitle property

Signature

newPanelTitle: string;

oauth property

Signature

oauth: any;

panels property

Signature

panels: {
        [key: string]: PanelPluginMeta;
    };

passwordHint property

Signature

passwordHint: any;

phantomJSRenderer property

Signature

phantomJSRenderer: boolean;

pluginsToPreload property

Signature

pluginsToPreload: string[];

samlEnabled property

Signature

samlEnabled: boolean;

theme property

Signature

theme: GrafanaTheme;

verifyEmailEnabled property

Signature

verifyEmailEnabled: boolean;

viewersCanEdit property

Signature

viewersCanEdit: boolean;

windowTitlePrefix property

Signature

windowTitlePrefix: string;