Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/runtimebreadcrumb arrow GrafanaBootConfig
Enterprise Open source

GrafanaBootConfig class

Signature

typescript 
export declare class GrafanaBootConfig implements GrafanaConfig

Import

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

Constructors

ConstructorModifiersDescription
constructor(options)Constructs a new instance of the GrafanaBootConfig class

Properties

PropertyModifiersTypeDescription
alertingEnabledboolean
alertingErrorOrTimeoutstring
alertingMinIntervalnumber
alertingNoDataOrNullValuesstring
allowOrgCreateboolean
applicationInsightsConnectionStringstring
applicationInsightsEndpointUrlstring
appSubUrlstring
appUrlstring
authProxyEnabledboolean
autoAssignOrgboolean
awsAllowedAuthProvidersstring[]
awsAssumeRoleEnabledboolean
azureAzureSettings
bootDataany
buildInfoBuildInfo
caching{
enabled: boolean;
}
customThemeany
datasources{
[str: string]: DataSourceInstanceSettings;
}
dateFormatsSystemDateFormatSettings
defaultDatasourcestring
disableLoginFormboolean
disableSanitizeHtmlboolean
disableUserSignUpboolean
editorsCanAdminboolean
exploreEnabledboolean
expressionsEnabledboolean
externalUserMngInfostring
externalUserMngLinkNamestring
externalUserMngLinkUrlstring
featureTogglesFeatureToggles
geomapDefaultBaseLayerConfigMapLayerOptions
geomapDisableCustomBaseLayerboolean
http2Enabledboolean
ldapEnabledboolean
licenseInfoLicenseInfo
liveEnabledboolean
loginErrorany
loginHintany
minRefreshIntervalstring
navTreeany
newPanelTitlestring
oauthany
panels{
[key: string]: PanelPluginMeta;
}
passwordHintany
pluginAdminEnabledboolean
pluginAdminExternalManageEnabledboolean
pluginCatalogHiddenPluginsstring[]
pluginCatalogURLstring
pluginsToPreloadPreloadPlugin[]
recordedQueries{
enabled: boolean;
}
rendererAvailableboolean
rendererVersionstring
samlEnabledboolean
samlNamestring
sentry{
enabled: boolean;
dsn: string;
customEndpoint: string;
sampleRate: number;
}
sigV4AuthEnabledboolean
themeGrafanaTheme
theme2GrafanaTheme2
unifiedAlertingEnabledboolean
verifyEmailEnabledboolean
viewersCanEditboolean
windowTitlePrefixstring

constructor(options)

Constructs a new instance of the GrafanaBootConfig class

Signature

typescript 
constructor(options: GrafanaBootConfig);

Parameters

ParameterTypeDescription
optionsGrafanaBootConfig

alertingEnabled property

Signature

typescript 
alertingEnabled: boolean;

alertingErrorOrTimeout property

Signature

typescript 
alertingErrorOrTimeout: string;

alertingMinInterval property

Signature

typescript 
alertingMinInterval: number;

alertingNoDataOrNullValues property

Signature

typescript 
alertingNoDataOrNullValues: string;

allowOrgCreate property

Signature

typescript 
allowOrgCreate: boolean;

applicationInsightsConnectionString property

Signature

typescript 
applicationInsightsConnectionString?: string;

applicationInsightsEndpointUrl property

Signature

typescript 
applicationInsightsEndpointUrl?: string;

appSubUrl property

Signature

typescript 
appSubUrl: string;

appUrl property

Signature

typescript 
appUrl: string;

authProxyEnabled property

Signature

typescript 
authProxyEnabled: boolean;

autoAssignOrg property

Signature

typescript 
autoAssignOrg: boolean;

awsAllowedAuthProviders property

Signature

typescript 
awsAllowedAuthProviders: string[];

awsAssumeRoleEnabled property

Signature

typescript 
awsAssumeRoleEnabled: boolean;

azure property

Signature

typescript 
azure: AzureSettings;

