Index

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

core/dynamic-forms/addons/addon.extension.ts

addonsExtension
addonsExtension(field: FormlyFieldConfig)
Parameters :
Name Type Optional
field FormlyFieldConfig No

polyfills/index.ts

addPolyfills
addPolyfills()

computed-asset-properties/alarm-count/alarm-count-3-months-computed-property.ts

alarmCount3MonthsValue
alarmCount3MonthsValue(config: AlarmCountConfig, asset: IManagedObject, metadata: ValueCallbackMetadata)
Parameters :
Name Type Optional
config AlarmCountConfig No
asset IManagedObject No
metadata ValueCallbackMetadata No
Returns : Observable<number>

computed-asset-properties/alarm-count/alarm-count-today-computed-property.ts

alarmCountTodayValue
alarmCountTodayValue(config: AlarmCountConfig, asset: IManagedObject, metadata: ValueCallbackMetadata)
Parameters :
Name Type Optional
config AlarmCountConfig No
asset IManagedObject No
metadata ValueCallbackMetadata No
Returns : Observable<number>

computed-asset-properties/alarm-count/alarm-count-value.ts

alarmCountValue
alarmCountValue(config: AlarmCountConfig, asset: IManagedObject, dateFrom: Date, metadata: ValueCallbackMetadata)

Creates an Observable that tracks alarm count for a specific asset. When real-time is paused and resumed, it re-fetches the current count from server to account for alarms that occurred during the pause.

Parameters :
Name Type Optional Default value Description
config AlarmCountConfig No
  • Alarm filtering configuration (type, severities, etc.)
asset IManagedObject No
  • The managed object (device/asset) to track alarms for
dateFrom Date No
  • Start date for counting alarms
metadata ValueCallbackMetadata No { mode: 'realtime' }
  • Configuration controlling the behavior of the function
Returns : Observable<number>

Observable - Stream of alarm count values

alarms/cockpit/index.ts

alarmsCockpitRouteAndNodeConfig
alarmsCockpitRouteAndNodeConfig()

alarms/devicemanagement/index.ts

alarmsDeviceManagementRouteAndNodeConfig
alarmsDeviceManagementRouteAndNodeConfig()

core/alert/alert-on-error.ts

alertOnError
alertOnError(result: Promise)

Checks for errors in responses of requests made with @c8y/client services and displays them as alerts using AlertService.

Example

Example :
   const devices = await alertOnError(inventoryService.list({...}));
Parameters :
Name Type Optional Description
result Promise No

The result object from the @c8y/client service method

Returns : Promise<T>

The original response (success or failure) of the @c8y/client service method invokation

core/common/extension-hooks.ts

allEntriesAreEqual
allEntriesAreEqual(previous: Array, next: Array)
Parameters :
Name Type Optional
previous Array No
next Array No
Returns : boolean
fromFactories
fromFactories(factories?: Array, router?: Router, withFirstEmpty)
Parameters :
Name Type Optional Default value
factories Array Yes
router Router Yes
withFirstEmpty No true
Returns : Observable<T[]>
fromTrigger
fromTrigger(router: Router, refresh, factories: Array)
Parameters :
Name Type Optional
router Router No
refresh No
factories Array No
Returns : Observable<T[]>
fromTriggerOnce
fromTriggerOnce(router: Router, refresh, factories: Array, withFirstEmpty)
Parameters :
Name Type Optional Default value
router Router No
refresh No
factories Array No
withFirstEmpty No true
Returns : Observable<T[]>
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

Returns : ActivatedRoute
getInjectedHooks
getInjectedHooks(token: InjectionToken, injectors, type)
Parameters :
Name Type Optional Default value
token InjectionToken No
injectors No
type No InjectionType.COMPONENT
Returns : T[]
hookGeneric
hookGeneric(items, token: InjectionToken, options?: Partial)

A generic function to be used by specific implementations of the HOOK concept.

Parameters :
Name Type Optional Description
items No

The items that should be provided under the useValue or useClass attribute. Allows an extension factory to be passed as an argument, which can create instances of type T.

token InjectionToken No

The InjectionToken/HOOK to be provided.

options Partial Yes

If this is a multi provider or not (defaults to true) and provider type definition (defaults to ClassProvider) - HookOptions.

A Provider (either ValueProvider or ClassProvider) to be provided in a module.

isExtensionFactory
isExtensionFactory(obj: any)
Parameters :
Name Type Optional
obj any No
isPromise
isPromise(obj: any)
Parameters :
Name Type Optional
obj any No
Returns : Promise<T>
removeDuplicatesIds
removeDuplicatesIds(items)
Parameters :
Name Optional
items No
Returns : T[]
resolveInjectedFactories
resolveInjectedFactories(factories: Array)
Parameters :
Name Type Optional
factories Array No
sortByPriority
sortByPriority(items)
Parameters :
Name Optional
items No
Returns : T[]
stateToFactory
stateToFactory(componentsState)
Parameters :
Name Optional
componentsState No
toObservable
toObservable(value)

Converts any value provided to an Observable that emits this value once and then completes. A convenience 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: boolean)
Parameters :
Name Type Optional
factoryResult No
withFirstEmpty boolean No
Returns : Observable<T[]>

core/file-picker-form-control/file-picker-form-control.component.ts

appendErrors
appendErrors(errors: ValidationErrors, newErrors)
Parameters :
Name Type Optional
errors ValidationErrors No
newErrors No
Returns : ValidationErrors

global-context/core/widget-inline/orchestrator/shared-mode-aggregation.helper.ts

applyAggregationChangesForGlobalState
applyAggregationChangesForGlobalState(params: ApplyAggregationForGlobalStateParams)
Parameters :
Name Type Optional
params ApplyAggregationForGlobalStateParams No
Returns : boolean
evaluateAggregationValidation
evaluateAggregationValidation(deps: AggregationValidationDeps)
Parameters :
Name Type Optional
deps AggregationValidationDeps No
resolveAggregationChangeForForm
resolveAggregationChangeForForm(params: ResolveAggregationChangeForFormParams)
Parameters :
Name Type Optional
params ResolveAggregationChangeForFormParams No
resolveAutoUnlinkAggregationChange
resolveAutoUnlinkAggregationChange(params: ResolveAutoUnlinkParams)
Parameters :
Name Type Optional
params ResolveAutoUnlinkParams No

global-context/core/widget-inline/inline-link-helpers.ts

applyConfigOverride
applyConfigOverride(ctx: LinkHelpersContext, config: Partial)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
config Partial No
Returns : void
applyGlobalValueToForm
applyGlobalValueToForm(ctx: LinkHelpersContext, key)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
key No
Returns : void
applyHandlerResult
applyHandlerResult(ctx: LinkHelpersContext, result: WidgetStateHandlerResult)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
result WidgetStateHandlerResult No
Returns : boolean
applyLocalStateToForm
applyLocalStateToForm(ctx: LinkHelpersContext, keys: Array)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
keys Array No
Returns : void
buildControlLinkConfig
buildControlLinkConfig(ctx: LinkHelpersContext, settings: Partial, linkStates)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
settings Partial No
linkStates No
Returns : literal type
buildWidgetState
buildWidgetState(ctx: LinkHelpersContext, configOverride?)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
configOverride Yes
Returns : WidgetState
handleLinkToggle
handleLinkToggle(ctx: LinkHelpersContext, event: LinkToggleEvent, options?)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
event LinkToggleEvent No
options Yes
Returns : boolean
processLinkUpdates
processLinkUpdates(ctx: LinkHelpersContext, links: Partial, options?)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
links Partial No
options Yes
Returns : boolean
processOptions
processOptions(ctx: LinkHelpersContext, options: Record)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
options Record No
Returns : void
resetHandlerOverrides
resetHandlerOverrides(ctx: LinkHelpersContext)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
Returns : void
syncWithEffectiveConfig
syncWithEffectiveConfig(ctx: LinkHelpersContext, keys: Array)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
keys Array No
Returns : void
toggleAllLinks
toggleAllLinks(ctx: LinkHelpersContext, args)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
args No
Returns : void
updateFormAndLocalState
updateFormAndLocalState(ctx: LinkHelpersContext, field: T, value)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
field T No
value No
Returns : void
updateFormField
updateFormField(ctx: LinkHelpersContext, key, value)
Parameters :
Name Type Optional
ctx LinkHelpersContext No
key No
value No
Returns : void

global-context/core/widget-inline/inline-refresh-helpers.ts

