1. Miscellaneous
2. Functions

Index

_virtualScrollWindowStrategyFactory   (core/.../virtual-scroll-window.directive.ts) absoluteDateServiceFactory   (upgrade/.../absolute-date.service.ts) addPolyfills   (polyfills/.../index.ts) authBridgeServiceFactory   (upgrade/.../auth-bridge.service.ts) bridgeServiceFactory   (upgrade/.../bridge.service.ts) c8yAlertDecorator   (upgrade/.../alert.decorator.ts) c8yNavigatorProvider   (upgrade/.../navigator.provider.ts) c8yNg1HttpInterceptor   (upgrade/.../http.interceptor.ts) c8yTitleDecorator   (upgrade/.../title.decorator.ts) c8yUiRootController   (upgrade/.../root.component.ts) c8yValidationConfigFactory   (core/.../validation-config.factory.ts) c8yViewsProvider   (upgrade/.../views.provider.ts) dashboardBridgeFactory   (upgrade/.../dashboard-upgrade.module.ts) encodeFiles   (connectivity/.../sim.module.ts) escapeRegExpPattern   (core/.../grid-data-source.ts) exactlyASingleDatapointActive   (widgets/.../kpi-widget-config.component.ts) fieldTypeFactory   (core/.../dynamic-forms-ui-theme.module.ts) fromFactories   (core/.../extension-hooks.ts) fromTrigger   (core/.../extension-hooks.ts) fromTriggerOnce   (core/.../extension-hooks.ts) getActivatedRoute   (core/.../extension-hooks.ts) getAngularLocalesLanguageString   (core/.../i18n.module.ts) getBasicInputArrayFormFieldConfig   (core/.../presets.ts) gettext   (core/.../gettext.ts) gettextCatalogDecorator   (upgrade/.../gettextCatalog.decorator.ts) groupTypesHierarchyNavigatorDecorator   (upgrade/.../groupsHierarchyNavigator.decorator.ts) initializeServices   (core/.../common.module.ts) isActilityConnection   (protocol-lpwan/.../multiple-lns-connector.model.ts) isPromise   (core/.../extension-hooks.ts) isSigfoxConnection   (protocol-lpwan/.../multiple-lns-connector.model.ts) languagesFactory   (core/.../i18n.module.ts) loadLocale   (core/.../load-locale.ts) localeId   (core/.../i18n.module.ts) localePathFactory   (core/.../i18n.module.ts) mapLegacyGridConfiguration   (device-grid/.../map-legacy-grid-configuration.decorator.ts) memoize   (core/.../memoize.decorator.ts) parse   (core/.../parse-module.ts) registerTranslateExtension   (core/.../translate.extension.ts) resolveInjectedFactories   (core/.../extension-hooks.ts) retryWithDelay   (core/.../retry-with-delay.operator.ts) rootScopeFactory   (device-shell/.../command-templates.component.ts) SmartRulesServiceFactory   (upgrade/.../smart-rules.service.ts) sortByPriority   (core/.../extension-hooks.ts) stateToFactory   (core/.../extension-hooks.ts) strToNumber   (core/.../number.pipe.ts) throttle   (core/.../throttle.decorator.ts) toObservable   (core/.../extension-hooks.ts) toObservableOfArrays   (core/.../extension-hooks.ts) toProvider   (api/.../data.module.ts) translateLoaderFactory   (core/.../i18n.module.ts) trimTranslationKey   (core/.../translate.loader.ts)

core/common/virtual-scroll/virtual-scroll-window.directive.ts

_virtualScrollWindowStrategyFactory

_virtualScrollWindowStrategyFactory(windowDir: VirtualScrollWindowDirective)

Provider factory for VirtualScrollWindowStrategy that simply extracts the already created VirtualScrollWindowStrategy from the given directive. Parameters : Name Type Optional Description windowDir VirtualScrollWindowDirective No The instance of VirtualScrollWindowDirective to extract the VirtualScrollWindowStrategy from.

upgrade/absolute-date.service.ts

absoluteDateServiceFactory

absoluteDateServiceFactory(datePipe: DatePipe)

Parameters : Name Type Optional datePipe DatePipe No

polyfills/index.ts

addPolyfills

addPolyfills()

upgrade/auth-bridge.service.ts

authBridgeServiceFactory

authBridgeServiceFactory(injector: any, basicAuth: BasicAuth, fetchClient: FetchClient, appState: AppStateService, tenantUiService: TenantUiService)

