core/common/options.service.ts
A service that allows to set or get application options which configure the default behavior of the UI.
constructor(options, systemOptionsService: SystemOptionsService, tenantOptionService: TenantOptionsService)
|
||||||||||||
Parameters :
|
delete | ||||||||
delete(key: T)
|
||||||||
Type parameters :
|
||||||||
Deletes an application option.
Parameters :
Returns :
void
|
get | ||||||||||||||||
get(optionKey: T, defaultValue?, attemptParse?: boolean)
|
||||||||||||||||
Type parameters :
|
||||||||||||||||
Returns an application option used to configure the UI.
Parameters :
|
get$ | ||||||||||||||||
get$(optionKey: T, defaultValue?, attemptParse?: boolean)
|
||||||||||||||||
Type parameters :
|
||||||||||||||||
Returns an observable of an application option used to configure the UI.
Parameters :
Returns :
Observable<>
|
Async getCurrentTenantOption | ||||||||||||||||
getCurrentTenantOption(category: string, key: string, defaultValue?: T)
|
||||||||||||||||
Type parameters :
|
||||||||||||||||
Gets current tenant option value from the tenant service omitting the inheritance supported based on given parameters.
Parameters :
Returns :
Promise<T | string>
|
Async getInheritedTenantOption | ||||||||||||||||
getInheritedTenantOption(category: string, key: string, defaultValue?: T)
|
||||||||||||||||
Type parameters :
|
||||||||||||||||
Gets an inherited from parent value from the tenant service if inheritance supported based on given parameters.
Parameters :
Returns :
Promise<T | string>
|
Async getSystemOption | ||||||||||||||||
getSystemOption(category: string, key: string, defaultValue?: T)
|
||||||||||||||||
Type parameters :
|
||||||||||||||||
Gets a value from the system service and parses it.
Parameters :
Returns :
Promise<T | string>
|
Async getTenantOption | ||||||||||||||||
getTenantOption(category: string, key: string, defaultValue?: T)
|
||||||||||||||||
Type parameters :
|
||||||||||||||||
Gets a value from the tenant service and parses it.
Parameters :
Returns :
Promise<T | string>
|
set | ||||||||||||
set(key: T, value)
|
||||||||||||
Type parameters :
|
||||||||||||
Sets an application option.
Parameters :
Returns :
void
|
optionsUpdated$ |
Type : Observable<void>
|
Optional brandingCssVars |
Type : BrandingCssVars
|
Object with properties that will be converted to CSS custom variables. |
Optional brandingPreview |
Type : boolean
|
Enables the branding preview mode. If set to true, the |
Optional brandingUrl |
Type : string
|
URL to *.css file which will replace default branding. |
Optional breadcrumbs |
Type : boolean
|
Enable or disable breadcrumbs in the header for groups and devices (default: false). |
Optional companyName |
Type : string
|
Name of company handling support requests from app users (displayed in notification message). |
Optional contentSecurityPolicy |
Type : string
|
CSP string to be applied to |
contextPath |
Type : string
|
Optional cookieBanner |
Type : CookieBannerConfiguration
|
Cookie Banner configuration |
Optional cookiePreferences |
Type : CookiePreferencesConfiguration
|
Cookie preferences configuration. Here you can enable or disable cookie categories |
Optional copy |
Type : []
|
Additional assets to copy to the build output. See https://github.com/webpack-contrib/copy-webpack-plugin for more information about the patterns to add here. |
Optional disableOnlyRootsQuery |
Type : boolean
|
By default, cockpit and devicemanagement use the onlyRoots query to resolve root nodes. This could lead to performance issues, if a customer has a lot of root nodes. Therefore you can disable the use of this query with this flag. |
Optional disableTracking |
Type : boolean
|
Disable user tracking |
Optional docs |
Type : Docs
|
Documentation links settings. |
Optional docsBaseUrl |
Type : string
|
Base URL for documentation links (include |
Optional entryModule |
Type : string
|
Entry module for Angular compiler (only used with lazy loaded routes), e.g. |
Optional exports |
Type : PluginsExports[]
|
NgModule export for plugins. |
Optional extraCss |
Type : string
|
Stylesheet (CSS) that will be added at runtime. The string should actually contain the CSS not a path or URL to it. |
Optional extraCssUrls |
Type : string[]
|
Array of URLs to additional *.css files to be loaded at runtime. |
Optional faviconUrl |
Type : string
|
URL to favicon. |
Optional forceSetup |
Type : boolean
|
Allows to force showing the setup wizard. |
Optional forceUrlRemotes |
Type : boolean
|
If set to true, only remotes defined in the |
Optional gainsightKey |
Type : string
|
A key for the product experience software Gainsight. |
Optional globalTitle |
Type : string
|
HTML page title. |
Optional guideHrefTemplate |
Type : string
|
URL template for documentation links (default: |
Optional hideNavigator |
Type : boolean
|
Collapse navigator on initial load. |
Optional hidePlatformInformation |
Type : boolean
|
Hides the "Platform information" in the right drawer, will overrule the "hidePowered" option |
Optional hidePowered |
Type : boolean
|
Hide "powered by" and version info at the bottom of the navigator and in the right drawer. |
Optional hideTypeDashboardForAssets |
Type : boolean
|
Hides possibility to create typed dashboards for assets (and groups). If true, typed dashboards can be created only for devices. It is true by default. |
Optional i18nExtra |
Type : I18nExtra
|
Allows to add custom translations. It is an optional property. Its keys are language codes (https://cumulocity.com/guides/users-guide/getting-started/#a-name-languages-a-available-languages) and its values are objects with key-value pairs, where the key is the original string in English and the value - its translation.
For example you can add the translation of your custom cookie banner configured in the branding settings: Example :
|
Optional icon |
Type : Icon
|
Application icon to be displayed in app switcher and header bar. |
Optional indexTemplate |
Type : string
|
Path to custom index.html (otherwise default one will be used). |
Optional isSetup |
Type : boolean
|
Indicates if the application needs to show the setup wizard. |
key |
Type : string
|
Optional label |
Type : string
|
Is used for plugins to indicate their owner. Software AG plugins are marked with OFFICIAL label. |
Optional localePath |
Type : string
|
Path to the folder from which *.po files will be loaded. |
Optional loginExtraLink |
Type : LoginExtraLink | LoginExtraLink[]
|
Additional link(s) to display on login screen. |
Optional mapConfig |
Type : MapDefaultConfig
|
Allows to set default configurations on the maps. |
Optional mapLayers |
Type : MapTileLayer[]
|
Allows to set the map layers. If not set, defaults to open street map layer. |
Optional mapNominatimUrl |
Type : string
|
The URL used to lookup geo coordinates for a user provided address via nominatim API.
Can be set to empty to disable the find address feature on the location tab.
Uses: |
Optional mapWidgetHideMaxDeviceOnMapHint |
Type : boolean
|
Allows to hide the hint that there are more devices with geo coordinates then displayed on the map widget and maps in general. |
Optional mapWidgetPageSize |
Type : number
|
Allows to adjust the default pagesize of 100 items of the map widget and maps in general. |
Optional mapWidgetRealtimeDisabled |
Type : boolean
|
Disables realtime updates on the map widget and maps in general. |
name |
Type : string
|
Optional newsletter |
Type : boolean
|
Show or hide a newsletter subscription checkbox in edit user modal. |
Optional noAppSwitcher |
Type : boolean
|
Hide application in app switcher (saved to the server). |
Optional noLogin |
Type : boolean
|
By default a WebSDK app requires the user to be logged in. In case you would like to develop just a static application, that does not require any kind of access to the backend, you can use this flag to disable the login screen. NOTE: not all WebSDK components support this, some might require the user to be logged in and won't work. |
Optional noPlugins |
Type : boolean
|
Allows to opt out of supporting/loading plugins for this application. |
Optional noVersionWarning |
Type : boolean
|
Allows to opt out of the version warning which is shown in the dev tools. |
Optional remotes |
Type : RemotePlugins
|
List of imported remote plugins. |
Optional rightDrawer |
Type : boolean
|
Enable or disable the right drawer. |
Optional rootNodeModulesPath |
Type : string
|
Path to the root node_modules dir (useful when working in monorepo setup, e.g. yarn workspaces). |
Optional rootTagName |
Type : string
|
The name of the root element. By default c8y-bootstrap. |
Optional sensorPhone |
Type : boolean
|
Enables cloud sensor wizard |
Optional source |
Type : string | number | IApplication
|
The package source a application origins from as IApplication or simply the id of the source |
Optional storageLimitationFeatureEnabled |
Type : boolean
|
Enable or disable storage limitation feature. |
Optional supportUrl |
Type : boolean | string
|
URL to support page (set to |
Optional supportUserString |
Type : string
|
Replacement string for |
Optional tabsHorizontal |
Type : boolean
|
Show tabs horizontally or vertically. |
Optional tsConfigPath |
Type : string
|
Path to tsccnfig.json file if TypeScript is used (default: ./tsconfig.json). |
Optional upgrade |
Type : boolean
|
Set to |
version |
Type : string
|
Optional versioningMatrix |
Type : VersioningMatrix
|
A matrix of versions indicating which versions of the application (key) are dependent on which version of a cumulocity component (API version and Web SDK version of the shell application currently supported, indicated by the value). The versions of the dependent components can be indicated by a semver range. Example :
|
Optional webSdkVersion |
Type : string
|