applyLocalAggregationChange
applyLocalAggregationChange(ctx: RefreshHelpersContext, change: AggregationChangeInstruction)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
change AggregationChangeInstruction No
Returns : void
applyRefreshOutcome
applyRefreshOutcome(ctx: RefreshHelpersContext, outcome: RefreshResult)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
outcome RefreshResult No
Returns : void
calculateDisabledAggregationsFromContext
calculateDisabledAggregationsFromContext(ctx: RefreshHelpersContext, dateTimeContext: DateTimeContext)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
dateTimeContext DateTimeContext No
Returns : Partial<Record<aggregationType, boolean>>
calculateFromDateRange
calculateFromDateRange(ctx: RefreshHelpersContext, dateTimeContext: DateTimeContext)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
dateTimeContext DateTimeContext No
Returns : Partial<Record<aggregationType, boolean>>
calculateFromInterval
calculateFromInterval(ctx: RefreshHelpersContext, interval)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
interval No
Returns : Partial<Record<aggregationType, boolean>>
createDateRange
createDateRange(dateTimeContext: DateTimeContext)
Parameters :
Name Type Optional
dateTimeContext DateTimeContext No
deriveDisabledAggregations
deriveDisabledAggregations(ctx: RefreshHelpersContext)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
Returns : Partial<Record<aggregationType, boolean>>
generateFreshDateTimeContext
generateFreshDateTimeContext(interval: TimeInterval)
Parameters :
Name Type Optional
interval TimeInterval No
Returns : DateTimeContext
getShouldDisableIntervalConfig
getShouldDisableIntervalConfig(ctx: RefreshHelpersContext)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
Returns : Record<string, boolean>
handleGlobalRefresh
handleGlobalRefresh(ctx: RefreshHelpersContext, globalDateTimeContext: DateTimeContext)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
globalDateTimeContext DateTimeContext No
Returns : void
hasValidDateRange
hasValidDateRange(dateTimeContext)
Parameters :
Name Optional
dateTimeContext No
Returns : boolean
hasValidInterval
hasValidInterval(dateTimeContext: DateTimeContext)
Parameters :
Name Type Optional
dateTimeContext DateTimeContext No
Returns : boolean
patchFormValues
patchFormValues(ctx: RefreshHelpersContext, formUpdates: Partial)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
formUpdates Partial No
Returns : void
processRefreshEvent
processRefreshEvent(ctx: RefreshHelpersContext, params)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
params No
Returns : RefreshResult
recalculateAggregationForGlobalDateTime
recalculateAggregationForGlobalDateTime(ctx: RefreshHelpersContext)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
Returns : void
recalculateAggregationForLocalDateTime
recalculateAggregationForLocalDateTime(ctx: RefreshHelpersContext)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
Returns : void
updateAggregationValue
updateAggregationValue(ctx: RefreshHelpersContext, aggregation)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
aggregation No
Returns : void
updateFormDateTimeContext
updateFormDateTimeContext(ctx: RefreshHelpersContext, newContext: DateTimeContext)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
newContext DateTimeContext No
Returns : void
updateLocalDateTimeContext
updateLocalDateTimeContext(ctx: RefreshHelpersContext, newContext: DateTimeContext)
Parameters :
Name Type Optional
ctx RefreshHelpersContext No
newContext DateTimeContext No
Returns : void

global-context/integration/widget-controls/widget-controls-factory.ts

applySettings
applySettings(controls: WidgetControls, settings: WidgetControlSettings)

Transforms and applies hierarchical settings to the widget controls structure.

Takes the simplified WidgetControlSettings format and distributes the configuration across the complete WidgetControls structure, populating both inline (settings) and configuration panel (configSettings) branches for each display mode and refresh option.

This function also processes defaultLinks and ensures they are properly distributed to match the control settings hierarchy.

Parameters :
Name Type Optional Description
controls WidgetControls No
  • The WidgetControls object to modify (mutated in place)
settings WidgetControlSettings No
  • The simplified settings configuration to apply
Returns : void
defineWidgetControls
defineWidgetControls(config)

Creates a comprehensive widget controls configuration for global context integration.

This factory function generates the complete control structure that determines how a widget interacts with the global context (time range, aggregation, auto-refresh). It handles:

  • Feature support declaration
  • Control visibility across different display modes and refresh options
  • Default linking behavior between widget and global context
  • Dynamic control behavior through custom handlers
Parameters :
Name Optional Description
config No
  • Configuration object for widget controls
Returns : WidgetControls

Complete WidgetControls object ready for use in widget definitions

processHandlers
processHandlers(handlers: Record)

Wraps user-defined handlers into the stateHandlers format expected by WidgetControls.

This function transforms the simplified WidgetControlHandler format into the internal stateHandlers structure. Each handler receives the current widget state and returns modified control settings and link states.

The wrapper ensures handlers are always invoked (even without widget state) and properly propagates the widget state to the handler function for decision-making.

Parameters :
Name Type Optional Description
handlers Record No
  • Map of handler names to WidgetControlHandler definitions

echart/services/chart-types.service.ts

assertUnreachable
assertUnreachable(_: never)
Parameters :
Name Type Optional
_ never No
Returns : never

global-context/core/widget-inline/orchestrator/shared-mode-context.helper.ts

assignClonedValue
assignClonedValue(target: Partial, key: K, value)
Parameters :
Name Type Optional
target Partial No
key K No
value No
Returns : void
executeHandler
executeHandler(context: ExecuteHandlerContext, deps: ExecuteHandlerDependencies)
Parameters :
Name Type Optional
context ExecuteHandlerContext No
deps ExecuteHandlerDependencies No
Returns : void
handleFormChange
handleFormChange(context: HandleFormChangeContext, deps: FormChangeDependencies)
Parameters :
Name Type Optional
context HandleFormChangeContext No
deps FormChangeDependencies No
Returns : void
handleGlobalStateChange
handleGlobalStateChange(context: HandleGlobalStateChangeContext, deps: GlobalStateChangeDependencies)
Parameters :
Name Type Optional
context HandleGlobalStateChangeContext No
deps GlobalStateChangeDependencies No
Returns : void

core/forms/validate-array-elements.ts

asyncValidateArrayElements
asyncValidateArrayElements(validator: AsyncValidatorFn)

Async version of validateArrayElements.

Note that Angular by design doesn't execute async validators if synchronous validators returns any error.

Parameters :
Name Type Optional Description
validator AsyncValidatorFn No

A standard Angular asynchronous validator function.

Returns : AsyncValidatorFn
generateArrayRelatedErrors
generateArrayRelatedErrors(errors: Array)
Parameters :
Name Type Optional
errors Array No
validateArrayElements
validateArrayElements(validator: ValidatorFn)

This method can alter how validators work. It can be used in cases where there is need to validate FormControl that as value, takes array of elements. This allows to reuse validators, that works for such elements. For example if Validators.minLength(3) is used on control that takes string as value, validator will return error if string is less than 3 characters. If same is done on array of strings, validator will return error if array has less than 3 elements.

validateArrayElements(Validators.minLength(3)) method makes it possible to check every member of array if it has minimum 3 characters. If there are elements that raise error, it will be possible to extract these errors using item index.

As a example, this can be used for custom form elements, which manipulates array of elements, and there is need to display corresponding error messages for every array member that is displayed, while still using Angular's Validation approach.

Errors that are generated by this helper are prefixed with 'INNER_ARRAY_ERROR_'. Reason for this is to prevent overwriting normal validation errors that could have same key

Parameters :
Name Type Optional Description
validator ValidatorFn No

A standard Angular synchronous validator function.

Returns : ValidatorFn

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

global-context/integration/widget-controls/widget-controls-presets.helpers.ts

buildAggregationExtensions
buildAggregationExtensions()

Adds aggregation visibility and default link behaviour on top of the baseline template.

Partial widget controls that enable aggregation.

buildBaselineControls
buildBaselineControls()

Baseline control template used by most widgets. Mirrors the alarm list widget behaviour and serves as the foundation for additional presets.

Partial widget controls describing the baseline template.

createAutoRefreshHandlers
createAutoRefreshHandlers()

Factory returning scroll-friendly auto-refresh handlers used by multiple presets.

disableAutoRefreshHandler
disableAutoRefreshHandler(state: WidgetState)
Parameters :
Name Type Optional
state WidgetState No
enableAutoRefreshHandler
enableAutoRefreshHandler(state: WidgetState)
Parameters :
Name Type Optional
state WidgetState No
mergePartialControls
mergePartialControls(base: PartialWidgetControls, addition: PartialWidgetControls)

Returns a deep-merged copy of the baseline and supplied partial overrides, unionising supported keys and concatenating handlers.

Parameters :
Name Type Optional Description
base PartialWidgetControls No

Source template to extend.

addition PartialWidgetControls No

Additional partial overrides to apply.

Combined partial controls.

global-context/core/widget-inline/orchestrator/shared-mode-refresh.helper.ts

buildFreshContext
buildFreshContext(context: RefreshContext, interval: TimeInterval)
Parameters :
Name Type Optional
context RefreshContext No
interval TimeInterval No
Returns : DateTimeContext
calculateRefreshOutcome
calculateRefreshOutcome(context: RefreshContext, deps: RefreshDependencies)
Parameters :
Name Type Optional
context RefreshContext No
deps RefreshDependencies No
Returns : RefreshResult
handleLocalAutoRefresh
handleLocalAutoRefresh(context: RefreshContext, deps: RefreshDependencies)
Parameters :
Name Type Optional
context RefreshContext No
deps RefreshDependencies No
Returns : RefreshResult
resolveRefreshInterval
resolveRefreshInterval(fieldSources: FieldSourcesMap, configInterval)
Parameters :
Name Type Optional
fieldSources FieldSourcesMap No
configInterval No
Returns : TimeInterval

