Options
All
  • Public
  • Public/Protected
  • All
Menu

@netgrif/components-core

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

The two nested arrays represent a predicate tree with 3 levels. The root node of the tree is a predicate consisting of a conjunction (AND) of its subtrees.

The single array represents a predicate tree with 2 levels. The root node of the tree is a predicate consisting of a disjunction (OR) of its subtrees.

The CategoryGeneratorMetadata represents a predicate tree with 1 level - a leaf node.

Headers: HttpHeaders | {}
IconStyle: "large" | "small"
Mode: "full" | "horizontal" | "vertical" | "icon"
NaeDate: number[]

[year month day hour minute second timestamp] month and day are 1 indexed

Params: HttpParams | ObjectParams
PredicateTreeMetadata: CategoryGeneratorMetadata[][]

Serialized advanced search filter predicate tree.

The nested array represent nested predicate trees with boolean operators. The structure of the tree mirrors the search component.

The top level array is a conjunction (AND) of its subtrees.

The second level array is a disjunction (OR) of the leaves.

The CategoryGeneratorMetadata is a leaf node of the predicate tree containing a single query generated by AbstractSearchPredicateComponent (and by extension by a Category).

QuickPanelItem: "language" | "settings" | "logout" | "impersonation"
Resources: Resource | Resource[]

This file is single point of truth for NAE frontend configuration schema.

ResponseType: "json" | "hal"
TaskContentElementType: FieldTypeResource | TaskElementType

Variables

BOOLEAN_VALUE_LABEL_ENABLED: InjectionToken<boolean> = ...
BaseFilterFactoryProvider: { deps: (typeof CaseResourceService | typeof PublicTaskLoadingService | typeof ProcessService | typeof SnackBarService | typeof TranslateService | typeof RedirectService | typeof Router | typeof ActivatedRoute)[]; provide: InjectionToken<BaseFilter>; useFactory: ((router: Router, route: ActivatedRoute, process: ProcessService, caseResourceService: CaseResourceService, snackBarService: SnackBarService, translate: TranslateService, publicTaskLoadingService: PublicTaskLoadingService) => { filter: SimpleFilter }) } = ...

Type declaration

CASE_ID: "caseId" = "caseId"
CONFIRM_PASSWORD: "confirmPassword" = 'confirmPassword'
CaseResourceServiceProvider: { deps: (typeof AuthenticationService | typeof SessionService | typeof ConfigurationService | typeof UserService | typeof ResourceProvider | typeof RedirectService | typeof PublicUrlResolverService | typeof Router)[]; provide: typeof CaseResourceService; useFactory: ((userService: UserService, sessionService: SessionService, authService: AuthenticationService, router: Router, publicResolverService: PublicUrlResolverService, provider: ResourceProvider, config: ConfigurationService, redirectService: RedirectService) => any) } = ...

Type declaration

DATA_FIELD_PORTAL_DATA: InjectionToken<DataFieldPortalData<DataField<unknown>>> = ...
DATE_FORMAT: { display: { dateA11yLabel: string; dateInput: string; monthYearA11yLabel: string; monthYearLabel: string }; parse: { dateInput: string } } = ...

Type declaration

  • display: { dateA11yLabel: string; dateInput: string; monthYearA11yLabel: string; monthYearLabel: string }
    • dateA11yLabel: string
    • dateInput: string
    • monthYearA11yLabel: string
    • monthYearLabel: string
  • parse: { dateInput: string }
    • dateInput: string
DATE_FORMAT_STRING: "DD.MM.YYYY" = 'DD.MM.YYYY'
DATE_TIME_FORMAT: { display: { dateA11yLabel: string; dateInput: string; monthYearA11yLabel: string; monthYearLabel: string }; parse: { dateInput: string } } = ...

Type declaration

  • display: { dateA11yLabel: string; dateInput: string; monthYearA11yLabel: string; monthYearLabel: string }
    • dateA11yLabel: string
    • dateInput: string
    • monthYearA11yLabel: string
    • monthYearLabel: string
  • parse: { dateInput: string }
    • dateInput: string
