| _virtualScrollWindowStrategyFactory | ||||||||
_virtualScrollWindowStrategyFactory(windowDir: VirtualScrollWindowDirective)
|
||||||||
|
Provider factory for
Parameters :
|
| absoluteDateServiceFactory | ||||||
absoluteDateServiceFactory(datePipe: DatePipe)
|
||||||
|
Parameters :
|
| addonsExtension | ||||||
addonsExtension(field: FormlyFieldConfig)
|
||||||
|
Parameters :
|
| addPolyfills |
addPolyfills()
|
| alarmCount3MonthsValue | ||||||||||||
alarmCount3MonthsValue(config: AlarmCountConfig, asset: IManagedObject, metadata: ValueCallbackMetadata)
|
||||||||||||
|
Parameters :
Returns :
Observable<number>
|
| alarmCountTodayValue | ||||||||||||
alarmCountTodayValue(config: AlarmCountConfig, asset: IManagedObject, metadata: ValueCallbackMetadata)
|
||||||||||||
|
Parameters :
Returns :
Observable<number>
|
| 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 :
Returns :
Observable<number>
Observable |
| alarmsCockpitRouteAndNodeConfig |
alarmsCockpitRouteAndNodeConfig()
|
|
Returns :
ModuleWithProviders<AlarmsModule>
|
| alarmsDeviceManagementRouteAndNodeConfig |
alarmsDeviceManagementRouteAndNodeConfig()
|
|
Returns :
ModuleWithProviders<AlarmsModule>
|
| allEntriesAreEqual | |||||||||
allEntriesAreEqual(previous: Array, next: Array)
|
|||||||||
|
Parameters :
Returns :
boolean
|
| fromFactories | ||||||||||||||||
fromFactories(factories?: Array, router?: Router, withFirstEmpty)
|
||||||||||||||||
|
Parameters :
Returns :
Observable<T[]>
|
| fromTrigger | ||||||||||||
fromTrigger(router: Router, refresh, factories: Array)
|
||||||||||||
|
Parameters :
Returns :
Observable<T[]>
|
| fromTriggerOnce | ||||||||||||||||||||
fromTriggerOnce(router: Router, refresh, factories: Array, withFirstEmpty)
|
||||||||||||||||||||
|
Parameters :
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 :
Returns :
ActivatedRoute
|
| getInjectedHooks | ||||||||||||||||
getInjectedHooks(token: InjectionToken, injectors, type)
|
||||||||||||||||
|
Parameters :
Returns :
T[]
|
| hookGeneric | ||||||||||||||||
hookGeneric(items, token: InjectionToken, options?: Partial)
|
||||||||||||||||
|
A generic function to be used by specific implementations of the HOOK concept.
Parameters :
A |
| isExtensionFactory | ||||||
isExtensionFactory(obj: any)
|
||||||
|
Parameters :
Returns :
ExtensionFactory<T>
|
| isPromise | ||||||
isPromise(obj: any)
|
||||||
|
Parameters :
Returns :
Promise<T>
|
| removeDuplicatesIds | ||||
removeDuplicatesIds(items)
|
||||
|
Parameters :
Returns :
T[]
|
| resolveInjectedFactories | ||||||
resolveInjectedFactories(factories: Array)
|
||||||
|
Parameters :
Returns :
Array<T | [] | ExtensionFactory>
|
| sortByPriority | ||||
sortByPriority(items)
|
||||
|
Parameters :
Returns :
T[]
|
| stateToFactory | ||||
stateToFactory(componentsState)
|
||||
|
Parameters :
Returns :
ExtensionFactory<T>
|
| 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 :
Returns :
Observable<T>
|
| toObservableOfArrays | |||||||||
toObservableOfArrays(factoryResult, withFirstEmpty: boolean)
|
|||||||||
|
Parameters :
Returns :
Observable<T[]>
|
| appendErrors | |||||||||
appendErrors(errors: ValidationErrors, newErrors)
|
|||||||||
|
Parameters :
Returns :
ValidationErrors
|
| applyAggregationChangesForGlobalState | ||||||
applyAggregationChangesForGlobalState(params: ApplyAggregationForGlobalStateParams)
|
||||||
|
Parameters :
Returns :
boolean
|
| evaluateAggregationValidation | ||||||
evaluateAggregationValidation(deps: AggregationValidationDeps)
|
||||||
|
Parameters :
Returns :
AggregationValidationOutcome | null
|
| resolveAggregationChangeForForm | ||||||
resolveAggregationChangeForForm(params: ResolveAggregationChangeForFormParams)
|
||||||
|
Parameters :
Returns :
AggregationChangeInstruction | null
|
| resolveAutoUnlinkAggregationChange | ||||||
resolveAutoUnlinkAggregationChange(params: ResolveAutoUnlinkParams)
|
||||||
|
Parameters :
Returns :
AggregationChangeInstruction | null
|
| applyConfigOverride | |||||||||
applyConfigOverride(ctx: LinkHelpersContext, config: Partial)
|
|||||||||
|
Parameters :
Returns :
void
|
| applyGlobalValueToForm | |||||||||
applyGlobalValueToForm(ctx: LinkHelpersContext, key)
|
|||||||||
|
Parameters :
Returns :
void
|
| applyHandlerResult | |||||||||
applyHandlerResult(ctx: LinkHelpersContext, result: WidgetStateHandlerResult)
|
|||||||||
|
Parameters :
Returns :
boolean
|
| applyLocalStateToForm | |||||||||
applyLocalStateToForm(ctx: LinkHelpersContext, keys: Array)
|
|||||||||
|
Parameters :
Returns :
void
|
| buildControlLinkConfig | ||||||||||||
buildControlLinkConfig(ctx: LinkHelpersContext, settings: Partial, linkStates)
|
||||||||||||
|
Parameters :
Returns :
literal type
|
| buildWidgetState | |||||||||
buildWidgetState(ctx: LinkHelpersContext, configOverride?)
|
|||||||||
|
Parameters :
Returns :
WidgetState
|
| handleLinkToggle | ||||||||||||
handleLinkToggle(ctx: LinkHelpersContext, event: LinkToggleEvent, options?)
|
||||||||||||
|
Parameters :
Returns :
boolean
|
| processLinkUpdates | ||||||||||||
processLinkUpdates(ctx: LinkHelpersContext, links: Partial, options?)
|
||||||||||||
|
Parameters :
Returns :
boolean
|
| processOptions | |||||||||
processOptions(ctx: LinkHelpersContext, options: Record)
|
|||||||||
|
Parameters :
Returns :
void
|
| resetHandlerOverrides | ||||||
resetHandlerOverrides(ctx: LinkHelpersContext)
|
||||||
|
Parameters :
Returns :
void
|
| syncWithEffectiveConfig | |||||||||
syncWithEffectiveConfig(ctx: LinkHelpersContext, keys: Array)
|
|||||||||
|
Parameters :
Returns :
void
|
| toggleAllLinks | |||||||||
toggleAllLinks(ctx: LinkHelpersContext, args)
|
|||||||||
|
Parameters :
Returns :
void
|
| updateFormAndLocalState | ||||||||||||
updateFormAndLocalState(ctx: LinkHelpersContext, field: T, value)
|
||||||||||||
|
Parameters :
Returns :
void
|
| updateFormField | ||||||||||||
updateFormField(ctx: LinkHelpersContext, key, value)
|
||||||||||||
|
Parameters :
Returns :
void
|
| applyLocalAggregationChange | |||||||||
applyLocalAggregationChange(ctx: RefreshHelpersContext, change: AggregationChangeInstruction)
|
|||||||||
|
Parameters :
Returns :
void
|
| applyRefreshOutcome | |||||||||
applyRefreshOutcome(ctx: RefreshHelpersContext, outcome: RefreshResult)
|
|||||||||
|
Parameters :
Returns :
void
|
| calculateDisabledAggregationsFromContext | |||||||||
calculateDisabledAggregationsFromContext(ctx: RefreshHelpersContext, dateTimeContext: DateTimeContext)
|
|||||||||
|
Parameters :
Returns :
Partial<Record<aggregationType, boolean>>
|
| calculateFromDateRange | |||||||||
calculateFromDateRange(ctx: RefreshHelpersContext, dateTimeContext: DateTimeContext)
|
|||||||||
|
Parameters :
Returns :
Partial<Record<aggregationType, boolean>>
|
| calculateFromInterval | |||||||||
calculateFromInterval(ctx: RefreshHelpersContext, interval)
|
|||||||||
|
Parameters :
Returns :
Partial<Record<aggregationType, boolean>>
|
| createDateRange | ||||||
createDateRange(dateTimeContext: DateTimeContext)
|
||||||
|
Parameters :
|
| deriveDisabledAggregations | ||||||
deriveDisabledAggregations(ctx: RefreshHelpersContext)
|
||||||
|
Parameters :
Returns :
Partial<Record<aggregationType, boolean>>
|
| generateFreshDateTimeContext | ||||||
generateFreshDateTimeContext(interval: TimeInterval)
|
||||||
|
Parameters :
Returns :
DateTimeContext
|
| getShouldDisableIntervalConfig | ||||||
getShouldDisableIntervalConfig(ctx: RefreshHelpersContext)
|
||||||
|
Parameters :
Returns :
Record<string, boolean>
|
| handleGlobalRefresh | |||||||||
handleGlobalRefresh(ctx: RefreshHelpersContext, globalDateTimeContext: DateTimeContext)
|
|||||||||
|
Parameters :
Returns :
void
|
| hasValidDateRange | ||||
hasValidDateRange(dateTimeContext)
|
||||
|
Parameters :
Returns :
boolean
|
| hasValidInterval | ||||||
hasValidInterval(dateTimeContext: DateTimeContext)
|
||||||
|
Parameters :
Returns :
boolean
|
| patchFormValues | |||||||||
patchFormValues(ctx: RefreshHelpersContext, formUpdates: Partial)
|
|||||||||
|
Parameters :
Returns :
void
|
| processRefreshEvent | |||||||||
processRefreshEvent(ctx: RefreshHelpersContext, params)
|
|||||||||
|
Parameters :
Returns :
RefreshResult
|
| recalculateAggregationForGlobalDateTime | ||||||
recalculateAggregationForGlobalDateTime(ctx: RefreshHelpersContext)
|
||||||
|
Parameters :
Returns :
void
|
| recalculateAggregationForLocalDateTime | ||||||
recalculateAggregationForLocalDateTime(ctx: RefreshHelpersContext)
|
||||||
|
Parameters :
Returns :
void
|
| updateAggregationValue | |||||||||
updateAggregationValue(ctx: RefreshHelpersContext, aggregation)
|
|||||||||
|
Parameters :
Returns :
void
|
| updateFormDateTimeContext | |||||||||
updateFormDateTimeContext(ctx: RefreshHelpersContext, newContext: DateTimeContext)
|
|||||||||
|
Parameters :
Returns :
void
|
| updateLocalDateTimeContext | |||||||||
updateLocalDateTimeContext(ctx: RefreshHelpersContext, newContext: DateTimeContext)
|
|||||||||
|
Parameters :
Returns :
void
|
| 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 :
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:
Parameters :
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 :
|
| assertUnreachable | ||||||
assertUnreachable(_: never)
|
||||||
|
Parameters :
Returns :
never
|
| assignClonedValue | ||||||||||||
assignClonedValue(target: Partial, key: K, value)
|
||||||||||||
|
Parameters :
Returns :
void
|
| executeHandler | |||||||||
executeHandler(context: ExecuteHandlerContext, deps: ExecuteHandlerDependencies)
|
|||||||||
|
Parameters :
Returns :
void
|
| handleFormChange | |||||||||
handleFormChange(context: HandleFormChangeContext, deps: FormChangeDependencies)
|
|||||||||
|
Parameters :
Returns :
void
|
| handleGlobalStateChange | |||||||||
handleGlobalStateChange(context: HandleGlobalStateChangeContext, deps: GlobalStateChangeDependencies)
|
|||||||||
|
Parameters :
Returns :
void
|
| 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 :
Returns :
AsyncValidatorFn
|
| generateArrayRelatedErrors | ||||||
generateArrayRelatedErrors(errors: Array)
|
||||||
|
Parameters :
Returns :
ArrayValidationErrors
|
| 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 :
Returns :
ValidatorFn
|
| authBridgeServiceFactory | ||||||||||||||||||
authBridgeServiceFactory(injector: any, basicAuth: BasicAuth, fetchClient: FetchClient, appState: AppStateService, tenantUiService: TenantUiService)
|
||||||||||||||||||
|
Parameters :
|
| bridgeServiceFactory | |||||||||||||||||||||
bridgeServiceFactory(injector: any, appState: AppStateService, router: Router, ngZone: NgZone, routerService: RouterService, actionService: ActionService)
|
|||||||||||||||||||||
|
Parameters :
|
| buildAggregationExtensions |
buildAggregationExtensions()
|
|
Adds aggregation visibility and default link behaviour on top of the baseline template.
Returns :
PartialWidgetControls
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.
Returns :
PartialWidgetControls
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 :
|
| enableAutoRefreshHandler | ||||||
enableAutoRefreshHandler(state: WidgetState)
|
||||||
|
Parameters :
|
| 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 :
Returns :
PartialWidgetControls
Combined partial controls. |
| buildFreshContext | |||||||||
buildFreshContext(context: RefreshContext, interval: TimeInterval)
|
|||||||||
|
Parameters :
Returns :
DateTimeContext
|
| calculateRefreshOutcome | |||||||||
calculateRefreshOutcome(context: RefreshContext, deps: RefreshDependencies)
|
|||||||||
|
Parameters :
Returns :
RefreshResult
|
| handleLocalAutoRefresh | |||||||||
handleLocalAutoRefresh(context: RefreshContext, deps: RefreshDependencies)
|
|||||||||
|
Parameters :
Returns :
RefreshResult
|
| resolveRefreshInterval | |||||||||
resolveRefreshInterval(fieldSources: FieldSourcesMap, configInterval)
|
|||||||||
|
Parameters :
Returns :
TimeInterval
|
| buildWidgetControlsFromPresets | ||||||||
buildWidgetControlsFromPresets(config: WidgetControlsPresetConfig)
|
||||||||
|
Creates a fully hydrated WidgetControls by expanding the selected presets (and optional customiser) against the default template.
Parameters :
Returns :
WidgetControls
Fully merged widget controls ready for consumption. |
| dedupe | ||||||
dedupe(values)
|
||||||
|
Removes duplicate preset names while preserving the first occurrence.
Parameters :
Returns :
WidgetPresetName[]
Deduplicated preset array. |
| isPresetConfig | ||||
isPresetConfig(input)
|
||||
|
Parameters :
Returns :
WidgetControlsPresetConfig
|
| 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 :
Returns :
WidgetControls
Combined widget controls instance. |
| normalizePresetSelection | ||||||||
normalizePresetSelection(selection: WidgetPresetSelection)
|
||||||||
|
Normalises caller input to a deduplicated, ordered preset array.
Parameters :
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 :
Returns :
WidgetControlsPresetDefinition
Preset definition from the registry. |
| resolveWidgetControlsInput | ||||
resolveWidgetControlsInput(input)
|
||||
|
Parameters :
Returns :
WidgetControls
|
| warnForExclusiveConflicts | ||||||
warnForExclusiveConflicts(definitions)
|
||||||
|
Emits a console warning whenever multiple presets from the same
Parameters :
Returns :
void
|
| c8yAlertDecorator | ||||||||
c8yAlertDecorator($delegate, $rootScope, $injector)
|
||||||||
|
Parameters :
|
| c8yNavigatorProvider |
c8yNavigatorProvider()
|
| c8yNg1HttpInterceptor | ||||||||
c8yNg1HttpInterceptor($q, c8yLoadingIndicator, c8yApiService)
|
||||||||
|
Parameters :
|
| c8yTitleDecorator | ||||||||||||||||||
c8yTitleDecorator($q, $delegate, $injector, $rootScope, $location, $templateCache, $compile, c8yHeaderService)
|
||||||||||||||||||
|
Parameters :
|
| c8yUiRootController | ||||||||||||||
c8yUiRootController($rootScope, $timeout, c8yBase, c8yNavigator, c8yApplication, c8yHeaderService)
|
||||||||||||||
|
Parameters :
|
| c8yValidationConfigFactory | ||||||
c8yValidationConfigFactory(translate: TranslateService)
|
||||||
|
Parameters :
|
| c8yViewsProvider | ||||||||
c8yViewsProvider($routeProvider, c8yTabsProvider, c8yPathUtils)
|
||||||||
|
Parameters :
|
| canActivateDashboardManager |
canActivateDashboardManager()
|
|
Returns :
Observable<boolean>
|
| canActivateDatapointExplorer |
canActivateDatapointExplorer()
|
|
Returns :
Observable<boolean>
|
| 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 :
Returns :
Observable<number>
Observable |
| 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 :
Returns :
Observable<number>
Observable |
| 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 :
Returns :
Observable<number>
Observable |
| colorValidator | ||||
colorValidator(allowedModes?)
|
||||
|
Parameters :
Returns :
AsyncValidatorFn
|
| composeEffectiveConfig | ||||||
composeEffectiveConfig(context: EffectiveConfigContext)
|
||||||
|
Parameters :
Returns :
GlobalContextState
|
| resolveConfigurationValue | ||||||||||||||||||
resolveConfigurationValue(key: K, sources: FieldSourcesMap, localStateValues: Partial, globalStateValues: Partial, baseConfiguration: Partial)
|
||||||||||||||||||
|
Parameters :
Returns :
| undefined
|
| safeCloneValue | ||||||
safeCloneValue(value: T)
|
||||||
|
Parameters :
Returns :
T
|
| computeLinkToggle | ||||||
computeLinkToggle(args: LinkToggleArgs)
|
||||||
|
Parameters :
Returns :
LinkToggleOutcome
|
| computeToggleAll | ||||||
computeToggleAll(args: ToggleAllArgs)
|
||||||
|
Parameters :
Returns :
LinkToggleOutcome
|
| configurationSnapshotValue | |||||||||
configurationSnapshotValue(config: ConfigurationSnapshotConfig, asset: IManagedObject)
|
|||||||||
|
Parameters :
Returns :
Observable<string>
|
| configureWidgetProviders | ||||||||||
configureWidgetProviders(config: WidgetProvidersConfig)
|
||||||||||
|
Configures and returns widget providers. This function allows selective loading of widget providers with their configuration hooks.
Unlike
Parameters :
Returns :
Provider[]
Array of providers to be included in app.module.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 :
Returns :
WidgetControls
Combined control definition. |
| resolveAlarmControls | ||||||||
resolveAlarmControls(widgetId?: string)
|
||||||||
|
Resolves the appropriate controls preset based on the widget identifier.
Parameters :
Returns :
WidgetControls
Fully materialised controls for the widget. |
| createBrandingForm | ||||||
createBrandingForm(formBuilder: FormBuilder)
|
||||||
|
Parameters :
|
| createGenericBrandingForm | ||||||
createGenericBrandingForm(formBuilder: FormBuilder)
|
||||||
|
Parameters :
|
| 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 :
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 :
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 :
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 :
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 :
Returns :
string | Date
true if the value represents a valid date |
| createExportedAsset | ||||||||||||
createExportedAsset(device: IManagedObject, identityService: IdentityService, inventoryService: InventoryService)
|
||||||||||||
|
Creates a device with external identity information
Parameters :
Returns :
Promise<ExportedAsset>
|
| exportConfigWithDevice | ||||||||||||
exportConfigWithDevice(config: T, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
|
||||||||||||
|
Exports a configuration with asset information enriched for export
Parameters :
Returns :
Promise<ExportedConfigWithAsset<T>>
|
| hasAssetProperty | ||||||
hasAssetProperty(config: any)
|
||||||
|
Check if a configuration has a valid device property
Parameters :
Returns :
ConfigWithAsset
|
| importConfigWithDevice | ||||||||||||
importConfigWithDevice(config: ExportedConfigWithAsset, dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
|
||||||||||||
|
Imports a configuration with asset information adapted to the current context
Parameters :
Returns :
Promise<ImportedConfigWithAsset<T>>
|
| createExportedTargetObject | ||||||||||||
createExportedTargetObject(targetObject: T, identityService: IdentityService, inventoryService: InventoryService)
|
||||||||||||
|
Transforms a single target object for export
Parameters :
Returns :
Promise<ExportedTargetObject<T>>
|
| createImportedTargetObject | |||||||||
createImportedTargetObject(exportedTargetObject: ExportedTargetObject, context: IManagedObject)
|
|||||||||
|
Transforms a single exported target object for import
Parameters :
Returns :
Promise<ImportedTargetObject<T>>
|
| processExportedTargetArray | ||||||||||||
processExportedTargetArray(targetObjects, context: IManagedObject)
|
||||||||||||
|
Transforms an array of exported target objects for import
Parameters :
Returns :
Promise<ImportedTargetObject[]>
|
| processTargetArrayToExport | ||||||||||||||||
processTargetArrayToExport(targetObjects, identityService: IdentityService, inventoryService: InventoryService)
|
||||||||||||||||
|
Transforms an array of target objects for export
Parameters :
Returns :
Promise<ExportedTargetObject[]>
|
| createResult | |||||||||||||||||||||||||
createResult(inlineSettings: Partial, dashboardSettings: Partial, links: Partial, options?: Record)
|
|||||||||||||||||||||||||
|
Creates a standardized result object for widget state handler responses.
Parameters :
Returns :
WidgetStateHandlerResult
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 :
Returns :
WidgetStateHandlerResult
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 :
Returns :
Partial<LinkStatesMap>
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 :
Returns :
Pick<WidgetStateHandlerResult, "inlineControlSettings" | "dashboardControlSettings">
Updated inline and dashboard control settings |
| deriveAggregationValue | ||||||
deriveAggregationValue(config: GlobalContextState)
|
||||||
|
Parameters :
Returns :
aggregationType | null
|
| validateAggregationLink | ||||||
validateAggregationLink(context: AggregationValidationContext)
|
||||||
|
Parameters :
Returns :
AggregationValidationResult
|
| encodeFiles | |||||||||
encodeFiles(model: ProviderProperties, fields)
|
|||||||||
|
Parameters :
Returns :
Promise<ProviderProperties>
|
| ensureAtLeastOneDatapointSelectedAndActive | ||||
ensureAtLeastOneDatapointSelectedAndActive(datapointListAttributes)
|
||||
|
Parameters :
Returns :
ValidatorFn
|
| ensureDateTimeContext | |||||||||
ensureDateTimeContext(context, configSignal: WritableSignal)
|
|||||||||
|
Parameters :
Returns :
DateTimeContext
|
| mapToContextDisplayMode | ||||||
mapToContextDisplayMode(displayMode: WidgetDisplayMode)
|
||||||
|
Parameters :
Returns :
GlobalContextDisplayMode
|
| resolveVisibilityContextInternal | |||||||||||||||||||||
resolveVisibilityContextInternal(config: GlobalContextState, widgetControlsSignal: WritableSignal, fieldSourcesSignal: WritableSignal, globalStateSignal: WritableSignal, widgetControlService: WidgetControlService, getDefaultRefreshOption)
|
|||||||||||||||||||||
|
Parameters :
Returns :
VisibilityContext | null
|
| resolveWidgetDisplayMode | |||||||||
resolveWidgetDisplayMode(initialConfig, globalState: Partial)
|
|||||||||
|
Parameters :
Returns :
WidgetDisplayMode
|
| sanitizeGlobalState | ||||||||||||||||||
sanitizeGlobalState(state, configSignal: WritableSignal, normalizeRefreshOption, getDefaultRefreshOption, ensureDateTimeContext)
|
||||||||||||||||||
|
Parameters :
Returns :
Partial<GlobalContextState>
|
| sanitizeLocalState | ||||||||||||
sanitizeLocalState(state, configSignal: WritableSignal, ensureDateTimeContext)
|
||||||||||||
|
Parameters :
Returns :
Partial<GlobalContextState>
|
| syncLocalEntriesWithGlobal | ||||||||||||
syncLocalEntriesWithGlobal(fieldSourcesSignal: WritableSignal, globalStateSignal: WritableSignal, localStateSignal: WritableSignal)
|
||||||||||||
|
Parameters :
Returns :
void
|
| syncSourcesForRefreshOption | |||||||||||||||||||||
syncSourcesForRefreshOption(displayMode: WidgetDisplayMode, refreshOption: RefreshOption, controls, fieldSourcesSignal: WritableSignal, getDefaultRefreshOption, setFieldSources)
|
|||||||||||||||||||||
|
Parameters :
Returns :
void
|
| escapeRegExpPattern | ||||||||
escapeRegExpPattern(pattern: string)
|
||||||||
|
Parameters :
|
| eventCount3MonthsValue | ||||||||||||
eventCount3MonthsValue(config: EventCountConfig, asset: IManagedObject, metadata: ValueCallbackMetadata)
|
||||||||||||
|
Parameters :
Returns :
Observable<number>
|
| eventCountTodayValue | ||||||||||||
eventCountTodayValue(config: EventCountConfig, asset: IManagedObject, metadata: ValueCallbackMetadata)
|
||||||||||||
|
Parameters :
Returns :
Observable<number>
|
| 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 :
Returns :
Observable<number>
Observable |
| exactlyASingleDatapointActive |
exactlyASingleDatapointActive()
|
|
Returns :
ValidatorFn
|
| exactlyASingleDatapointActive |
exactlyASingleDatapointActive()
|
|
Returns :
ValidatorFn
|
| exportConfigWithTargets | ||||||||||||
exportConfigWithTargets(config: T, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
|
||||||||||||
|
Exports widget configuration with all target objects transformed for export
Parameters :
Returns :
Promise<ExportedConfigWithTargets<T>>
|
| exportImageWidgetConfig | ||||||||||||
exportImageWidgetConfig(config: ImageWidgetConfig, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
|
||||||||||||
|
Parameters :
Returns :
Promise<ExportedImageWidgetConfig>
|
| importImageWidgetConfig | ||||||||||||
importImageWidgetConfig(config: ExportedImageWidgetConfig, dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
|
||||||||||||
|
Parameters :
Returns :
Promise<ImageWidgetConfig>
|
| exportMarkdownWidgetConfig | ||||||||||||
exportMarkdownWidgetConfig(config: MarkdownWidgetConfig, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
|
||||||||||||
|
Parameters :
Returns :
Promise<ExportedMarkdownWidgetConfig>
|
| importMarkdownWidgetConfig | ||||||||||||
importMarkdownWidgetConfig(config: ExportedMarkdownWidgetConfig, _dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
|
||||||||||||
|
Parameters :
Returns :
Promise<MarkdownWidgetConfig>
|
| findTargetArrayProperties | ||||||
findTargetArrayProperties(config: ConfigWithTargets)
|
||||||
|
Find all property names in an object that contain arrays of objects with __target property
Parameters :
Returns :
string[]
|
| isTargetObjectArray | ||||||
isTargetObjectArray(value: any)
|
||||||
|
Helper function to check if a value is an array of objects with __target property
Parameters :
Returns :
TargetObjectArray
|
| getAngularLocalesLanguageString | ||||||||
getAngularLocalesLanguageString(language: string)
|
||||||||
|
Parameters :
Returns :
string
|
| languagesFactory | ||||||
languagesFactory(options: OptionsService)
|
||||||
|
Parameters :
|
| localeId | ||||||
localeId(appStateService: AppStateService)
|
||||||
|
Parameters :
|
| localePathFactory | ||||||
localePathFactory(options: OptionsService)
|
||||||
|
Parameters :
|
| provideI18n |
provideI18n()
|
|
Returns :
Provider[]
|
| provideTranslationServiceInstance | ||||||||
provideTranslationServiceInstance(options: RootTranslateServiceConfig)
|
||||||||
|
Parameters :
|
| getBasicInputArrayFormFieldConfig | ||||||
getBasicInputArrayFormFieldConfig(config: BasicInputArrayFormConfigInterface)
|
||||||
|
Generates simple array formFieldConfig
Parameters :
Returns :
FormlyFieldConfig[]
FormlyFieldConfig[] |
| getC8yMarker | ||||||||||||||||
getC8yMarker(marker, asset?: PositionManagedObject, event?: IEvent)
|
||||||||||||||||
|
Utility function to assign asset and event information to a Leaflet marker.
Parameters :
|
| getChildrenForViewContext | ||||||
getChildrenForViewContext(context: ViewContext)
|
||||||
|
Parameters :
Returns :
Routes
|
| getViewContextRoutes | ||||
getViewContextRoutes(contexts)
|
||||
|
Parameters :
Returns :
Routes
|
| 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 :
|
| 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 :
|
| getExternalIdentityByTargetId | |||||||||
getExternalIdentityByTargetId(targetId, identityService: IdentityService)
|
|||||||||
|
Parameters :
Returns :
Promise<IExternalIdentity>
|
| resolveSuggestedAsset | |||||||||
resolveSuggestedAsset(exportedDevice: ExportedAsset, contextDevice: IManagedObject)
|
|||||||||
|
Parameters :
Returns :
Promise<IManagedObject | null>
|
| targetDetails | |||||||||
targetDetails(targetId, inventoryService: InventoryService)
|
|||||||||
|
Parameters :
Returns :
Promise<IManagedObject>
|
| 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 :
Returns :
Observable<string>
Observable |
| getRemoteTestingModule | ||||||
getRemoteTestingModule(providers, providersSubModule?)
|
||||||
|
Parameters :
Returns :
Type<any>
|
| gettext | ||||||
gettext(str: T)
|
||||||
|
Identity function used for marking strings for translation
Parameters :
Returns :
T
|
| gettext | ||||||
| Use `import { gettext } from '@c8y/ngx-components/gettext';` instead. | ||||||
gettext(str: T)
|
||||||
|
Parameters :
Returns :
T
|
| gettextCatalogDecorator | ||||||||
gettextCatalogDecorator($delegate, $interpolate, c8yTranslate)
|
||||||||
|
Parameters :
|
| globalAutoRefreshLoading | ||||||
globalAutoRefreshLoading(globalRefreshService: WidgetGlobalAutoRefreshService)
|
||||||
|
Parameters :
Returns :
MonoTypeOperatorFunction<boolean>
|
| groupTypesHierarchyNavigatorDecorator | ||||||
groupTypesHierarchyNavigatorDecorator($delegate, $q)
|
||||||
|
Parameters :
|
| hookAction | ||||||||||||
hookAction(actions: GenericHookType, options?: Partial)
|
||||||||||||
|
A hook to add an action using the multi-provider extension concept. You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookActionBar | ||||||||||||
hookActionBar(items: GenericHookType, options?: Partial)
|
||||||||||||
|
A hook to add ActionBarItems using the multi provider extension concept. You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookBreadcrumb | ||||||||||||
hookBreadcrumb(breadcrumb: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookComponent | ||||||||||||
hookComponent(components: GenericHookType, options?: Partial)
|
||||||||||||
|
A hook to add dynamic components to the UI (e.g. widgets). You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookWidget | ||||||||||||
hookWidget(components: GenericHookType, options?: Partial)
|
||||||||||||
|
Hook to add dynamic widget components to the UI. You can either provide a single Or an array to directly register multiple: Example :
A widget specific alternative to
Parameters :
|
| isEagerDynamicComponents | ||||||
isEagerDynamicComponents(componentDefinition: DynamicComponents)
|
||||||
|
Parameters :
Returns :
EagerDynamicComponents
|
| isLazyDynamicComponents | ||||||
isLazyDynamicComponents(componentDefinition: DynamicComponents)
|
||||||
|
Parameters :
Returns :
LazyDynamicComponents
|
| hookComputedProperty | |||||||||
hookComputedProperty(property: GenericHookType, options?: Partial)
|
|||||||||
|
Parameters :
|
| hookCurrentApplication | ||||||
hookCurrentApplication(application: IApplication)
|
||||||
|
Parameters :
|
| hookCurrentTenant | ||||||
hookCurrentTenant(tenant: ICurrentTenant)
|
||||||
|
Parameters :
|
| hookCurrentUser | ||||
hookCurrentUser(user)
|
||||
|
Parameters :
|
| provideBootstrapMetadata | ||||||
provideBootstrapMetadata(metadata: BootstrapMetaData)
|
||||||
|
Parameters :
Returns :
StaticProvider[]
|
| hookDataGridActionControls | |||||||||
hookDataGridActionControls(action: GenericHookType, options?: Partial)
|
|||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide a service that implements
Parameters :
|
| hookDeviceListColumns | |||||||||
hookDeviceListColumns(columns: GenericHookType, options?: Partial)
|
|||||||||
|
A hook to override the default device grid columns configuration in
Parameters :
|
| hookDeviceRegistration | ||||||||||||
hookDeviceRegistration(registration: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookDocs | ||||||||
hookDocs(doc: GenericHookType)
|
||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements
Parameters :
|
| hookDrawer | ||||||||||||
hookDrawer(drawer: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide a Service that implements A typed alternative to
Parameters :
|
| hookDynamicProviderConfig | ||||||||||||
hookDynamicProviderConfig(config: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookFilterMapper | ||||||||||||
hookFilterMapper(mapper: HookValueType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to using
Parameters :
|
| hookListBulkType | ||||||||||||
hookListBulkType(type: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookNavigator | ||||||||||||
hookNavigator(nodes: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookOptions | ||||||||||||
hookOptions(options: GenericHookType, hookOptions?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookPatternMessages | ||||||||||||
hookPatternMessages(patterns: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookPlugin | ||||||
| Only meant for internal usage. | ||||||
hookPlugin(plugins: GenericHookType)
|
||||||
|
Parameters :
|
| hookPreview | |||||||||
hookPreview(preview: GenericHookType, options?: Partial)
|
|||||||||
|
Parameters :
|
| hookQueryParam | |||||||||
hookQueryParam(config: GenericHookType, options?: Partial)
|
|||||||||
|
Parameters :
|
| hookQueryParamBottomDrawer | |||||||||
hookQueryParamBottomDrawer(config: GenericHookType, options?: Partial)
|
|||||||||
|
Parameters :
|
| hookQueryParamModal | |||||||||
hookQueryParamModal(config: GenericHookType, options?: Partial)
|
|||||||||
|
Parameters :
|
| hookRoute | ||||||||||||
hookRoute(route: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookSearch | ||||||||||||
| Please don't use the search factory. It will be refactored soon. | ||||||||||||
hookSearch(search: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| 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 :
|
| 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 Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookStepper | ||||||||||||
hookStepper(step: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookTab | ||||||||||||
hookTab(tabs: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookUserMenu | ||||||||||||
hookUserMenu(userMenu: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide a Service that implements
Parameters :
|
| hookVersion | ||||||||||||
hookVersion(versions: GenericHookType, options?: Partial)
|
||||||||||||
|
You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookWidgetConfig | ||||||||||||
hookWidgetConfig(components: GenericHookType, options?: Partial)
|
||||||||||||
|
A hook to add dynamic components to the UI (e.g. widgets). You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| hookWizard | ||||||||||||
hookWizard(wizard: GenericHookType, options?: Partial)
|
||||||||||||
|
A hook to add wizard entries. You can either provide a single Or an array to directly register multiple: Example :Or you provide an Service that implements A typed alternative to
Parameters :
|
| importConfigWithTargets | ||||||||||||
importConfigWithTargets(config: ExportedConfigWithTargets, dashboardData: DashboardMetadata, _options: WidgetImportExportInjectorOptions)
|
||||||||||||
|
Imports widget configuration with all target objects transformed for the current context
Parameters :
Returns :
Promise<ImportedConfigWithTargets<T>>
|
| initializeMonacoEnvironment |
initializeMonacoEnvironment()
|
| loadMonacoEditor |
loadMonacoEditor()
|
| isActilityConnection | ||||
isActilityConnection(connection)
|
||||
|
Parameters :
Returns :
ActilityConnection
|
| isLoriotConnection | ||||
isLoriotConnection(connection)
|
||||
|
Parameters :
Returns :
LoriotConnection
|
| isSigfoxConnection | ||||
isSigfoxConnection(connection)
|
||||
|
Parameters :
Returns :
SigfoxConnection
|
| isAggregationLinked | ||||||
isAggregationLinked(state: GuardState)
|
||||||
|
Check if aggregation is linked
Parameters :
Returns :
boolean
|
| isAggregationUnlinked | ||||||
isAggregationUnlinked(state: GuardState)
|
||||||
|
Check if aggregation is unlinked
Parameters :
Returns :
boolean
|
| isAutoRefreshDisabled | ||||||
isAutoRefreshDisabled(state: GuardState)
|
||||||
|
Check if auto-refresh is disabled (unlinked)
Parameters :
Returns :
boolean
|
| isAutoRefreshEnabled | ||||||
isAutoRefreshEnabled(state: GuardState)
|
||||||
|
Check if auto-refresh is enabled (linked)
Parameters :
Returns :
boolean
|
| isConfig | ||||||
isConfig(state: GuardState)
|
||||||
|
Check if the current display mode is config
Parameters :
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 :
Returns :
boolean
|
| isDateTimeContextLinked | ||||||
isDateTimeContextLinked(state: GuardState)
|
||||||
|
Check if dateTimeContext is linked
Parameters :
Returns :
boolean
|
| isDateTimeContextUnlinked | ||||||
isDateTimeContextUnlinked(state: GuardState)
|
||||||
|
Check if dateTimeContext is unlinked
Parameters :
Returns :
boolean
|
| isHistory | ||||||
isHistory(state: GuardState)
|
||||||
|
Check if the current refresh option is history
Parameters :
Returns :
boolean
|
| isLive | ||||||
isLive(state: GuardState)
|
||||||
|
Check if the current refresh option is live
Parameters :
Returns :
boolean
|
| isViewAndConfig | ||||||
isViewAndConfig(state: GuardState)
|
||||||
|
Check if the current display mode is view and config
Parameters :
Returns :
boolean
|
| isBasic | ||||||
isBasic(tenantLoginOption: TenantLoginOption)
|
||||||
|
Parameters :
|
| isOauthInternal | ||||||
isOauthInternal(tenantLoginOption: TenantLoginOption)
|
||||||
|
Parameters :
|
| isFullScreenEnabled | ||||
isFullScreenEnabled(element)
|
||||
|
Parameters :
|
| toggleFullscreen | ||||
toggleFullscreen(element)
|
||||
|
Parameters :
|
| isValidReplaceDeviceStepState | ||||
isValidReplaceDeviceStepState(state)
|
||||
|
Parameters :
Returns :
ReplaceDeviceStepState
|
| 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 :
Returns :
Observable<string | IMeasurementValue>
Observable |
| loadBoxModel |
loadBoxModel()
|
| loadOrbitControls |
loadOrbitControls()
|
|
Dynamically imports the OrbitControls of three js.
Returns :
Promise<>
A Promise of OrbitControls (three js). |
| loadPhoneModel |
loadPhoneModel()
|
| loadThree |
loadThree()
|
|
Dynamically imports three js.
Returns :
Promise<>
A Promise of three js. |
| mapToSourceValueObject | |||
mapToSourceValueObject(undefined)
|
|||
|
Parameters :
Returns :
literal type
|
| memoize | ||||||
memoize(resolver?)
|
||||||
|
Decorator to memoize function results.
Parameters :
|
| minOneDatapointActive |
minOneDatapointActive()
|
|
Returns :
ValidatorFn
|
| provideClientLibServices |
provideClientLibServices()
|
|
Provides all services from
Returns :
Provider[]
An array of providers for all services from |
| toProvider | ||||||
toProvider(provide: Type)
|
||||||
|
Parameters :
Returns :
Provider
|
| 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. |
| registerTranslateExtension | |||||||||
registerTranslateExtension(translate: TranslateService, parser: TranslateParser)
|
|||||||||
|
Parameters :
|
| retryWithDelay |
retryWithDelay(delayTime: number, count: number)
|
|
Returns :
MonoTypeOperatorFunction<T>
|
| RolesServiceFactory | ||||
RolesServiceFactory(injector)
|
||||
|
Parameters :
|
| rootScopeCommandTemplateFactory | ||||||
rootScopeCommandTemplateFactory($injector: Injector)
|
||||||
|
Parameters :
|
| rootScopeTypeDetailFactory | ||||||
rootScopeTypeDetailFactory($injector: Injector)
|
||||||
|
Parameters :
|
| simpleJsonPathValidator | ||||||
simpleJsonPathValidator(control: AbstractControl)
|
||||||
|
Parameters :
Returns :
ValidationErrors | null
|
| SmartRulesServiceFactory | ||||||
SmartRulesServiceFactory(injector: any)
|
||||||
|
Parameters :
|
| SmartRulesUpgradeServiceFactory | ||||||
SmartRulesUpgradeServiceFactory(injector: any)
|
||||||
|
Parameters :
|
| strToNumber | ||||
strToNumber(value)
|
||||
|
Transforms a string into a number (if needed).
Parameters :
Returns :
number
|
| TenantPoliciesFactory | ||||||
TenantPoliciesFactory(injector: any)
|
||||||
|
Parameters :
|
| throttle | |||||||||
throttle(wait?, options?)
|
|||||||||
|
Decorator to throttle functions call.
Parameters :
|
| uniqueInCollectionByPathValidator | ||||||||||||
uniqueInCollectionByPathValidator(collection: Iterable, path: string, comparator?)
|
||||||||||||
|
Parameters :
Returns :
ValidatorFn
|
| UserInventoryRolesFactory | ||||
UserInventoryRolesFactory(injector)
|
||||
|
Parameters :
|
| validateInternationalPhoneNumber |
validateInternationalPhoneNumber()
|
|
Returns :
ValidatorFn
|