global-context/integration/widget-controls/widget-controls-presets.ts

buildWidgetControlsFromPresets
buildWidgetControlsFromPresets(config: WidgetControlsPresetConfig)

Creates a fully hydrated WidgetControls by expanding the selected presets (and optional customiser) against the default template.

Parameters :
Name Type Optional Description
config WidgetControlsPresetConfig No

Preset selection descriptor optionally providing a customize hook.

Returns : WidgetControls

Fully merged widget controls ready for consumption.

dedupe
dedupe(values)

Removes duplicate preset names while preserving the first occurrence.

Parameters :
Name Optional Description
values No

Sequence of preset identifiers.

Returns : WidgetPresetName[]

Deduplicated preset array.

isPresetConfig
isPresetConfig(input)
Parameters :
Name Optional
input No
mergeWidgetControls
mergeWidgetControls(base: WidgetControls, addition: PartialWidgetControls)

Merges partial control metadata into a cloned base instance, unionising the supported keys array and deep-merging nested settings/link structures.

Parameters :
Name Type Optional Description
base WidgetControls No

Starting widget controls template.

addition PartialWidgetControls No

Partial controls to merge into the template.

Returns : WidgetControls

Combined widget controls instance.

normalizePresetSelection
normalizePresetSelection(selection: WidgetPresetSelection)

Normalises caller input to a deduplicated, ordered preset array.

Parameters :
Name Type Optional Description
selection WidgetPresetSelection No

Value supplied to the presets API.

Returns : WidgetPresetName[]

Ordered list of preset identifiers without duplicates.

resolvePreset
resolvePreset(name: WidgetPresetName)

Retrieves the preset definition or throws if it does not exist.

Parameters :
Name Type Optional Description
name WidgetPresetName No

Name of the preset to resolve.

Preset definition from the registry.

resolveWidgetControlsInput
resolveWidgetControlsInput(input)
Parameters :
Name Optional
input No
Returns : WidgetControls
warnForExclusiveConflicts
warnForExclusiveConflicts(definitions)

Emits a console warning whenever multiple presets from the same exclusiveGroup are composed, signalling that later presets override earlier ones.

Parameters :
Name Optional Description
definitions No

Preset definitions selected for the current build.

Returns : void

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

dashboard-manager/devicemanagement/index.ts

canActivateDashboardManager
canActivateDashboardManager()
Returns : Observable<boolean>

datapoint-explorer/datapoint-explorer.module.ts

canActivateDatapointExplorer
canActivateDatapointExplorer()
Returns : Observable<boolean>

computed-asset-properties/child-count/child-assets-count-computed-property.ts

childAssetsCountValue
childAssetsCountValue(asset: IManagedObject, metadata: ValueCallbackMetadata)

Creates an Observable that tracks the count of child assets for a specific asset. Supports real-time updates when child assets are added or removed.

Parameters :
Name Type Optional Default value Description
asset IManagedObject No
  • The managed object (asset) to track child assets for
metadata ValueCallbackMetadata No { mode: 'realtime' }
  • Configuration controlling the behavior of the function
Returns : Observable<number>

Observable - Stream of child assets count values

computed-asset-properties/child-count/child-count-value.ts

childCountValue
childCountValue(asset: IManagedObject, metadata: ValueCallbackMetadata, childType)

Shared function that tracks the count of child items (devices or assets) for a specific managed object. Supports real-time updates when child items are added or removed.

Parameters :
Name Type Optional Default value Description
asset IManagedObject No
  • The managed object to track child items for
metadata ValueCallbackMetadata No { mode: 'realtime' }
  • Configuration controlling the behavior of the function
childType No
  • Type of child items ('childDevices' or 'childAssets')
Returns : Observable<number>

Observable - Stream of child items count values

computed-asset-properties/child-count/child-devices-count-computed-property.ts

childDevicesCountValue
childDevicesCountValue(asset: IManagedObject, metadata: ValueCallbackMetadata)

Creates an Observable that tracks the count of child devices for a specific asset. Supports real-time updates when child devices are added or removed.

Parameters :
Name Type Optional Default value Description
asset IManagedObject No
  • The managed object (asset) to track child devices for
metadata ValueCallbackMetadata No { mode: 'realtime' }
  • Configuration controlling the behavior of the function
Returns : Observable<number>

Observable - Stream of child devices count values

core/color-input/color-validator.ts

colorValidator
colorValidator(allowedModes?)
Parameters :
Name Optional
allowedModes Yes
Returns : AsyncValidatorFn

global-context/core/widget-inline/orchestrator/config-composer.util.ts

composeEffectiveConfig
composeEffectiveConfig(context: EffectiveConfigContext)
Parameters :
Name Type Optional
context EffectiveConfigContext No
Returns : GlobalContextState
resolveConfigurationValue
resolveConfigurationValue(key: K, sources: FieldSourcesMap, localStateValues: Partial, globalStateValues: Partial, baseConfiguration: Partial)
Parameters :
Name Type Optional
key K No
sources FieldSourcesMap No
localStateValues Partial No
globalStateValues Partial No
baseConfiguration Partial No
Returns : | undefined
safeCloneValue
safeCloneValue(value: T)
Parameters :
Name Type Optional
value T No
Returns : T

global-context/core/widget-inline/orchestrator/shared-mode-toggle.helper.ts

computeLinkToggle
computeLinkToggle(args: LinkToggleArgs)
Parameters :
Name Type Optional
args LinkToggleArgs No
Returns : LinkToggleOutcome
computeToggleAll
computeToggleAll(args: ToggleAllArgs)
Parameters :
Name Type Optional
args ToggleAllArgs No
Returns : LinkToggleOutcome

computed-asset-properties/configuration-snapshot/configuration-snapshot-computed-property.ts

configurationSnapshotValue
configurationSnapshotValue(config: ConfigurationSnapshotConfig, asset: IManagedObject)
Parameters :
Name Type Optional
config ConfigurationSnapshotConfig No
asset IManagedObject No
Returns : Observable<string>

widgets/widget-providers/index.ts

configureWidgetProviders
configureWidgetProviders(config: WidgetProvidersConfig)

Configures and returns widget providers.

This function allows selective loading of widget providers with their configuration hooks. Unlike cockpitWidgets() which only provides widget definitions, this includes the full providers with hookWidgetConfig registrations for features like widget preview.

Parameters :
Name Type Optional Default value Description
config WidgetProvidersConfig No {}

Configuration options for widget providers

Returns : Provider[]

Array of providers to be included in app.module.ts

widgets/definitions/alarms/alarm-widget-controls.presets/alarm-widget-controls.presets.ts

createAlarmListControls
createAlarmListControls()

Produces the baseline alarm list controls preset mirroring the default widget behaviour.

Returns : WidgetControls

Fresh baseline controls instance for the alarm list widget.

createLegacyAlarmControls
createLegacyAlarmControls()

Produces the legacy alarm controls preset shared by the "recent" and "critical" alarm widgets. It hides the refresh interval and exposes the manual refresh button inline.

Returns : WidgetControls

Alarm controls tailored for legacy alarm widgets.

mergeWithBaseline
mergeWithBaseline(overrides: Partial)

Helper that clones the baseline controls and applies the provided overrides.

Parameters :
Name Type Optional Description
overrides Partial No

Partial control information to merge into the baseline.

Returns : WidgetControls

Combined control definition.

resolveAlarmControls
resolveAlarmControls(widgetId?: string)

Resolves the appropriate controls preset based on the widget identifier.

Parameters :
Name Type Optional Description
widgetId string Yes

Optional widget id coming from the widget config/definition.

Returns : WidgetControls

Fully materialised controls for the widget.

branding/shared/data/branding.type.ts

createBrandingForm
createBrandingForm(formBuilder: FormBuilder)
Parameters :
Name Type Optional
formBuilder FormBuilder No
createGenericBrandingForm
createGenericBrandingForm(formBuilder: FormBuilder)
Parameters :
Name Type Optional
formBuilder FormBuilder No

global-context/utils/global-context-defaults.util.ts

createDefaultGlobalContextState
createDefaultGlobalContextState()

Creates a complete default global context state

Returns : GlobalContextState

A complete GlobalContextState with all required properties set to sensible defaults

fillMissingDefaults
fillMissingDefaults(state: Partial)

Fills missing or invalid properties in a partial global context state with defaults

Parameters :
Name Type Optional Description
state Partial No
  • Partial global context state that may have missing or invalid values
Returns : GlobalContextState

Complete GlobalContextState with all required properties

formatDateTimeContextForEmission
formatDateTimeContextForEmission(context: Partial, supports)

Formats dateTimeContext for emission, handling date conversions and defaults. Delegates to central utility for consistency.

Parameters :
Name Type Optional Description
context Partial No
  • Global context state to format
supports No
  • Array of supported fields from widget template
Returns : Partial<GlobalContextState>

Formatted context with properly formatted dateTimeContext