DATE_TIME_FORMAT_STRING: "DD.MM.YYYY HH:mm" = 'DD.MM.YYYY HH:mm'
DEFAULT: "default" = "default"
DEFAULT_LANGUAGE_CODE: "xx" = 'xx'
LEFT_DRAWER_DEFAULT_WIDTH: 60 = 60
MENU_IDENTIFIERS: string[] = ...
NAE_ADMIN_IMPERSONATE_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_ADMIN_IMPERSONATE_DIALOG_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_ASYNC_RENDERING_CONFIGURATION: InjectionToken<AsyncRenderingConfiguration> = ...

Holds configuration of the task content async rendering properties.

The value represents the number of elements rendered in one rendering cycle

NAE_AUTOSWITCH_TAB_TOKEN: InjectionToken<boolean> = ...
NAE_BASE_FILTER: InjectionToken<BaseFilter> = ...

Provides the base filter of a SearchService

NAE_CASE_REF_CREATE_CASE: InjectionToken<boolean> = ...
NAE_CASE_REF_DATAFIELD: InjectionToken<CaseRefField> = ...
NAE_CASE_REF_SEARCH: InjectionToken<boolean> = ...
NAE_DEFAULT_CASE_SEARCH_CATEGORIES: InjectionToken<Type<Category<any>>[]> = ...

Contains a list of classes that represent the default case search categories.

The default search categories can be overridden by providing this injection token with a new set of categories in the AppComponent.

NAE_DEFAULT_HEADERS: InjectionToken<string[]> = ...
NAE_DEFAULT_LANGUAGE: InjectionToken<string> = ...
NAE_DEFAULT_MIN_PASSWORD_LENGTH: 8 = 8
NAE_DEFAULT_TASK_SEARCH_CATEGORIES: InjectionToken<Type<Category<any>>[]> = ...

Contains a list of classes that represent the default task search categories.

The default search categories can be overridden by providing this injection token with a new set of categories in the AppComponent.

NAE_FILTERS_FILTER: InjectionToken<Filter> = ...

Used for providing any additional constraints to the filter case filtering, when user filters are loaded via the UserFiltersService.

The provided filter must be of type Case as it is used for the filtering of cases representing saved user filters.

NAE_FILTER_FIELD: InjectionToken<FilterField> = ...

Provides access to the FilterField instance for dependency injection inside an AbstractFilterFieldComponent implementation.

NAE_FILTER_TEXT: InjectionToken<FilterTextConfiguration> = ...

Provides necessary data for the display of immediate filter fields on panels

NAE_GROUP_NAVIGATION_COMPONENT_RESOLVER_COMPONENT: InjectionToken<Type<AbstractGroupNavigationComponentResolverComponent>> = ...

Holds component for dynamic routing resolution of group navigation component resolver component by the RoutingBuilderService.

NAE_IMPORT_NET_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_IMPORT_NET_DIALOG_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_INFORM_ABOUT_INVALID_DATA: InjectionToken<boolean> = ...

Whether invalid data values should be sent to backend or not. Invalid data is NOT set to backend by default. You can use this InjectionToken to override this behavior in a specific application scope.

This token is ultimately injected by individual data fields, so this option can be in theory applied at a very low level of granularity. The library implementation doesn't allow access to such low level components, so a custom implementation is necessary to provide this token at such low level. Applying the token to individual task views is achievable with the default implementation.

NAE_LOAD_FILTER_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_LOAD_FILTER_DIALOG_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_MIN_PASSWORD_LENGTH: InjectionToken<number> = ...
NAE_MULTI_USER_ASSIGN_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_MULTI_USER_ASSIGN_DIALOG_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_NAVIGATION_ITEM_TASK_DATA: InjectionToken<DataGroup[]> = ...

Holds a navigation item task data containing the aggregated data describing the navigation item

NAE_NET_ALL_VERSIONS: InjectionToken<boolean> = ...
NAE_NET_VERSION_VISIBLE: InjectionToken<boolean> = ...
NAE_NEW_CASE_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_NEW_CASE_CONFIGURATION: InjectionToken<NewCaseConfiguration> = ...

