GrafanaConfig interface

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

Signature

  1. export interface GrafanaConfig

Import

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

Properties

PropertyTypeDescription
alertingEnabledboolean
alertingErrorOrTimeoutstring
alertingMinIntervalnumber
alertingNoDataOrNullValuesstring
allowOrgCreateboolean
appSubUrlstring
authProxyEnabledboolean
autoAssignOrgboolean
bootDataany
buildInfoBuildInfo
customThemeany
datasources{
[str: string]: DataSourceInstanceSettings;
}
dateFormatsSystemDateFormatSettings
defaultDatasourcestring
disableLoginFormboolean
disableSanitizeHtmlboolean
disableUserSignUpboolean
editorsCanAdminboolean
exploreEnabledboolean
externalUserMngInfostring
externalUserMngLinkNamestring
externalUserMngLinkUrlstring
featureTogglesFeatureToggles
geomapDefaultBaseLayerMapLayerOptions
geomapDisableCustomBaseLayerboolean
http2Enabledboolean
ldapEnabledboolean
licenseInfoLicenseInfo
liveEnabledboolean
loginErrorany
loginHintany
minRefreshIntervalstring
navTreeany
newPanelTitlestring
oauthany
panels{
[key: string]: PanelPluginMeta;
}
passwordHintany
pluginsToPreloadstring[]
samlEnabledboolean
sentrySentryConfig
sigV4AuthEnabledboolean
themeGrafanaTheme
theme2GrafanaTheme2
unifiedAlertingEnabledboolean
verifyEmailEnabledboolean
viewersCanEditboolean
windowTitlePrefixstring

alertingEnabled property

Signature

  1. alertingEnabled: boolean;

alertingErrorOrTimeout property

Signature

  1. alertingErrorOrTimeout: string;

alertingMinInterval property

Signature

  1. alertingMinInterval: number;

alertingNoDataOrNullValues property

Signature

  1. alertingNoDataOrNullValues: string;

allowOrgCreate property

Signature

  1. allowOrgCreate: boolean;

appSubUrl property

Signature

  1. appSubUrl: string;

authProxyEnabled property

Signature

  1. authProxyEnabled: boolean;

autoAssignOrg property

Signature

  1. autoAssignOrg: boolean;

bootData property

Signature

  1. bootData: any;

buildInfo property

Signature

  1. buildInfo: BuildInfo;

customTheme property

Signature

  1. customTheme?: any;

datasources property

Signature

  1. datasources: {
  2. [str: string]: DataSourceInstanceSettings;
  3. };

dateFormats property

Signature

  1. dateFormats?: SystemDateFormatSettings;

defaultDatasource property

Signature

  1. defaultDatasource: string;

disableLoginForm property

Signature

  1. disableLoginForm: boolean;

disableSanitizeHtml property

Signature

  1. disableSanitizeHtml: boolean;

disableUserSignUp property

Signature

  1. disableUserSignUp: boolean;

editorsCanAdmin property

Signature

  1. editorsCanAdmin: boolean;

exploreEnabled property

Signature

  1. exploreEnabled: boolean;

externalUserMngInfo property

Signature

  1. externalUserMngInfo: string;

externalUserMngLinkName property

Signature

  1. externalUserMngLinkName: string;

externalUserMngLinkUrl property

Signature

  1. externalUserMngLinkUrl: string;

featureToggles property

Signature

  1. featureToggles: FeatureToggles;

geomapDefaultBaseLayer property

Signature

  1. geomapDefaultBaseLayer?: MapLayerOptions;

geomapDisableCustomBaseLayer property

Signature

  1. geomapDisableCustomBaseLayer?: boolean;

http2Enabled property

Signature

  1. http2Enabled: boolean;

ldapEnabled property

Signature

  1. ldapEnabled: boolean;

licenseInfo property

Signature

  1. licenseInfo: LicenseInfo;

liveEnabled property

Signature

  1. liveEnabled: boolean;

loginError property

Signature

  1. loginError: any;

loginHint property

Signature

  1. loginHint: any;

minRefreshInterval property

Signature

  1. minRefreshInterval: string;

navTree property

Signature

  1. navTree: any;

newPanelTitle property

Signature

  1. newPanelTitle: string;

oauth property

Signature

  1. oauth: any;

panels property

Signature

  1. panels: {
  2. [key: string]: PanelPluginMeta;
  3. };

passwordHint property

Signature

  1. passwordHint: any;

pluginsToPreload property

Signature

  1. pluginsToPreload: string[];

samlEnabled property

Signature

  1. samlEnabled: boolean;

sentry property

Signature

  1. sentry: SentryConfig;

sigV4AuthEnabled property

Signature

  1. sigV4AuthEnabled: boolean;

theme property

Signature

  1. theme: GrafanaTheme;

theme2 property

Signature

  1. theme2: GrafanaTheme2;

unifiedAlertingEnabled property

Signature

  1. unifiedAlertingEnabled: boolean;

verifyEmailEnabled property

Signature

  1. verifyEmailEnabled: boolean;

viewersCanEdit property

Signature

  1. viewersCanEdit: boolean;

windowTitlePrefix property

Signature

  1. windowTitlePrefix: string;