isCompleteDateTimeContext
isCompleteDateTimeContext(diff: Partial)

Checks if a dateTimeContext diff object is complete (has all 3 required fields). Delegates to central utility for consistency.

Parameters :
Name Type Optional Description
diff Partial No
  • Partial state that may contain dateTimeContext
Returns : boolean

true if dateTimeContext is absent, has only 1 field, or has all 3 fields; false if it has 2 fields (incomplete)

isValidDateTimeContext
isValidDateTimeContext(context)

Checks if a date time context object has all required valid properties Delegates to central utility for consistency.

Parameters :
Name Optional Description
context No
  • DateTimeContext to validate
Returns : DateTimeContext

true if the context is complete and valid

isValidDateValue
isValidDateValue(value)

Validates if a value is a valid date (either Date object or ISO string) Delegates to central utility for consistency.

Parameters :
Name Optional Description
value No
  • Value to validate (string, Date, or undefined)
Returns : string | Date

true if the value represents a valid date

widgets/import-export-config/device-import-export.ts

createExportedAsset
createExportedAsset(device: IManagedObject, identityService: IdentityService, inventoryService: InventoryService)

Creates a device with external identity information

Parameters :
Name Type Optional
device IManagedObject No
identityService IdentityService No
inventoryService InventoryService No
exportConfigWithDevice
exportConfigWithDevice(config: T, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)

Exports a configuration with asset information enriched for export

Parameters :
Name Type Optional
config T No
_dashboardData DashboardMetadata No
_options WidgetImportExportInjectorOptions No
hasAssetProperty
hasAssetProperty(config: any)

Check if a configuration has a valid device property

Parameters :
Name Type Optional
config any No
Returns : ConfigWithAsset
importConfigWithDevice
importConfigWithDevice(config: ExportedConfigWithAsset, dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)

Imports a configuration with asset information adapted to the current context

Parameters :
Name Type Optional
config ExportedConfigWithAsset No
dashboardData DashboardMetadata No
_options WidgetImportExportInjectorOptions No

widgets/import-export-config/target-transformers.ts

createExportedTargetObject
createExportedTargetObject(targetObject: T, identityService: IdentityService, inventoryService: InventoryService)

Transforms a single target object for export

Parameters :
Name Type Optional
targetObject T No
identityService IdentityService No
inventoryService InventoryService No
createImportedTargetObject
createImportedTargetObject(exportedTargetObject: ExportedTargetObject, context: IManagedObject)

Transforms a single exported target object for import

Parameters :
Name Type Optional
exportedTargetObject ExportedTargetObject No
context IManagedObject No
processExportedTargetArray
processExportedTargetArray(targetObjects, context: IManagedObject)

Transforms an array of exported target objects for import

Parameters :
Name Type Optional Default value
targetObjects No []
context IManagedObject No
processTargetArrayToExport
processTargetArrayToExport(targetObjects, identityService: IdentityService, inventoryService: InventoryService)

Transforms an array of target objects for export

Parameters :
Name Type Optional Default value
targetObjects No []
identityService IdentityService No
inventoryService InventoryService No

global-context/integration/widget-controls/update-helpers.ts

createResult
createResult(inlineSettings: Partial, dashboardSettings: Partial, links: Partial, options?: Record)

Creates a standardized result object for widget state handler responses.

Parameters :
Name Type Optional Default value Description
inlineSettings Partial No
  • Settings for inline display mode
dashboardSettings Partial No
  • Settings for dashboard display mode
links Partial No {}
  • Optional link state mappings for control synchronization
options Record Yes
  • Optional configuration like noAutoRefreshCounter

Standardized widget state handler result

setAutoRefreshControlsVisibility
setAutoRefreshControlsVisibility(state: WidgetState, showInDashboard: boolean)

Sets auto-refresh control visibility and link state based on display mode.

Implements inverse visibility pattern: auto-refresh is shown in dashboard mode (where it can be linked) and hidden in inline mode (where widgets handle it directly).

Parameters :
Name Type Optional Description
state WidgetState No
  • Current widget state
showInDashboard boolean No
  • Whether to show auto-refresh control in dashboard mode (inverted for inline)

Complete widget state handler result with settings and links

setAutoRefreshLinks
setAutoRefreshLinks(state: WidgetState, enabled: boolean)

Sets auto-refresh link state for dashboard display mode.

Parameters :
Name Type Optional Description
state WidgetState No
  • Current widget state
enabled boolean No
  • Whether auto-refresh should be linked to global context

Updated link states (empty object for non-dashboard modes)

updateBothSettings
updateBothSettings(state: WidgetState, inlineUpdates: Partial, dashboardUpdates: Partial)

Updates both inline and dashboard control settings simultaneously.

Parameters :
Name Type Optional Description
state WidgetState No
  • Current widget state containing existing settings
inlineUpdates Partial No
  • Settings to apply to inline display mode
dashboardUpdates Partial No
  • Settings to apply to dashboard display mode
Returns : Pick<WidgetStateHandlerResult, "inlineControlSettings" | "dashboardControlSettings">

Updated inline and dashboard control settings

global-context/core/widget-inline/orchestrator/validation.util.ts

deriveAggregationValue
deriveAggregationValue(config: GlobalContextState)
Parameters :
Name Type Optional
config GlobalContextState No
Returns : aggregationType | null
validateAggregationLink
validateAggregationLink(context: AggregationValidationContext)
Parameters :
Name Type Optional
context AggregationValidationContext No

connectivity/sim/sim.module.ts

encodeFiles
encodeFiles(model: ProviderProperties, fields)
Parameters :
Name Type Optional
model ProviderProperties No
fields No

widgets/implementations/info-gauge/info-gauge-widget-config/info-gauge-widget-config.component.ts

ensureAtLeastOneDatapointSelectedAndActive
ensureAtLeastOneDatapointSelectedAndActive(datapointListAttributes)
Parameters :
Name Optional
datapointListAttributes No
Returns : ValidatorFn

global-context/core/widget-inline/orchestrator/shared-mode-state.helper.ts

ensureDateTimeContext
ensureDateTimeContext(context, configSignal: WritableSignal)
Parameters :
Name Type Optional
context No
configSignal WritableSignal No
Returns : DateTimeContext
mapToContextDisplayMode
mapToContextDisplayMode(displayMode: WidgetDisplayMode)
Parameters :
Name Type Optional
displayMode WidgetDisplayMode No
resolveVisibilityContextInternal
resolveVisibilityContextInternal(config: GlobalContextState, widgetControlsSignal: WritableSignal, fieldSourcesSignal: WritableSignal, globalStateSignal: WritableSignal, widgetControlService: WidgetControlService, getDefaultRefreshOption)
Parameters :
Name Type Optional
config GlobalContextState No
widgetControlsSignal WritableSignal No
fieldSourcesSignal WritableSignal No
globalStateSignal WritableSignal No
widgetControlService WidgetControlService No
getDefaultRefreshOption No
resolveWidgetDisplayMode
resolveWidgetDisplayMode(initialConfig, globalState: Partial)
Parameters :
Name Type Optional
initialConfig No
globalState Partial No
Returns : WidgetDisplayMode
sanitizeGlobalState
sanitizeGlobalState(state, configSignal: WritableSignal, normalizeRefreshOption, getDefaultRefreshOption, ensureDateTimeContext)
Parameters :
Name Type Optional
state No
configSignal WritableSignal No
normalizeRefreshOption No
getDefaultRefreshOption No
ensureDateTimeContext No
Returns : Partial<GlobalContextState>
sanitizeLocalState
sanitizeLocalState(state, configSignal: WritableSignal, ensureDateTimeContext)
Parameters :
Name Type Optional
state No
configSignal WritableSignal No
ensureDateTimeContext No
Returns : Partial<GlobalContextState>
syncLocalEntriesWithGlobal
syncLocalEntriesWithGlobal(fieldSourcesSignal: WritableSignal, globalStateSignal: WritableSignal, localStateSignal: WritableSignal)
Parameters :
Name Type Optional
fieldSourcesSignal WritableSignal No
globalStateSignal WritableSignal No
localStateSignal WritableSignal No
Returns : void
syncSourcesForRefreshOption
syncSourcesForRefreshOption(displayMode: WidgetDisplayMode, refreshOption: RefreshOption, controls, fieldSourcesSignal: WritableSignal, getDefaultRefreshOption, setFieldSources)
Parameters :
Name Type Optional
displayMode WidgetDisplayMode No
refreshOption RefreshOption No
controls No
fieldSourcesSignal WritableSignal No
getDefaultRefreshOption No
setFieldSources No
Returns : void

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

escapeRegExpPattern
escapeRegExpPattern(pattern: string)
Parameters :
Name Type Optional Default value
pattern string No ''

computed-asset-properties/event-count/event-count-3-months.ts

eventCount3MonthsValue
eventCount3MonthsValue(config: EventCountConfig, asset: IManagedObject, metadata: ValueCallbackMetadata)
Parameters :
Name Type Optional
config EventCountConfig No
asset IManagedObject No
metadata ValueCallbackMetadata No
Returns : Observable<number>