Parameters : Name Type Optional injector any No basicAuth BasicAuth No fetchClient FetchClient No appState AppStateService No tenantUiService TenantUiService No

upgrade/bridge.service.ts

bridgeServiceFactory

bridgeServiceFactory(injector: any, appState: AppStateService, router: Router, ngZone: NgZone, routerService: RouterService, actionService: ActionService)

Parameters : Name Type Optional injector any No appState AppStateService No router Router No ngZone NgZone No routerService RouterService No actionService ActionService No

upgrade/ng1/alert.decorator.ts

c8yAlertDecorator

c8yAlertDecorator($delegate, $rootScope, $injector)

Parameters : Name Optional $delegate No $rootScope No $injector No

upgrade/ng1/navigator.provider.ts

c8yNavigatorProvider

c8yNavigatorProvider()

upgrade/ng1/http.interceptor.ts

c8yNg1HttpInterceptor

c8yNg1HttpInterceptor($q, c8yLoadingIndicator, c8yApiService)

Parameters : Name Optional $q No c8yLoadingIndicator No c8yApiService No

upgrade/ng1/title.decorator.ts

c8yTitleDecorator

c8yTitleDecorator($q, $delegate, $injector, $rootScope, $location, $templateCache, $compile, c8yHeaderService)

Parameters : Name Optional $q No $delegate No $injector No $rootScope No $location No $templateCache No $compile No c8yHeaderService No

upgrade/ng1/root.component.ts

c8yUiRootController

c8yUiRootController($rootScope, $timeout, c8yBase, c8yNavigator, c8yApplication, c8yHeaderService)

Parameters : Name Optional $rootScope No $timeout No c8yBase No c8yNavigator No c8yApplication No c8yHeaderService No

core/dynamic-forms/validation/validation-config.factory.ts

c8yValidationConfigFactory

c8yValidationConfigFactory(translate: TranslateService)

Parameters : Name Type Optional translate TranslateService No

upgrade/ng1/views.provider.ts

c8yViewsProvider

c8yViewsProvider($routeProvider, c8yTabsProvider, c8yPathUtils)

Parameters : Name Optional $routeProvider No c8yTabsProvider No c8yPathUtils No

upgrade/dashboard/dashboard-upgrade.module.ts

dashboardBridgeFactory

dashboardBridgeFactory(injector, ngZone, router, contextDashboardService)

Parameters : Name Optional injector No ngZone No router No contextDashboardService No

connectivity/sim/sim.module.ts

encodeFiles

encodeFiles(model: ProviderProperties, fields)

Parameters : Name Type Optional model ProviderProperties No fields No Returns : Promise<ProviderProperties>

core/data-grid/grid-data-source.ts

escapeRegExpPattern

escapeRegExpPattern(pattern: string)

Parameters : Name Type Optional Default value pattern string No ''

widgets/kpi-widget/kpi-widget-config/kpi-widget-config.component.ts

exactlyASingleDatapointActive

exactlyASingleDatapointActive()

Returns : ValidatorFn

core/dynamic-forms/dynamic-forms-ui-theme.module.ts

fieldTypeFactory

fieldTypeFactory()

core/common/extension-hooks.ts

fromFactories

fromFactories(factories?, router?: Router, withFirstEmpty)

Parameters : Name Type Optional Default value factories Yes router Router Yes withFirstEmpty No true Returns : Observable<T[]>

fromTrigger

fromTrigger(router, refresh, factories)

Parameters : Name Optional router No refresh No factories No

fromTriggerOnce

fromTriggerOnce(router, refresh, factories)

Parameters : Name Optional router No refresh No factories No

getActivatedRoute

getActivatedRoute(router: Router)

Helper function to get the activated route in a service (as ActivatedRoute injection only works in components). Works as long as we only use a tree and no child is active at the same time. Parameters : Name Type Optional Description router Router No The current router

isPromise

isPromise(obj: any)

Parameters : Name Type Optional obj any No Returns : Promise<T>

resolveInjectedFactories

resolveInjectedFactories(factories)

Parameters : Name Optional factories No

sortByPriority

sortByPriority(items)

Parameters : Name Optional items No

stateToFactory

stateToFactory(componentsState)

Parameters : Name Optional componentsState No Returns : ExtensionFactory<T>

toObservable

toObservable(value)

Converts any value provided to an Observable that emits this value once and then completes. A convienience method to represent all the data as Observables rather than a mixture of Observables and other types. Parameters : Name Optional Description value No The value the resulting Observable will emit. Returns : Observable<T>

toObservableOfArrays