Can be used to provide case views with configuration of the {@link CaseViewService#createNewCase}[createNewCase()] method without having to extend the service and override the method.

NAE_NEW_CASE_CREATION_CONFIGURATION_DATA: InjectionToken<NewCaseCreationConfigurationData> = ...
NAE_NEW_CASE_DIALOG_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_OPEN_EXISTING_TAB: InjectionToken<boolean> = ...
NAE_OPTION_SELECTOR_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_OPTION_SELECTOR_DIALOG_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_PREFERRED_TASK_ENDPOINT: InjectionToken<TaskEndpoint> = ...
deprecated

in 5.3.0 - Use NAE_TASK_VIEW_CONFIGURATION instead

NAE_ROUTING_CONFIGURATION_PATH: "configPath" = "configPath"
NAE_SAVE_FILTER_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_SAVE_FILTER_DIALOG_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_SEARCH_CATEGORIES: InjectionToken<Category<any>[] | Type<Category<any>>[]> = ...

Contains the search categories that can be used with the SearchComponent that injects them.

The search component is universal and the categories provided with this token are what determines what query objects are going to be constructed.

The token content with the type Array<Category<any>> has been deprecated in 5.6.0 in favor of the new type Array<Type<Category<any>>> but remains for backwards-compatibility.

NAE_SEARCH_COMPONENT_CONFIGURATION: InjectionToken<SearchComponentConfiguration> = ...

Contains configuration of the SearchComponent that injects them.

The component can be also configured by component inputs.

NAE_SIDE_MENU_CONTROL: InjectionToken<SideMenuControl> = ...
NAE_SNACKBAR_HORIZONTAL_POSITION: InjectionToken<SnackBarHorizontalPosition> = ...
NAE_SNACKBAR_VERTICAL_POSITION: InjectionToken<SnackBarVerticalPosition> = ...
NAE_TAB_DATA: InjectionToken<InjectedTabData> = ...

Injection token for injection of InjectedTabData into tabs in TabView.

Also see TabContent for more information.

NAE_TASK_FORCE_OPEN: InjectionToken<boolean> = ...
NAE_TASK_OPERATIONS: InjectionToken<TaskOperations> = ...
NAE_TASK_PANEL_DISABLE_BUTTON_FUNCTIONS: InjectionToken<DisableButtonFuntions> = ...
NAE_TASK_VIEW_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_TASK_VIEW_CONFIGURATION: InjectionToken<TaskViewConfiguration> = ...
NAE_TREE_CASE_VIEW_CONFIGURATION: InjectionToken<TreeCaseViewConfiguration> = ...
NAE_URI_NODE_CASES_PAGE_SIZE: InjectionToken<string> = ...

Case search request page size

NAE_USER_ASSIGN_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_USER_ASSIGN_DIALOG_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_USER_IMPERSONATE_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_USER_IMPERSONATE_DIALOG_COMPONENT: InjectionToken<ComponentType<unknown>> = ...
NAE_VIEW_ID: InjectionToken<string> = ...
NAE_VIEW_ID_SEGMENT: InjectionToken<string> = ...
NAE_WORKFLOW_SERVICE_CONFIRM_DELETE: InjectionToken<boolean> = ...

An InjectionToken that can be used to enable/disable process delete confirmation dialog

NAE_WORKFLOW_SERVICE_FILTER: InjectionToken<PetriNetRequestBody> = ...

An InjectionToken that can be used to set the process filter in workflow view

OLD_PASSWORD: "oldPassword" = 'oldPassword'
PASSWORD: "password" = 'password'
PETRI_NET_ID: "petriNetId" = "petriNetId"
PUBLISHERS: { backend: any; console: typeof ConsoleLogPublisher; localStorage: typeof LocalStorageLogPublisher } = ...

Type declaration

PetriNetResourceServiceProvider: { deps: (typeof AuthenticationService | typeof SessionService | typeof ConfigurationService | typeof UserService | typeof ResourceProvider | typeof RedirectService | typeof PublicUrlResolverService | typeof Router)[]; provide: typeof PetriNetResourceService; useFactory: ((userService: UserService, sessionService: SessionService, authService: AuthenticationService, router: Router, publicResolverService: PublicUrlResolverService, provider: ResourceProvider, config: ConfigurationService, redirectService: RedirectService) => any) } = ...

Type declaration

ProcessServiceProvider: { deps: (typeof LoggerService | typeof AuthenticationService | typeof SessionService | typeof UserService | typeof PetriNetResourceService | typeof RedirectService | typeof PublicUrlResolverService | typeof Router)[]; provide: typeof ProcessService; useFactory: ((userService: UserService, sessionService: SessionService, authService: AuthenticationService, router: Router, publicResolverService: PublicUrlResolverService, petriNetResource: PetriNetResourceService, publicPetriNetResource: PublicPetriNetResourceService, loggerService: LoggerService, redirectService: RedirectService) => any) } = ...

Type declaration

RIGHT_DRAWER_DEFAULT_MIN_WIDTH: 180 = 180
RIGHT_DRAWER_DEFAULT_WIDTH: 240 = 240
RIGHT_DRAWER_MAX_WIDTH: 460 = 460
RIGHT_SIDE_INIT_PAGE_SIZE: 20 = 20
RIGHT_SIDE_NEW_PAGE_SIZE: 10 = 10
SETTINGS_TRANSITION_ID: "item_settings" = 'item_settings'
TRANSITION_ID: "transitionId" = "transitionId"
TaskResourceServiceProvider: { deps: (typeof LoggerService | typeof AuthenticationService | typeof SessionService | typeof ConfigurationService | typeof UserService | typeof ResourceProvider | typeof RedirectService | typeof FieldConverterService | typeof PublicUrlResolverService | typeof Router)[]; provide: typeof TaskResourceService; useFactory: ((userService: UserService, sessionService: SessionService, authService: AuthenticationService, router: Router, publicResolverService: PublicUrlResolverService, logger: LoggerService, provider: ResourceProvider, config: ConfigurationService, fieldConverter: FieldConverterService, redirectService: RedirectService) => any) } = ...

Type declaration

redirectAction: FrontActionDefinition = ...
reloadTaskAction: FrontActionDefinition = ...
validateTaskAction: FrontActionDefinition = ...

Functions

  • HttpLoaderFactory(http: HttpClient): TranslateHttpLoader
  • arrayToObservable<T>(observables: T[]): Observable<T>
  • clearTimeInformation(date: Moment): void
  • createMockCase(stringId?: string, processIdentifier?: string, title?: string, petriNetId?: string): Case
  • Creates a mock Case instance with the given attributes.

    The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.

    Parameters

    • stringId: string = 'stringId'
    • processIdentifier: string = 'processIdentifier'
    • title: string = 'title'
    • petriNetId: string = 'petriNetId'

    Returns Case

  • createMockCaseOutcome(aCase?: Case, net?: Net, outcomes?: EventOutcome[]): CaseEventOutcome
  • createMockDataGroup(fields: DataField<unknown>[], title?: string, alignment?: DataGroupAlignment, layoutType?: DataGroupLayoutType, compact?: DataGroupCompact, hideRows?: DataGroupHideEmptyRows, stretch?: boolean, cols?: number, parentTaskId?: string, parentTaskRefId?: string, nestingLevel?: number): DataGroup
  • Creates a mock DataGroup object instance containing the provided fields and having the provided configuration.

    Parameters

    • fields: DataField<unknown>[]

      the DataFields contained in the data group

    • Optional title: string

      the optional title of the data group

    • alignment: DataGroupAlignment = DataGroupAlignment.START

      alignment of the fields in non-full rows within the data group (affects flow and legacy layout)

    • layoutType: DataGroupLayoutType = DataGroupLayoutType.LEGACY

      the layout type of the data group

    • Optional compact: DataGroupCompact

      compacting rule for the data group

    • Optional hideRows: DataGroupHideEmptyRows

      row hiding rule for the data group

    • stretch: boolean = false

      whether the stretch property of the data group is enabled or not

    • cols: number = 4

      the number of columns of the data group layout

    • Optional parentTaskId: string

      the ID of the parent task (if the data group is task-reffed)

    • Optional parentTaskRefId: string

      the ID of the parent task ref (if the data group is task-reffed)

    • Optional nestingLevel: number

      the nesting level of the data group (if the data group is task-reffed)

    Returns DataGroup

  • Creates a mock boolean or button field, with the specified properties

    Parameters

    • visible: boolean = true

      if true the fields behavior is set to editable, if false the fields behavior is set to hidden

    • layout: GridLayout = ...

      position of the field in the grid layout

    • counterOrStringId: string | number | IncrementingCounter = 0

      if a string is provided its value will be used as the fields ID. If a number is provided the fields ID will be set to 'f'. If an IncrementingCounter is provided the ID will follow the same pattern as for the number argument, but the counter will be used to generate the number.

    • fieldType: BOOLEAN | BUTTON | TASK_REF = FieldTypeResource.BOOLEAN

      determines what type of field should be generated. Currently only boolean, button and task ref fields are supported. If an unsupported field type is used an error is thrown.

    • taskRefValue: string[] = []

      determines the value of the task ref field if a task ref field is generated

    Returns BooleanField | ButtonField | TaskRefField

  • createMockImmediateData(importId?: string, value?: any, allowedNets?: string[]): ImmediateData
  • createMockNet(stringId?: string, identifier?: string, title?: string, roles?: default[], transitions?: MockTransition[], immediateData?: ImmediateData[], permissions?: Permissions): Net
  • Creates a mock Net instance with the given attributes.

    The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.

    Parameters

    • stringId: string = 'stringId'
    • identifier: string = 'identifier'
    • title: string = 'title'
    • roles: default[] = []
    • transitions: MockTransition[] = []
    • immediateData: ImmediateData[] = []
    • permissions: Permissions = {}

    Returns Net

  • createMockPage<T>(content?: T[]): Page<T>
  • createMockTask(stringId?: string, title?: string, transitionId?: string, cols?: number): Task
  • Creates a mock Task instance with the given attributes.

    The attributes are filled with mostly empty values, if you want to make a test that uses some of them, we recommend setting them yourself, as the returned object might change between versions.

    Parameters

    • stringId: string = 'stringId'
    • title: string = 'taskTitle'
    • transitionId: string = 'transitionId'
    • cols: number = 4

    Returns Task

  • decodeBase64(encoded: string): string
  • destroySubscription(sub: Subscription): void
  • encodeBase64(text: string): string
  • extractFieldValueFromData<T>(dataSection: DataGroup[], fieldId: string): T
  • extractRoles(dataSection: DataGroup[], roleFieldId: string): string[]
  • getFieldIndex(fields: DataField<any>[], fieldId: string): number
  • getImmediateData(useCase: Case, fieldId: string): ImmediateData | undefined
  • groupNavigationViewIdSegmentFactory(activatedRoute: ActivatedRoute): string
  • hasContent(page: Page<unknown>): boolean
  • loadAllPages<T>(source: ((filter: any, params: Params) => Observable<Page<T>>), filter: any, pagination?: Pagination): Observable<T[]>
  • Loads all pages from the given endpoint and returns their content as one array

    Type Parameters

    • T

    Parameters

    • source: ((filter: any, params: Params) => Observable<Page<T>>)

      the method that is used to load an individual page, it must support pagination parameters

        • (filter: any, params: Params): Observable<Page<T>>
        • Parameters

          Returns Observable<Page<T>>

    • filter: any

      the filter/query object that is used to specify the requested objects. The source argument must accept this filter.

    • Optional pagination: Pagination

      configuration of the initial pagination. Pages will be loaded from the provided page number onwards, page size will be upheld.

    Returns Observable<T[]>

    content of all pages from the given page onwards (or from the start if no pagination argument was provided) as a single Array

  • navigationItemCaseViewDefaultHeadersFactory(navigationItemTaskData: DataGroup[]): string[] | undefined
  • Creates search categories based on the metadata stored in the filter case

    Parameters

    • categoryResolverService: CategoryResolverService
    • navigationItemTaskData: DataGroup[]

      task data of a navigation item task, the data must contain a filter field, that is used to generate the categories

    • defaultCaseSearchCategories: Type<Category<any>>[]

      the default case search categories that should be merged with the categories provided by the filter field, if the filter metadata allow it and the filter is a case filter

    • defaultTaskSearchCategories: Type<Category<any>>[]

      the default task search categories that should be merged with the categories provided by the filter field, if the filter metadata allow it and the filter is a task filter

    Returns Type<Category<any>>[]

  • navigationItemTaskViewDefaultHeadersFactory(navigationItemTaskData: DataGroup[]): string[] | undefined
  • ofVoid(): Observable<void>
  • refreshTree(tree: MatTreeNestedDataSource<unknown>): void

Generated using TypeDoc