computed-asset-properties/event-count/event-count-today.ts

eventCountTodayValue
eventCountTodayValue(config: EventCountConfig, asset: IManagedObject, metadata: ValueCallbackMetadata)
Parameters :
Name Type Optional
config EventCountConfig No
asset IManagedObject No
metadata ValueCallbackMetadata No
Returns : Observable<number>

computed-asset-properties/event-count/event-count-value.ts

eventCountValue
eventCountValue(config: EventCountConfig, asset: IManagedObject, dateFrom: Date, metadata: ValueCallbackMetadata)

Creates an Observable that tracks event count for a specific asset. When real-time is paused and resumed, it re-fetches the current count from server to account for events that occurred during the pause.

Parameters :
Name Type Optional Default value Description
config EventCountConfig No
  • Event filtering configuration (type, etc.)
asset IManagedObject No
  • The managed object (device/asset) to track events for
dateFrom Date No
  • Start date for counting events
metadata ValueCallbackMetadata No { mode: 'realtime' }
  • Configuration controlling the behavior of the function
Returns : Observable<number>

Observable - Stream of event count values

computed-asset-properties/last-measurement/last-measurement-config.component.ts

exactlyASingleDatapointActive
exactlyASingleDatapointActive()
Returns : ValidatorFn

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

exactlyASingleDatapointActive
exactlyASingleDatapointActive()
Returns : ValidatorFn

widgets/import-export-config/config-target-export.ts

exportConfigWithTargets
exportConfigWithTargets(config: T, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)

Exports widget configuration with all target objects transformed for export

Parameters :
Name Type Optional
config T No
_dashboardData DashboardMetadata No
_options WidgetImportExportInjectorOptions No

widgets/definitions/image/index.ts

