@talenra/inbox documentation
  1. Interfaces
  2. IPreset

File

src/lib/shared/interfaces/preset.interface.ts

Description

IPreset is used to define a specific preset for the inbox.

Example :
import { IPreset } from '@talenra/inbox';

const presets: IPreset = { identifier: '121bd936-ce20-4ea9-9dc1-6cdaf61f9c3d', name: 'Meine Inbox', changeable: false, selectedAttributes: [ { identifier: 'case.caseTypeName', defaultAttribute: 'main' }, { identifier: 'case.caseID', defaultAttribute: 'detail' }, ], children: [ { name: 'View 1', numberMainAttributesChosenByUser: 4, selectedAttributes: [ { identifier: 'case.caseTypeName', defaultAttribute: 'main' }, { identifier: 'case.caseID', defaultAttribute: 'main' }, { identifier: 'processStep', defaultAttribute: 'detail' }, { identifier: 'insuree.lastNameOrgName', defaultAttribute: 'detail' }, { identifier: 'case.caseStartDate', defaultAttribute: 'detail' }, { identifier: 'member.lastNameOrgName', defaultAttribute: 'detail' }, { identifier: 'insuree.socialSecurityNumber', defaultAttribute: 'detail' }, { identifier: 'case.casePriority', defaultAttribute: 'main' }, ], sortAttributes: [ { identifier: 'case.caseTypeName', sort: 'asc' }, { identifier: 'insuree.socialSecurityNumber', sort: 'desc' }, ], filterAttributes: [ { identifier: 'case.caseTypeName', value: [{ key: 'directWarning', label: 'Direkt Eingegangene Beschwerde' }, { key: 'directError', label: 'Direkt Fehler' }, ], }, { identifier: 'case.caseStartDate', value: { start: new Date('01.14.2023'), end: new Date('01.14.2024') }, }, { identifier: 'case.casePriority', value: { start: 1, end: 2 } }, ], iconAttributes: [], }, { name: 'View 2', numberMainAttributesChosenByUser: 4, selectedAttributes: [ { identifier: 'case.caseTypeName', defaultAttribute: 'main' }, { identifier: 'case.caseID', defaultAttribute: 'main' }, { identifier: 'processStep', defaultAttribute: 'detail' }, { identifier: 'insuree.lastNameOrgName', defaultAttribute: 'detail' }, { identifier: 'case.caseStartDate', defaultAttribute: 'detail' }, { identifier: 'member.lastNameOrgName', defaultAttribute: 'detail' }, ], sortAttributes: [{ identifier: 'case.caseTypeName', sort: 'asc' }], filterAttributes: [ { identifier: 'case.caseTypeName', value: ['Direkt eingegangene Beschwerde'], }, ], iconAttributes: [], }, ], };

Index

Properties

Properties

changeable
changeable: boolean
Type : boolean
Optional

Changeable is used to define if the preset is changeable in the inbox or not. Disable the option for user to overwrite the preset.
children
children: IPreset[]
Type : IPreset[]

Children are used to define if the preset has child presets.
filterAttributes
filterAttributes: IQueryBuilderQuery
Type : IQueryBuilderQuery
Optional

FilterAttributes is used to define which attributes are used to filter the items in the inbox. Make sure to use only attributes which are already used in selectedAttributes (SelectedAttributesInput[])
iconAttributes
iconAttributes: IIconFiltersInput[]
Type : IIconFiltersInput[]
Optional

IconAttributes is used to define which icon filters are active in the inbox.
identifier
identifier: string
Type : string

Optional string to identify the item. Used to identify the preset in the sidenav.
name
name: string
Type : string

Name is used to define the name of the preset.
numberMainAttributesChosenByUser
numberMainAttributesChosenByUser: number
Type : number
Optional

The number of chosen main attributes that are to be displayed in the attributes settings and data items list.
selectedAttributes
selectedAttributes: ISelectedAttributesInput[]
Type : ISelectedAttributesInput[]

The selectedAttributes is used to define which attributes are selected and displayed in the main or detail section. If an attribute is not chosen, it will be displayed as unselected.
sortAttributes
sortAttributes: ISortAttributesInput[]
Type : ISortAttributesInput[]
Optional

SortAttributes is used to define which attributes are used to sort the items in the inbox.
visible
visible: boolean
Type : boolean
Optional

Visible attribute is used to define if the preset is visible in the sidenav or not.

results matching ""

    No results matching ""