bootData property

Signature

typescript 
bootData: any;

buildInfo property

Signature

typescript 
buildInfo: BuildInfo;

caching property

Signature

typescript 
caching: {
        enabled: boolean;
    };

customTheme property

Signature

typescript 
customTheme?: any;

datasources property

Signature

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

dateFormats property

Signature

typescript 
dateFormats?: SystemDateFormatSettings;

defaultDatasource property

Signature

typescript 
defaultDatasource: string;

disableLoginForm property

Signature

typescript 
disableLoginForm: boolean;

disableSanitizeHtml property

Signature

typescript 
disableSanitizeHtml: boolean;

disableUserSignUp property

Signature

typescript 
disableUserSignUp: boolean;

editorsCanAdmin property

Signature

typescript 
editorsCanAdmin: boolean;

exploreEnabled property

Signature

typescript 
exploreEnabled: boolean;

expressionsEnabled property

Signature

typescript 
expressionsEnabled: boolean;

externalUserMngInfo property

Signature

typescript 
externalUserMngInfo: string;

externalUserMngLinkName property

Signature

typescript 
externalUserMngLinkName: string;

externalUserMngLinkUrl property

Signature

typescript 
externalUserMngLinkUrl: string;

featureToggles property

Signature

typescript 
featureToggles: FeatureToggles;

geomapDefaultBaseLayerConfig property

Signature

typescript 
geomapDefaultBaseLayerConfig?: MapLayerOptions;

geomapDisableCustomBaseLayer property

Signature

typescript 
geomapDisableCustomBaseLayer?: boolean;

http2Enabled property

Signature

typescript 
http2Enabled: boolean;

ldapEnabled property

Signature

typescript 
ldapEnabled: boolean;

licenseInfo property

Signature

typescript 
licenseInfo: LicenseInfo;

liveEnabled property

Signature

typescript 
liveEnabled: boolean;

loginError property

Signature

typescript 
loginError: any;

loginHint property

Signature

typescript 
loginHint: any;

minRefreshInterval property

Signature

typescript 
minRefreshInterval: string;

Signature

typescript 
navTree: any;

newPanelTitle property

Signature

typescript 
newPanelTitle: string;

oauth property

Signature

typescript 
oauth: any;

panels property

Signature

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

passwordHint property

Signature

typescript 
passwordHint: any;

pluginAdminEnabled property

Signature

typescript 
pluginAdminEnabled: boolean;

pluginAdminExternalManageEnabled property

Signature

typescript 
pluginAdminExternalManageEnabled: boolean;

pluginCatalogHiddenPlugins property

Signature

typescript 
pluginCatalogHiddenPlugins: string[];

pluginCatalogURL property

Signature

typescript 
pluginCatalogURL: string;

pluginsToPreload property

Signature

typescript 
pluginsToPreload: PreloadPlugin[];

recordedQueries property

Signature

typescript 
recordedQueries: {
        enabled: boolean;
    };

rendererAvailable property

Signature

typescript 
rendererAvailable: boolean;

rendererVersion property

Signature

typescript 
rendererVersion: string;

samlEnabled property

Signature

typescript 
samlEnabled: boolean;

samlName property

Signature

typescript 
samlName: string;

sentry property

Signature

typescript 
sentry: {
        enabled: boolean;
        dsn: string;
        customEndpoint: string;
        sampleRate: number;
    };

sigV4AuthEnabled property

Signature

typescript 
sigV4AuthEnabled: boolean;

theme property

Signature

typescript 
theme: GrafanaTheme;

theme2 property

Signature

typescript 
theme2: GrafanaTheme2;

unifiedAlertingEnabled property

Signature

typescript 
unifiedAlertingEnabled: boolean;

verifyEmailEnabled property

Signature

typescript 
verifyEmailEnabled: boolean;

viewersCanEdit property

Signature

typescript 
viewersCanEdit: boolean;

windowTitlePrefix property

Signature

typescript 
windowTitlePrefix: string;