exportImageWidgetConfig
exportImageWidgetConfig(config: ImageWidgetConfig, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
Parameters :
Name Type Optional
config ImageWidgetConfig No
_dashboardData DashboardMetadata No
_options WidgetImportExportInjectorOptions No
Returns : Promise<ExportedImageWidgetConfig>
importImageWidgetConfig
importImageWidgetConfig(config: ExportedImageWidgetConfig, dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
Parameters :
Name Type Optional
config ExportedImageWidgetConfig No
dashboardData DashboardMetadata No
_options WidgetImportExportInjectorOptions No
Returns : Promise<ImageWidgetConfig>

widgets/definitions/markdown/index.ts

exportMarkdownWidgetConfig
exportMarkdownWidgetConfig(config: MarkdownWidgetConfig, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
Parameters :
Name Type Optional
config MarkdownWidgetConfig No
_dashboardData DashboardMetadata No
_options WidgetImportExportInjectorOptions No
Returns : Promise<ExportedMarkdownWidgetConfig>
importMarkdownWidgetConfig
importMarkdownWidgetConfig(config: ExportedMarkdownWidgetConfig, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
Parameters :
Name Type Optional
config ExportedMarkdownWidgetConfig No
_dashboardData DashboardMetadata No
_options WidgetImportExportInjectorOptions No
Returns : Promise<MarkdownWidgetConfig>

widgets/import-export-config/target-import-export-types.ts

findTargetArrayProperties
findTargetArrayProperties(config: ConfigWithTargets)

Find all property names in an object that contain arrays of objects with __target property

Parameters :
Name Type Optional
config ConfigWithTargets No
Returns : string[]
isTargetObjectArray
isTargetObjectArray(value: any)

Helper function to check if a value is an array of objects with __target property

Parameters :
Name Type Optional
value any No
Returns : TargetObjectArray

core/i18n/i18n.module.ts

getAngularLocalesLanguageString
getAngularLocalesLanguageString(language: string)
Parameters :
Name Type Optional Default value
language string No 'en'
Returns : string
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
provideI18n
provideI18n()
Returns : Provider[]
provideTranslationServiceInstance
provideTranslationServiceInstance(options: RootTranslateServiceConfig)
Parameters :
Name Type Optional Default value
options RootTranslateServiceConfig No {}

core/dynamic-forms/presets.ts

getBasicInputArrayFormFieldConfig
getBasicInputArrayFormFieldConfig(config: BasicInputArrayFormConfigInterface)

Generates simple array formFieldConfig

Parameters :
Name Type Optional
config BasicInputArrayFormConfigInterface No
Returns : FormlyFieldConfig[]

FormlyFieldConfig[]

map/map.model.ts

getC8yMarker
getC8yMarker(marker, asset?: PositionManagedObject, event?: IEvent)

Utility function to assign asset and event information to a Leaflet marker.

Parameters :
Name Type Optional Description
marker No

The Leaflet marker instance.

asset PositionManagedObject Yes

The managed object representing the asset (optional).

event IEvent Yes

The event associated with the marker (optional).

alarms/alarms.helper.ts

getChildrenForViewContext
getChildrenForViewContext(context: ViewContext)
Parameters :
Name Type Optional
context ViewContext No
Returns : Routes
getViewContextRoutes
getViewContextRoutes(contexts)
Parameters :
Name Optional
contexts No
Returns : Routes

core/i18n/translation-utils.ts

getDictionaryWithTrimmedKeys
getDictionaryWithTrimmedKeys(dictionary)

We want to have translation keys unified, so they don't contain unnecessary spaces and line breaks. This way we can dynamically build keys from HTML, and match them to extracted string, that might be HTML as well.

Parameters :
Name Optional
dictionary No
trimTranslationKey
trimTranslationKey(key: string)

Returns a trimmed translation key. If the key contains HTML, it also removes all whitespaces. The reason behind it is that by default Angular compiler removes whitespaces from adjacent inline elements, which prevents ngx-translate from finding a matching entry in the dictionary.

Parameters :
Name Type Optional
key string No

widgets/import-export-config/shared-helpers.ts

getExternalIdentityByTargetId
getExternalIdentityByTargetId(targetId, identityService: IdentityService)
Parameters :
Name Type Optional
targetId No
identityService IdentityService No
Returns : Promise<IExternalIdentity>
resolveSuggestedAsset
resolveSuggestedAsset(exportedDevice: ExportedAsset, contextDevice: IManagedObject)
Parameters :
Name Type Optional
exportedDevice ExportedAsset No
contextDevice IManagedObject No
Returns : Promise<IManagedObject | null>
targetDetails
targetDetails(targetId, inventoryService: InventoryService)
Parameters :
Name Type Optional
targetId No
inventoryService InventoryService No
Returns : Promise<IManagedObject>

computed-asset-properties/last-device-message/last-device-message-value.ts

getLastDeviceMessage
getLastDeviceMessage(asset: IManagedObject, metadata: ValueCallbackMetadata)

Gets the latest timestamp from events, alarms, measurements, and operations for a device. Returns the most recent timestamp across all these sources.

Parameters :
Name Type Optional Default value Description
asset IManagedObject No
  • The managed object (device/asset) to track
metadata ValueCallbackMetadata No { mode: 'realtime' }
  • Configuration controlling the behavior of the function
Returns : Observable<string>

Observable - Stream of latest timestamp values

core/plugins/__test__/plugins-test-helper.ts

getRemoteTestingModule
getRemoteTestingModule(providers, providersSubModule?)
Parameters :
Name Optional
providers No
providersSubModule Yes
Returns : Type<any>

gettext/gettext.ts

gettext
gettext(str: T)

Identity function used for marking strings for translation

Parameters :
Name Type Optional
str T No
Returns : T

core/i18n/gettext.ts

gettext
Use `import { gettext } from '@c8y/ngx-components/gettext';` instead.
gettext(str: T)
Parameters :
Name Type Optional
str T No
Returns : T

upgrade/ng1/gettextCatalog.decorator.ts

gettextCatalogDecorator
gettextCatalogDecorator($delegate, $interpolate, c8yTranslate)
Parameters :
Name Optional
$delegate No
$interpolate No
c8yTranslate No

core/dashboard/widget-auto-refresh-context/global-refresh-loading.operator.ts

globalAutoRefreshLoading
globalAutoRefreshLoading(globalRefreshService: WidgetGlobalAutoRefreshService)
Parameters :
Name Type Optional
globalRefreshService WidgetGlobalAutoRefreshService No
Returns : MonoTypeOperatorFunction<boolean>

upgrade/ng1/groupsHierarchyNavigator.decorator.ts

groupTypesHierarchyNavigatorDecorator
groupTypesHierarchyNavigatorDecorator($delegate, $q)
Parameters :
Name Optional
$delegate No
$q No

core/action/action.service.ts

hookAction
hookAction(actions: GenericHookType, options?: Partial)

A hook to add an action using the multi-provider extension concept.

You can either provide a single Action as parameter:

Example :
 hookAction(...)

Or an array to directly register multiple:

Example :
 hookAction([...])

Or you provide an Service that implements ExtensionFactory<Action>

Example :
 export class MyActionFactory implements ExtensionFactory<Action> {...}
 ...
 hookAction(MyActionFactory)

A typed alternative to HOOK_ACTION.

Parameters :
Name Type Optional Description
actions GenericHookType No

The Action's or ExtensionFactory to be provided.

options Partial Yes

core/action-bar/action-bar.service.ts

hookActionBar
hookActionBar(items: GenericHookType, options?: Partial)

A hook to add ActionBarItems using the multi provider extension concept.

You can either provide a single ActionBarItem as parameter:

Example :
 hookActionBar(...)

Or an array to directly register multiple:

Example :
 hookActionBar([...])

Or you provide an Service that implements ExtensionFactory<ActionBarItem>

Example :
 export class MyActionBarFactory implements ExtensionFactory<ActionBarItem> {...}
 ...
 hookActionBar(MyActionBarFactory)

A typed alternative to HOOK_ACTION_BAR.

Parameters :
Name Type Optional Description
items GenericHookType No

The ActionBarItem's or ExtensionFactory to be provided.

options Partial Yes

core/breadcrumb/breadcrumb.service.ts

hookBreadcrumb
hookBreadcrumb(breadcrumb: GenericHookType, options?: Partial)

You can either provide a single Breadcrumb as parameter:

Example :
 hookBreadcrumb(...)

Or an array to directly register multiple:

Example :
 hookBreadcrumb([...])

Or you provide an Service that implements ExtensionFactory<Breadcrumb>

Example :
 export class MyBreadcrumbFactory implements ExtensionFactory<Breadcrumb> {...}
 ...
 hookBreadcrumb(MyBreadcrumbFactory)

A typed alternative to HOOK_BREADCRUMB.

Parameters :
Name Type Optional Description
breadcrumb GenericHookType No

The Breadcrumb's or ExtensionFactory to be provided.

options Partial Yes

core/dynamic-component/dynamic-component.model.ts

hookComponent
hookComponent(components: GenericHookType, options?: Partial)

A hook to add dynamic components to the UI (e.g. widgets).

You can either provide a single DynamicComponentDefinition as parameter:

Example :
 hookComponent(...)

Or an array to directly register multiple:

Example :
 hookComponent([...])

Or you provide an Service that implements ExtensionFactory<DynamicComponentDefinition>

Example :
 export class MyDynamicComponentDefinitionFactory implements ExtensionFactory<DynamicComponentDefinition> {...}
 ...
 hookComponent(MyDynamicComponentDefinitionFactory)

A typed alternative to HOOK_COMPONENTS.

Parameters :
Name Type Optional Description
components GenericHookType No

The DynamicComponentDefinition's or ExtensionFactory to be provided.

options Partial Yes
hookWidget
hookWidget(components: GenericHookType, options?: Partial)

Hook to add dynamic widget components to the UI.

You can either provide a single DynamicWidgetDefinition as parameter:

Example :
 hookWidget(...)

Or an array to directly register multiple:

Example :
 hookWidget([...])
  • Or you provide a Service that implements ExtensionFactory<DynamicWidgetDefinition>
Example :
 export class MyDynamicWidgetDefinitionFactory implements ExtensionFactory<DynamicWidgetDefinition> {...}
 ...
 hookWidget(MyDynamicWidgetDefinitionFactory)

A widget specific alternative to hookComponent..

Parameters :
Name Type Optional Description
components GenericHookType No

The DynamicWidgetDefinition's or ExtensionFactory to be provided.

options Partial Yes

Options to configure the hook.

isEagerDynamicComponents
isEagerDynamicComponents(componentDefinition: DynamicComponents)
Parameters :
Name Type Optional
componentDefinition DynamicComponents No
isLazyDynamicComponents
isLazyDynamicComponents(componentDefinition: DynamicComponents)
Parameters :
Name Type Optional
componentDefinition DynamicComponents No

asset-properties/computed-properties.service.ts

hookComputedProperty
hookComputedProperty(property: GenericHookType, options?: Partial)
Parameters :
Name Type Optional
property GenericHookType No
options Partial Yes

core/common/ui-state.service.ts

hookCurrentApplication
hookCurrentApplication(application: IApplication)
Parameters :
Name Type Optional
application IApplication No
hookCurrentTenant
hookCurrentTenant(tenant: ICurrentTenant)
Parameters :
Name Type Optional
tenant ICurrentTenant No
hookCurrentUser
hookCurrentUser(user)
Parameters :
Name Optional
user No
provideBootstrapMetadata
provideBootstrapMetadata(metadata: BootstrapMetaData)
Parameters :
Name Type Optional
metadata BootstrapMetaData No
Returns : StaticProvider[]

core/data-grid/action-controls-extension.service.ts

hookDataGridActionControls
hookDataGridActionControls(action: GenericHookType, options?: Partial)

You can either provide a single ActionControlHook as parameter:

Example :
 hookDataGridActionControls(...)

Or an array to directly register multiple:

Example :
 hookDataGridActionControls([...])

Or you provide a service that implements ActionControlFactory

Example :
 export class MyActionControlsFactory implements ActionControlFactory {...}
 ...
 hookDataGridActionControls(MyActionControlsFactory)
Parameters :
Name Type Optional
action GenericHookType No
options Partial Yes

device-list/device-list-extension.service.ts

hookDeviceListColumns
hookDeviceListColumns(columns: GenericHookType, options?: Partial)

A hook to override the default device grid columns configuration in c8y-device-list component.

Parameters :
Name Type Optional
columns GenericHookType No
options Partial Yes

register-device/dropdown/register-device-extension.service.ts

hookDeviceRegistration
hookDeviceRegistration(registration: GenericHookType, options?: Partial)

You can either provide a single RegisterDeviceExtension as parameter:

Example :
 hookDeviceRegistration(...)

Or an array to directly register multiple:

Example :
 hookDeviceRegistration([...])

Or you provide an Service that implements ExtensionFactory<RegisterDeviceExtension>

Example :
 export class MyDeviceRegistrationFactory implements ExtensionFactory<RegisterDeviceExtension> {...}
 ...
 hookDeviceRegistration(MyDeviceRegistrationFactory)

A typed alternative to HOOK_DEVICE_REGISTRATION.

Parameters :
Name Type Optional Description
registration GenericHookType No

The RegisterDeviceExtension's or ExtensionFactory to be provided.

options Partial Yes

core/docs/docs.models.ts

hookDocs
hookDocs(doc: GenericHookType)

You can either provide a single DocLink as parameter:

Example :
 hookOptions(...)

Or an array to directly register multiple:

Example :
 hookOptions([...])

Or you provide an Service that implements ExtensionFactory<DocLink> ```typescript

Parameters :
Name Type Optional Description
doc GenericHookType No

The DocLink's or ExtensionFactory to be provided.

core/drawer/drawer.service.ts

hookDrawer
hookDrawer(drawer: GenericHookType, options?: Partial)

You can either provide a single DrawerItem as parameter:

Example :
 hookDrawer(...)

Or an array to directly register multiple:

Example :
 hookDrawer([...])

Or you provide a Service that implements ExtensionFactory<DrawerItem>

Example :
 export class MyDrawerFactory implements ExtensionFactory<DrawerItem> {...}
 ...
 hookDrawer(MyDrawerFactory)

A typed alternative to HOOK_DRAWER.

Parameters :
Name Type Optional Description
drawer GenericHookType No

The DrawerItem's or ExtensionFactory to be provided.

options Partial Yes

core/provider-configuration/provider-configuration-hook.ts

hookDynamicProviderConfig
hookDynamicProviderConfig(config: GenericHookType, options?: Partial)

You can either provide a single DynamicProviderConfig as parameter:

Example :
 hookDynamicProviderConfig(...)

Or an array to directly register multiple:

Example :
 hookDynamicProviderConfig([...])

Or you provide an Service that implements ExtensionFactory<DynamicProviderConfig>

Example :
 export class MyDynamicProviderConfigFactory implements ExtensionFactory<DynamicProviderConfig> {...}
 ...
 hookDynamicProviderConfig(MyDynamicProviderConfigFactory)

A typed alternative to HOOK_DYNAMIC_PROVIDER_CONFIG.

Parameters :
Name Type Optional Description
config GenericHookType No

The DynamicProviderConfig's or ExtensionFactory to be provided.

options Partial Yes

core/data-grid/filter-chip/filter-mapper.factory.ts

hookFilterMapper
hookFilterMapper(mapper: HookValueType, options?: Partial)

You can either provide a single FilterMapper as parameter:

Example :
 hookFilterMapper(...)

Or an array to directly register multiple:

Example :
 hookFilterMapper([...])

Or you provide an Service that implements FilterMapper

Example :
 export class MyFilterMapper implements FilterMapper {...}
 ...
 hookFilterMapper(MyFilterMapper)

A typed alternative to using HOOK_FILTER_MAPPER.

Parameters :
Name Type Optional Description
mapper HookValueType No

A filter mapper, e.g. BooleanFilterMapper, or ExtensionFactory to be provided.

options Partial Yes

If this is a multi provider or not (defaults to true) and provider type definition (defaults to ClassProvider) - HookOptions.

operations/bulk-operations-service/bulk-operations.service.ts

hookListBulkType
hookListBulkType(type: GenericHookType, options?: Partial)

You can either provide a single OperationType as parameter:

Example :
 hookListBulkType(...)

Or an array to directly register multiple:

Example :
 hookListBulkType([...])

Or you provide an Service that implements ExtensionFactory<OperationType>

Example :
 export class MyListBulkTypeFactory implements ExtensionFactory<OperationType> {...}
 ...
 hookListBulkType(MyListBulkTypeFactory)

A typed alternative to HOOK_LIST_BULK_TYPE.

Parameters :
Name Type Optional Description
type GenericHookType No

The OperationType's or ExtensionFactory to be provided.

options Partial Yes

core/navigator/navigator.service.ts

hookNavigator
hookNavigator(nodes: GenericHookType, options?: Partial)

You can either provide a single NavigatorNode or NavigatorNodeData as parameter:

Example :
 hookNavigator(...)

Or an array to directly register multiple:

Example :
 hookNavigator([...])

Or you provide an Service that implements ExtensionFactory<NavigatorNode | NavigatorNodeData>

Example :
 export class MyNavigatorFactory implements ExtensionFactory<NavigatorNode | NavigatorNodeData> {...}
 ...
 hookNavigator(MyNavigatorFactory)

A typed alternative to HOOK_NAVIGATOR_NODES.

Parameters :
Name Type Optional Description
nodes GenericHookType No

The NavigatorNode's, NavigatorNodeData's or ExtensionFactory to be provided.

options Partial Yes

core/common/options.service.ts

hookOptions
hookOptions(options: GenericHookType, hookOptions?: Partial)

You can either provide a single ApplicationOptions as parameter:

Example :
 hookOptions(...)

Or an array to directly register multiple:

Example :
 hookOptions([...])

Or you provide an Service that implements ExtensionFactory<ApplicationOptions>

Example :
 export class MyApplicationOptionsFactory implements ExtensionFactory<ApplicationOptions> {...}
 ...
 hookOptions(MyApplicationOptionsFactory)

A typed alternative to HOOK_OPTIONS.

Parameters :
Name Type Optional Description
options GenericHookType No

The ApplicationOptions's or ExtensionFactory to be provided.

hookOptions Partial Yes

core/i18n/patterns-message.hook.ts

hookPatternMessages
hookPatternMessages(patterns: GenericHookType, options?: Partial)

You can either provide a single PatternMessages as parameter:

Example :
 hookPatternMessages(...)

Or an array to directly register multiple:

Example :
 hookPatternMessages([...])

Or you provide an Service that implements ExtensionFactory<PatternMessages>

Example :
 export class MyPatternMessagesFactory implements ExtensionFactory<PatternMessages> {...}
 ...
 hookPatternMessages(MyPatternMessagesFactory)

A typed alternative to HOOK_PATTERN_MESSAGES.

Parameters :
Name Type Optional Description
patterns GenericHookType No

The PatternMessages's or ExtensionFactory to be provided.

options Partial Yes

core/plugins/plugins-loader.service.ts

hookPlugin
Only meant for internal usage.
hookPlugin(plugins: GenericHookType)
Parameters :
Name Type Optional
plugins GenericHookType No

core/preview-feature/preview-feature.service.ts

hookPreview
hookPreview(preview: GenericHookType, options?: Partial)
Parameters :
Name Type Optional
preview GenericHookType No
options Partial Yes

core/query-param-handler/query-param-handler.service.ts

hookQueryParam
hookQueryParam(config: GenericHookType, options?: Partial)
Parameters :
Name Type Optional
config GenericHookType No
options Partial Yes

core/query-param-handler/query-param-bottom-drawer.service.ts

hookQueryParamBottomDrawer
hookQueryParamBottomDrawer(config: GenericHookType, options?: Partial)
Parameters :
Name Type Optional
config GenericHookType No
options Partial Yes

core/query-param-handler/query-param-modal-handler.service.ts

hookQueryParamModal
hookQueryParamModal(config: GenericHookType, options?: Partial)
Parameters :
Name Type Optional
config GenericHookType No
options Partial Yes

core/router/router.service.ts

hookRoute
hookRoute(route: GenericHookType, options?: Partial)

You can either provide a single Route as parameter:

Example :
 hookRoute(...)

Or an array to directly register multiple:

Example :
 hookRoute([...])

Or you provide an Service that implements ExtensionFactory<Route>

Example :
 export class MyRouteFactory implements ExtensionFactory<Route> {...}
 ...
 hookRoute(MyRouteFactory)

A typed alternative to HOOK_ROUTE.

Parameters :
Name Type Optional Description
route GenericHookType No

The Route's or ExtensionFactory to be provided.

options Partial Yes

core/search/search.service.ts

hookSearch
Please don't use the search factory. It will be refactored soon.
hookSearch(search: GenericHookType, options?: Partial)

You can either provide a single Search as parameter:

Example :
 hookSearch(...)

Or an array to directly register multiple:

Example :
 hookSearch([...])

Or you provide an Service that implements ExtensionFactory<Search>

Example :
 export class MySearchFactory implements ExtensionFactory<Search> {...}
 ...
 hookSearch(MySearchFactory)

A typed alternative to HOOK_SEARCH.

Parameters :
Name Type Optional Description
search GenericHookType No

The Search's or ExtensionFactory to be provided.

options Partial Yes

core/common/service-registry.service.ts

hookService
hookService(extensionKey: T, service: Type, options?: Partial)

Registers a service using a specified extension key. This function facilitates dynamic service registration, enabling services to be retrieved and used throughout the application based on their extension key.

Parameters :
Name Type Optional Description
extensionKey T No

The unique identifier for the service, defined within the ExtensionKeys interface.

service Type No

The class type of the service to register.

options Partial Yes

services/status-options/status-options.model.ts

hookServiceStatus
hookServiceStatus(status: GenericHookType, options?: Partial)

Extension hook allowing to register custom service statuses and configure their visual presentation.

You can either provide a single StatusOption as parameter:

Example :
 hookServiceStatus(...)

Or an array to directly register multiple:

Example :
 hookServiceStatus([...])

Or you provide an Service that implements ExtensionFactory<StatusOption>

Example :
 export class MyServiceStatusFactory implements ExtensionFactory<StatusOption> {...}
 ...
 hookServiceStatus(MyServiceStatusFactory)

A typed alternative to HOOK_SERVICE_STATUS.

Parameters :
Name Type Optional Description
status GenericHookType No

The StatusOption's or ExtensionFactory to be provided.

options Partial Yes

core/stepper/stepper.service.ts

hookStepper
hookStepper(step: GenericHookType, options?: Partial)

You can either provide a single Step as parameter:

Example :
 hookStepper(...)

Or an array to directly register multiple:

Example :
 hookStepper([...])

Or you provide an Service that implements ExtensionFactory<Step>

Example :
 export class MyStepFactory implements ExtensionFactory<Step> {...}
 ...
 hookStepper(MyStepFactory)

A typed alternative to HOOK_STEPPER.

Parameters :
Name Type Optional Description
step GenericHookType No

The Step's or ExtensionFactory to be provided.

options Partial Yes

core/tabs/tabs.service.ts

hookTab
hookTab(tabs: GenericHookType, options?: Partial)

You can either provide a single Tab as parameter:

Example :
 hookTab(...)

Or an array to directly register multiple:

Example :
 hookTab([...])

Or you provide an Service that implements ExtensionFactory<Tab>

Example :
 export class MyTabFactory implements ExtensionFactory<Tab> {...}
 ...
 hookTab(MyTabFactory)

A typed alternative to HOOK_TABS.

Parameters :
Name Type Optional Description
tabs GenericHookType No

The Tab's or ExtensionFactory to be provided.

options Partial Yes

core/user/user-menu.service.ts

hookUserMenu
hookUserMenu(userMenu: GenericHookType, options?: Partial)

You can either provide a single UserMenuItem as parameter:

Example :
hookUserMenu(...)

Or an array to directly register multiple:

Example :
hookUserMenu([...])

Or you provide a Service that implements ExtensionFactory<UserMenuItem>

Example :
export class MyUserMenuFactory implements ExtensionFactory<UserMenuItem> {...}
...
hookUserMenu(MyUserMenuFactory)
Parameters :
Name Type Optional Description
userMenu GenericHookType No

The UserMenuItem's or ExtensionFactory to be provided.

options Partial Yes

The options to use for the hook.

core/version/version.model.ts

hookVersion
hookVersion(versions: GenericHookType, options?: Partial)

You can either provide a single Version as parameter:

Example :
 hookVersion(...)

Or an array to directly register multiple:

Example :
 hookVersion([...])

Or you provide an Service that implements ExtensionFactory<Version>

Example :
 export class MyVersionFactory implements ExtensionFactory<Version> {...}
 ...
 hookVersion(MyVersionFactory)

A typed alternative to HOOK_VERSION.

Parameters :
Name Type Optional Description
versions GenericHookType No

The Version's or ExtensionFactory to be provided.

options Partial Yes

context-dashboard/widget-config-hook/widget-config-hook.model.ts

hookWidgetConfig
hookWidgetConfig(components: GenericHookType, options?: Partial)

A hook to add dynamic components to the UI (e.g. widgets).

You can either provide a single DynamicComponentDefinition as parameter:

Example :
 hookWidgetConfig(...)

Or an array to directly register multiple:

Example :
 hookWidgetConfig([...])

Or you provide an Service that implements ExtensionFactory<DynamicComponentDefinition>

Example :
 export class MyDynamicComponentDefinitionFactory implements ExtensionFactory<DynamicComponentDefinition> {...}
 ...
 hookWidgetConfig(MyDynamicComponentDefinitionFactory)

A typed alternative to HOOK_WIDGET_CONFIG.

Parameters :
Name Type Optional Description
components GenericHookType No

The DynamicComponentDefinition's or ExtensionFactory to be provided.

options Partial Yes

core/wizard/wizard.model.ts

hookWizard
hookWizard(wizard: GenericHookType, options?: Partial)

A hook to add wizard entries.

You can either provide a single WizardEntry as parameter:

Example :
 hookWizard(...)

Or an array to directly register multiple:

Example :
 hookWizard([...])

Or you provide an Service that implements ExtensionFactory<WizardEntry>

Example :
 export class MyWizardFactory implements ExtensionFactory<WizardEntry> {...}
 ...
 hookWizard(MyWizardFactory)

A typed alternative to HOOK_WIZARD.

Parameters :
Name Type Optional Description
wizard GenericHookType No

The WizardEntry's or ExtensionFactory to be provided.

options Partial Yes

widgets/import-export-config/config-target-import.ts

importConfigWithTargets
importConfigWithTargets(config: ExportedConfigWithTargets, dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)

Imports widget configuration with all target objects transformed for the current context

Parameters :
Name Type Optional
config ExportedConfigWithTargets No
dashboardData DashboardMetadata No
_options WidgetImportExportInjectorOptions No

editor/editor.component.ts

initializeMonacoEnvironment
initializeMonacoEnvironment()
loadMonacoEditor
loadMonacoEditor()

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

isActilityConnection
isActilityConnection(connection)
Parameters :
Name Optional
connection No
Returns : ActilityConnection
isLoriotConnection
isLoriotConnection(connection)
Parameters :
Name Optional
connection No
Returns : LoriotConnection
isSigfoxConnection
isSigfoxConnection(connection)
Parameters :
Name Optional
connection No
Returns : SigfoxConnection

global-context/integration/widget-controls/guards.ts

isAggregationLinked
isAggregationLinked(state: GuardState)

Check if aggregation is linked

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isAggregationUnlinked
isAggregationUnlinked(state: GuardState)

Check if aggregation is unlinked

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isAutoRefreshDisabled
isAutoRefreshDisabled(state: GuardState)

Check if auto-refresh is disabled (unlinked)

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isAutoRefreshEnabled
isAutoRefreshEnabled(state: GuardState)

Check if auto-refresh is enabled (linked)

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isConfig
isConfig(state: GuardState)

Check if the current display mode is config

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isDashboard
isDashboard(state: GuardState)

Guard functions for widget control handlers. These functions help determine conditions for when handlers should execute or return early.

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isDateTimeContextLinked
isDateTimeContextLinked(state: GuardState)

Check if dateTimeContext is linked

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isDateTimeContextUnlinked
isDateTimeContextUnlinked(state: GuardState)

Check if dateTimeContext is unlinked

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isHistory
isHistory(state: GuardState)

Check if the current refresh option is history

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isLive
isLive(state: GuardState)

Check if the current refresh option is live

Parameters :
Name Type Optional
state GuardState No
Returns : boolean
isViewAndConfig
isViewAndConfig(state: GuardState)

Check if the current display mode is view and config

Parameters :
Name Type Optional
state GuardState No
Returns : boolean

auth-configuration/basic-settings/basic-settings.model.ts

isBasic
isBasic(tenantLoginOption: TenantLoginOption)
Parameters :
Name Type Optional
tenantLoginOption TenantLoginOption No
isOauthInternal
isOauthInternal(tenantLoginOption: TenantLoginOption)
Parameters :
Name Type Optional
tenantLoginOption TenantLoginOption No

sub-assets/fullscreen.util.ts

isFullScreenEnabled
isFullScreenEnabled(element)
Parameters :
Name Optional
element No
toggleFullscreen
toggleFullscreen(element)
Parameters :
Name Optional
element No

replace-device/replace-device-wizard/replace-device-wizard.model.ts

isValidReplaceDeviceStepState
isValidReplaceDeviceStepState(state)
Parameters :
Name Optional
state No

computed-asset-properties/last-measurement/last-measurement-value.ts

lastMeasurementValue
lastMeasurementValue(config: LastMeasurementConfig, metadata: ValueCallbackMetadata)

Creates an Observable that tracks the latest measurement value for a specific datapoint. Combines initial server fetch with real-time measurement updates.

Parameters :
Name Type Optional Default value Description
config LastMeasurementConfig No
  • Measurement configuration (datapoint, result type, etc.)
metadata ValueCallbackMetadata No { mode: 'realtime' }
  • Configuration controlling the behavior of the function

Observable - Stream of measurement string values

widgets/implementations/three-d-rotation/lazy-box-model/lazy-load-box-model.ts

loadBoxModel
loadBoxModel()

lazy/three-orbit-controls/index.ts

loadOrbitControls
loadOrbitControls()

Dynamically imports the OrbitControls of three js.

Returns : Promise<>

A Promise of OrbitControls (three js).

widgets/implementations/three-d-rotation/lazy-phone-model/lazy-load-phone-model.ts

loadPhoneModel
loadPhoneModel()

lazy/three/index.ts

loadThree
loadThree()

Dynamically imports three js.

Returns : Promise<>

A Promise of three js.

widgets/implementations/datapoints-table/datapoints-table-view/datapoints-table-view.service.ts

mapToSourceValueObject
mapToSourceValueObject(undefined)
Parameters :
Name Optional
No
Returns : literal type

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.

widgets/implementations/datapoints-table/datapoints-table-config/datapoints-table-config.component.ts

minOneDatapointActive
minOneDatapointActive()
Returns : ValidatorFn

api/data.module.ts

provideClientLibServices
provideClientLibServices()

Provides all services from @c8y/client library.

Returns : Provider[]

An array of providers for all services from @c8y/client library.

toProvider
toProvider(provide: Type)
Parameters :
Name Type Optional
provide Type No
Returns : Provider

core/common/common.module.ts

provideCommonPipes
provideCommonPipes()

Provides commonly used pipes. To be injected via dependency injection.

provideCommonServices
provideCommonServices()

Provides commonly used services and app initializers.

Returns : []

An array of commonly used services and app initializers.

provideDefaultOptionsAppInitializer
provideDefaultOptionsAppInitializer()

Loads the default application options during the app initialization.

e.g. loads supportUrl, activateSupportUserAvailable, backend version

provideLanguageSelectorAppInitializer
provideLanguageSelectorAppInitializer()

Sets the application language during the app initialization.

providePluginsLoaderServiceAppInitializer
providePluginsLoaderServiceAppInitializer()

Loads all configured plugins on application startup.

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>

upgrade/upgraded-services/roles.service.ts

RolesServiceFactory
RolesServiceFactory(injector)
Parameters :
Name Optional
injector No

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

rootScopeCommandTemplateFactory
rootScopeCommandTemplateFactory($injector: Injector)
Parameters :
Name Type Optional
$injector Injector No

device-protocols/device-type-detail.component.ts

rootScopeTypeDetailFactory
rootScopeTypeDetailFactory($injector: Injector)
Parameters :
Name Type Optional
$injector Injector No

core/forms/simple-json-path-validator.directive.ts

simpleJsonPathValidator
simpleJsonPathValidator(control: AbstractControl)
Parameters :
Name Type Optional
control AbstractControl No

upgrade/upgraded-services/smart-rules.service.ts

SmartRulesServiceFactory
SmartRulesServiceFactory(injector: any)
Parameters :
Name Type Optional
injector any No

alarms/ng1-smart-rules-upgrade.service.ts

SmartRulesUpgradeServiceFactory
SmartRulesUpgradeServiceFactory(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

upgrade/upgraded-services/tenant-policies.service.ts

TenantPoliciesFactory
TenantPoliciesFactory(injector: any)
Parameters :
Name Type Optional
injector any No

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

core/forms/unique-in-collection-by-path-validation.directive.ts

uniqueInCollectionByPathValidator
uniqueInCollectionByPathValidator(collection: Iterable, path: string, comparator?)
Parameters :
Name Type Optional
collection Iterable No
path string No
comparator Yes
Returns : ValidatorFn

upgrade/upgraded-services/user-inventory-roles.service.ts

UserInventoryRolesFactory
UserInventoryRolesFactory(injector)
Parameters :
Name Optional
injector No

core/forms/phone-validation.directive.ts

validateInternationalPhoneNumber
validateInternationalPhoneNumber()
Returns : ValidatorFn

results matching ""

    No results matching ""