Index

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

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

core/action/action.model.ts

Action

An action is a global operation which you can add to the plus sign in the upper right corner or any custom component added to the header.

ActionWithLabelAndFunction | ActionWithTemplate | ActionWithComponent
ActionFactory

Factory to implement if used in a hook for Multi Provider extension.

ExtensionFactory<Action>

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>
ActionBarItem

An action bar item is a action in scope of a current route of the application.

ActionBarItemWithTemplate | ActionBarItemWithComponent

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/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/forms/validate-array-elements.ts

ArrayValidationErrors
literal type
ArrayValidationErrorValue
literal type

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>
BreadcrumbItem

A crumb of the breadcrumb.

BreadcrumbItemWithComponent | BreadcrumbItemWithLabel

map/map.model.ts

C8yMarker
MapDefaultConfig
Pick<MapConfig | "center" | "zoomLevel">

core/common/permissions.service.ts

CanEditConfig
literal type

search/search-custom-filters.component.ts

Checkbox
literal type

test/test-config.helper.ts

CompilerOptions
Partial<literal type>
ConfigureFn
function

context-dashboard/context-dashboard.model.ts

DashboardGlobalRoles
number[] |

device-grid/device-grid.model.ts

DataCallback
function
DeviceGridExtensionFactory
ExtensionFactory<DeviceGridActionHook>
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

widgets/definitions/index.ts

DefaultWidgetIdKeys
DefaultWidgetIdValues

device-grid/device-grid-extension.service.ts

DeviceGridActionExtension

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 }
DeviceGridActionHook | DeviceGridActionHook[] | ExtensionFactory<DeviceGridActionHook>

core/docs/docs.models.ts

DocLink

A link on the right drawer.

DocLinkWithComponent | DocLinkWithLabel
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/drawer/drawer.model.ts

DrawerItem
RightDrawerItem | LeftDrawerItem
DrawerPositions
"left" | "right"

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

DynamicComponentDefinition

A dynamic component can be defined in a the HOOK_COMPONENTS to display any kind of component dynamically just by referencing it's id. The most common use case is on dashboards, where the configComponent is used to define what is displayed on the component on the dashboard.

To use the component you can use the c8y-dynamic-component.

  <c8y-dynamic-component
    componentId="angular.widget.demo"
    [config]="{ text: 'Hello world' }"
    [mode]="editComponent ? 'config' : 'component'"
  ></c8y-dynamic-component>
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>
DynamicComponents
EagerDynamicComponents | LazyDynamicComponents

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/extension-hooks.ts

GenericHookType
T | T[] | Type<ExtensionFactory<T>>

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

GridConfigFilter

Defines the various options to define if a given part from the data grid configuration will be omited when configuration is persisted. A truthy or missing value means that the given configuration part will be persisted. A falsy value means that the configuration part will not be persisted.

GridConfigPart

Defines the various types of configuration options for data grid component.

"filter" | "sort" | "customColumns" | "order" | "visibility"
GridEventType

Defines the various types of configuration change events the data grid component can emit.

"filter" | "sort" | "pagination" | "addCustomColumn" | "removeCustomColumn" | "reorderColumn" | "changeColumnVisibility"

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.

ecosystem/shared/ecosystem.model.ts

LicensedApplicationPlugin
Pick<ApplicationPlugin | "type" | "license" | "name" | "version" | "contextPath">

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/common/global-config.service.ts

ManagedObjectTypeForConfig
"c8y_Software" | "c8y_Firmware" | "c8y_ConfigurationDump" | "c8y_ModbusDeviceType" | "c8y_CANopenDeviceType" | "c8y_LoraDeviceType" | "c8y_SigfoxDeviceType" | "c8y_DeviceShellTemplate"

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

widgets/implementations/device-management-welcome/welcome.component.ts

QuickLink
Pick<DocLink | "label" | "click" | "icon">

core/realtime/realtime.model.ts

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

widgets/implementations/map/map-widget.model.ts

RefreshOptions
"none" | "realtime" | "interval"

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.model.ts

Route

A route that can be added via the HOOK_ROUTE.

RouteDefault | RouteWithTab | RouteWithComponent
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.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

core/drop-area/drop-area.component.ts

SizeInBytes
number
SizeInMegaBytes
number

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/tab.model.ts

Tab

An tab allows to switch routes on a page.

TabWithTemplate | TabWithComponent
TabFactory

Factory to implement if used in a hook for Multi Provider extension.

ExtensionFactory<Tab>

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>

ecosystem/application-plugins/apps-to-update-remotes-select.model.ts

UpdateType
"install" | "uninstall"

data-broker/model/data-broker.subscription.model.ts

UserStatusPartial
Required<Pick<IUser, "id" | "enabled">>

core/wizard/wizard.model.ts

WizardExtension
WizardEntry | WizardEntry[] | ExtensionFactory<WizardEntry>

results matching ""

    No results matching ""