Web SDK documentation
  1. Miscellaneous
  2. Type aliases

Index

core/properties-list/properties-list.model.ts

AcceptedPropertyTypes
string | string[] | number | number[]

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

ActionBarExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
ActionBarItem | ActionBarItem[] | ExtensionFactory<ActionBarItem>

core/action-bar/action-bar.model.ts

ActionBarFactory

Factory to implement if used in a hook for Multi Provider extension.
ExtensionFactory<ActionBarItem>

core/action/action.service.ts

ActionExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
Action | Action[] | ExtensionFactory<Action>

core/action/action.model.ts

ActionFactory

Factory to implement if used in a hook for Multi Provider extension.
ExtensionFactory<Action>

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

AlertDismissalData
literal type | literal type | literal type
AlertType

core/alert/alert.service.ts

alertType
"success" | "warning" | "danger" | "info" | "system"

core/breadcrumb/breadcrumb.service.ts

BreadcrumbExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
Breadcrumb | Breadcrumb[] | ExtensionFactory<Breadcrumb>

core/breadcrumb/breadcrumb.model.ts

BreadcrumbFactory

Factory to implement if used in a hook for Multi Provider extension.
ExtensionFactory<Breadcrumb>

search/search-custom-filters.component.ts

Checkbox
literal type

test/test-config.helper.ts

CompilerOptions
Partial<literal type>
ConfigureFn
function

device-grid/device-grid.model.ts

DataCallback
function
SortOrderModifier
Use import { SortOrderModifier } from '@c8y/ngx-components'; instead.
CoreSortOrderModifier

datapoint-selector/datapoint-selection.model.ts

DatapointSelectorModalAssetSelectorOptions
Omit<MillerViewComponent | "multi" | "singleColumn" | "onSelected" | "millerViewWrapper" | "columns" | "ngOnInit" | "ngOnChanges" | "addNewColumn" | "onSelectionChange">

datapoint-selector/datapoint-selector-modal/datapoint-selector-modal.model.ts

DatapointSelectorModalOptions
Omit<DatapointSelectorModalComponent | "result" | "saveChanges" | "close" | "selectionChange">

core/dashboard/widget-change-event.model.ts

DateTimeContext
[Date, Date]
WidgetChangeEvent

Type for describing widget change events. It's possible to extend this by adding additional events to discriminated union type.
TimeContextEvent
WidgetChangeEventType

core/docs/docs.models.ts

DocLinkExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
DocLink | DocLink[] | ExtensionFactory<DocLink>

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

DynamicComponentExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
DynamicComponentDefinition | DynamicComponentDefinition[] | ExtensionFactory<DynamicComponentDefinition>

core/provider-configuration/model/dynamic-provider-config.model.ts

DynamicProviderNavigationConfig
DynamicProviderTabsConfig

core/plugins/plugins-resolve.service.ts

Factory
function
Scope

core/data-grid/data-grid.model.ts

FilterPredicateFunction

A filter predicate function.
function
ServerSideDataCallback

A callback function to fetch server data.
function
ServerSideDataResult

Describes a result from server with data and additional statistics.
SortOrder

Sorting order: ascending, descending, or not specified.
"asc" | "desc" | string

core/forms/form-group-config.model.ts

FormGroupConfig

Helper type for form group configuration based on a given entity interface. Ensures that model changes will be detected at compile time avoiding runtime errors and possible data loss.

core/common/group.service.ts

Icon
Partial<literal type>
Icons
Partial<Record<MoTypes, Icon>>
MoTypes

core/stepper/stepper.model.ts

IndexedStep

Can be used to mark a step as completed and adds the current index to the step.

core/common/load-more.model.ts

LoadMoreMode

The mode for components using infinite scroll:

  • auto: Tries to automatically load more data;
  • show: Shows a load more button for the user to decide;
  • none: Doesn't perform any load more action;
  • hidden: Loads more data automatically but with no visible button for the user.
"auto" | "show" | "none" | "hidden"

core/navigator/navigator.service.ts

NavigatorExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
NavigatorNode | NavigatorNode[] | ExtensionFactory<NavigatorNode>

core/navigator/navigator-node-factory.interface.ts

NavigatorNodeFactory

Factory enabling extension of the navigator menu through the HOOK_NAVIGATOR_NODES hook. Refer to Libraries > Component library > Extension points in our Web SDK guide.
ExtensionFactory<NavigatorNode>

operations/bulk-operation-list-item/bulk-operation-list-item.model.ts

OperationStatusOptionsMap

operations/shared/operations.model.ts

OperationStatusOptionsMap

default-subscriptions/default-subscriptions.model.ts

PartialAppsList

The list of partial application objects.
Array<Partial<IApplication>>

core/dashboard/widget-time-context.model.ts

PredefinedTimeSpan
literal type

core/realtime/realtime.model.ts

RealtimeAction
"UPDATE" | "DELETE" | "CREATE"

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

RegisterDeviceExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
RegisterDeviceItem | RegisterDeviceItem[] | ExtensionFactory<RegisterDeviceItem>

register-device/dropdown/RegisterDeviceItem.ts

RegisterDeviceFactory

Factory to implement if used in a hook for Multi Provider extension.
ExtensionFactory<RegisterDeviceItem>

repository/shared/repository.model.ts

RepositoryBinary
FirmwareBinary | SoftwareBinary | FirmwarePatchBinary

core/router/router.models.ts

Route
RouteFactory
Route | Route[] | ExtensionFactory<Route>

core/router/router.service.ts

RouteExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
Route | Route[] | ExtensionFactory<Route>

core/search/search.service.ts

SearchExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
Search | Search[] | ExtensionFactory<Search>

core/search/search.model.ts

SearchFactory

Factory to implement if used in a hook for Multi Provider extension.
ExtensionFactory<Search>

core/select/select.component.ts

selectedFunction
function
selectedLabelFunction
function

actility-device-registration/actility-device-registration.component.ts

State
"loadPending" | "loadSuccess" | "loadError" | "registrationPending" | "registrationSuccess" | "registrationError"

loriot-device-registration/loriot-device-registration.component.ts

State
"loadPending" | "loadSuccess" | "loadError" | "registrationPending" | "registrationSuccess" | "registrationError"

sigfox-device-registration/sigfox-device-registration.component.ts

State
"loadPending" | "loadSuccess" | "loadError" | "registrationPending" | "registrationSuccess" | "registrationError"

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

State
"loadingConnection" | "loadingError" | "connectionAvailable" | "connectionNotAvailable" | "addConnections" | "savedSuccessfully" | "updateConnection"

core/common/status.model.ts

StatusType
Status | "success" | "warning" | "danger" | "info"

core/stepper/stepper.service.ts

StepperExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
Step | Step[] | ExtensionFactory<Step>

core/tabs/tabs.service.ts

TabExtension

An extension HOOK can use either a pure value:

 { provide: HOOK_X, useValue: { ...hookValue }, multi: true }

Or an array to directly register multiple:

 { provide: HOOK_X, useValue: [{ ...hookValues }], multi: true }

Or an ExtensionFactory which allows to define a get() function. This function gets called on each navigation with the current route and can return values async (observable or promise).

 { provide: HOOK_X, useFactory: { get: (route) => doSomethingAsync(route) }, multi: true }
Tab | Tab[] | ExtensionFactory<Tab>

core/tabs/tab.model.ts

TabFactory

Factory to implement if used in a hook for Multi Provider extension.
ExtensionFactory<Tab>

core/wizard/wizard.model.ts

WizardExtension
WizardEntry | WizardEntry[] | ExtensionFactory<WizardEntry>

results matching ""

    No results matching ""