toObservableOfArrays(factoryResult, withFirstEmpty)

Parameters : Name Optional factoryResult No withFirstEmpty No

core/i18n/i18n.module.ts

getAngularLocalesLanguageString

getAngularLocalesLanguageString(language)

Parameters : Name Optional language No

languagesFactory

languagesFactory(options: OptionsService)

Parameters : Name Type Optional options OptionsService No

localeId

localeId(appStateService: AppStateService)

Parameters : Name Type Optional appStateService AppStateService No

localePathFactory

localePathFactory(options: OptionsService)

Parameters : Name Type Optional options OptionsService No

translateLoaderFactory

translateLoaderFactory(httpClient: HttpClient, optionsService: OptionsService, cachedLocaleDictionaryService: CachedLocaleDictionaryService, localePath: string, languages: any)

Parameters : Name Type Optional httpClient HttpClient No optionsService OptionsService No cachedLocaleDictionaryService CachedLocaleDictionaryService No localePath string No languages any No

core/dynamic-forms/presets.ts

getBasicInputArrayFormFieldConfig

getBasicInputArrayFormFieldConfig(config: BasicInputArrayFormConfigInterface)

Generates simple array formFieldConfig Parameters : Name Type Optional config BasicInputArrayFormConfigInterface No Returns : FormlyFieldConfig[] FormlyFieldConfig[]

core/i18n/gettext.ts

gettext

gettext(str)

Parameters : Name Optional str No

upgrade/ng1/gettextCatalog.decorator.ts

gettextCatalogDecorator

gettextCatalogDecorator($delegate, $interpolate, c8yTranslate)

Parameters : Name Optional $delegate No $interpolate No c8yTranslate No

upgrade/ng1/groupsHierarchyNavigator.decorator.ts

groupTypesHierarchyNavigatorDecorator

groupTypesHierarchyNavigatorDecorator($delegate, $q)

Parameters : Name Optional $delegate No $q No

core/common/common.module.ts

initializeServices

initializeServices(translateService: TranslateService, state: AppStateService, userPreferences: UserPreferencesService)

Parameters : Name Type Optional translateService TranslateService No state AppStateService No userPreferences UserPreferencesService No

protocol-lpwan/multiple-lns-connectors/multiple-lns-connector.model.ts

isActilityConnection

isActilityConnection(connection)

Parameters : Name Optional connection No Returns : ActilityConnection

isSigfoxConnection

isSigfoxConnection(connection)

Parameters : Name Optional connection No Returns : SigfoxConnection

core/i18n/__mocks__/load-locale.ts

loadLocale

loadLocale(moduleLang)

Parameters : Name Optional moduleLang No

device-grid/map-legacy-grid-configuration.decorator.ts

mapLegacyGridConfiguration

mapLegacyGridConfiguration()

core/common/memoize.decorator.ts

memoize

memoize(resolver?)

Decorator to memoize function results. Parameters : Name Optional Description resolver Yes Cache key resolver function, used by memoize from lodash.

core/i18n/parse-module.ts

parse

parse(moduleSrc)

Parameters : Name Optional moduleSrc No

core/dynamic-forms/i18n/translate.extension.ts

registerTranslateExtension

registerTranslateExtension(translate: TranslateService, parser: TranslateParser)

Parameters : Name Type Optional translate TranslateService No parser TranslateParser No

core/common/retry-with-delay.operator.ts

retryWithDelay

retryWithDelay(delayTime: number, count: number)

Parameters : Name Type Optional Default value delayTime number No count number No 1 Returns : MonoTypeOperatorFunction<T>

device-shell/command-templates/command-templates.component.ts

rootScopeFactory

rootScopeFactory($injector: Injector)

Parameters : Name Type Optional $injector Injector No

upgrade/smart-rules.service.ts

SmartRulesServiceFactory

SmartRulesServiceFactory(injector: any)

Parameters : Name Type Optional injector any No

core/common/number.pipe.ts

strToNumber

strToNumber(value)

Transforms a string into a number (if needed). Parameters : Name Optional value No Returns : number

core/common/throttle.decorator.ts

throttle

throttle(wait?, options?)

Decorator to throttle functions call. Parameters : Name Optional Description wait Yes throttle time. options Yes set triggers, eg on trailing edge or falling edge, see lodash documentation for details

api/data.module.ts

toProvider

toProvider(provide)

Parameters : Name Optional provide No

core/i18n/translate.loader.ts

trimTranslationKey

trimTranslationKey(key)

Parameters : Name Optional key No