grafana/docs/sources/packages_api/data/grafanaconfig.md
Marcus Andersson cc3fc18076
Docs: enable packages reference docs for 7-beta (#23953)
* added packages reference menu item.

* removed the draft flag.

* Updated docs by running script.
2020-04-28 09:53:58 +02:00

7.2 KiB

+++

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

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

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

title = "GrafanaConfig" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

GrafanaConfig interface

Describes all the different Grafana configuration values available for an instance.

Signature

export interface GrafanaConfig 

Import

import { GrafanaConfig } from '@grafana/data';

Properties

Property 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
minRefreshInterval string
navTree any
newPanelTitle string
oauth any
panels {
[key: string]: PanelPluginMeta;
}
passwordHint any
pluginsToPreload string[]
samlEnabled boolean
theme GrafanaTheme
verifyEmailEnabled boolean
viewersCanEdit boolean
windowTitlePrefix string

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;

minRefreshInterval property

Signature

minRefreshInterval: string;

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;

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;