File

src/lib/inbox-configuration-panel/inbox-configuration-panel.component.ts

Description

Responsible for customizing the layout of the data item settings component.

Example :
<talenra-inbox-configuration-panel
  *ngIf="!loading; else skeletonLoading"
  [attributesSettingsList]="attributeList"
  [maxAttributesShown]="maxAttributesShown"
  [selectedMainAttributes]="selectedMainAttributes"
  [selectedDetailAttributes]="selectedDetailAttributes"
  [(isExpanded)]="keyboardService.attributesSettingsExpanded"
  (selectedMainAttributesEmitter)="selectedMainAttributesEmitterHandler($event)"
  (selectedDetailAttributesEmitter)="selectedDetailAttributesEmitterHandler($event)"
  (selectedAllAttributesEmitter)="selectedAllAttributesEmitterHandler($event)"
  (buttonAction)="onButtonAction($event)"
></talenra-inbox-configuration-panel>

Implements

OnInit OnChanges

Metadata

Index

Properties
Methods
Inputs
Outputs

Inputs

attributesSettingsList
Type : IAttributeItem[]

The used attributes are listed to display them later in the attributes settings UI.

isExpanded
Type : boolean
Default value : false

The boolean value is used to expand the attributes settings UI.

maxAttributesShown
Type : number
Default value : 12

The maximum Attributes which are to be shown in the data-items-list-items. Further they are divided in the ui. Marks the border for which values are saved to attributes and attributes-detail in attributes-settings-service. Default value is 12, like chosen in the requirements.

numberMainAttributesChosenByUser
Type : number
Default value : 12

The maximum Attributes, which are to be shown in the data-items-list-items mutated by the user.

selectedDetailAttributes
Type : IAttributeItem[]
Default value : []

Sets the selected detail attributes.

selectedMainAttributes
Type : IAttributeItem[]
Default value : []

Sets the selected main attributes.

customTabs
Type : IInboxTabBarItem[]
Default value : []

The extra tabs for the panel.

filterSelections
Type : IQueryBuilderQuery
Default value : { identifier: 'head', rules: [], condition: QueryBuilderCondition.And, hierarchyLevel: 1, }

The filterSelection input is an array of strings that contains the selected filters.

possibleOptions
Type : IQueryBuilderValueOptions[]

The values that can be selected in connection to each rule identifier.

possibleRules
Type : IQueryBuilderPossibleRule[]
Default value : []

The possible rules that can be selected.

selectedTab
Type : string
Default value : 'attribute-settings'

The selected tab. Should contain the key of the tab.

sortSelections
Type : ISortAttributesInput[]
Default value : []

The sortSelections input is an array of strings that contains the selected sorts.

Outputs

isExpandedChange
Type : EventEmitter

The boolean value is used to expand the attributes settings UI.

numberMainAttributesChosenByUserEmitter
Type : EventEmitter

The number value that is chosen by the user to show the main attributes.

selectedAllAttributesEmitter
Type : EventEmitter

Emits the all selected attributes.

selectedDetailAttributesEmitter
Type : EventEmitter

Emits the detail selected attributes.

selectedMainAttributesEmitter
Type : EventEmitter

Emits the main selected attributes.

buttonAction
Type : TConfigurationPanelBottomBarActions

Emits actions.

filterSelections
Type : IQueryBuilderQuery

The filterSelection input is an array of strings that contains the selected filters.

presetInteractions
Type : string

EventEmitter for the interactions with the preset.

selectedFilters
Type : IQueryBuilderQuery

The selectedFilters output is an array of strings that contains the selected filters.

selectedSorts
Type : ISortAttributesInput[]

The selectedSorts output is an array that contains the selected sorts.

selectedTab
Type : string

The selected tab. Should contain the key of the tab.

sortSelections
Type : ISortAttributesInput[]

The sortSelections input is an array of strings that contains the selected sorts.

Methods

filterKindChange
filterKindChange(kind: boolean)

Change the filter kind.

Parameters :
Name Type Optional Description
kind boolean No

The filter kind.

Returns : void
numberMainAttributesChosenByUserHandler
numberMainAttributesChosenByUserHandler($event: number)

Emits the number main attributes chosen by user change.

Parameters :
Name Type Optional Description
$event number No

The number value that is chosen by the user to show the main attributes.

Returns : void
onBottomBarAction
onBottomBarAction(action: TConfigurationPanelBottomBarActions)

The action that is to be performed in for the items.

Parameters :
Name Type Optional Description
action TConfigurationPanelBottomBarActions No

The action clicked in the bottom bar.

Returns : void
onCloseClick
onCloseClick()

Method to emit the close button and close the inbox detail view

Returns : void
onPresetInteractions
onPresetInteractions(event: string)

Handler for the preset interactions.

Parameters :
Name Type Optional Description
event string No

The event of the preset interactions.

Returns : void
onQueryChange
onQueryChange(query: IQueryBuilderQuery)

Handles the query change, due to the interaction with the query builder.

Parameters :
Name Type Optional Description
query IQueryBuilderQuery No

The query that is changed.

Returns : void
onSelectedFilters
onSelectedFilters(filterAttributes: IFilterAttribute[])

The action that is to be performed in for the items.

Parameters :
Name Type Optional Description
filterAttributes IFilterAttribute[] No

The selected filter attributes.

Returns : void
onSortChange
onSortChange(sort: ISortAttributesInput[])

Handles the sort change.

Parameters :
Name Type Optional
sort ISortAttributesInput[] No
Returns : void
selectedAllAttributesEmitterHandler
selectedAllAttributesEmitterHandler(selectedAllAttributes: IAttributeItem[])

Emits the selected all attributes.

Parameters :
Name Type Optional Description
selectedAllAttributes IAttributeItem[] No

All selected attributes.

Returns : void
selectedDetailAttributesEmitterHandler
selectedDetailAttributesEmitterHandler(selectedDetailAttributes: IAttributeItem[])

Emits the selected detail attributes.

Parameters :
Name Type Optional Description
selectedDetailAttributes IAttributeItem[] No

The selected detail attributes.

Returns : void
selectedMainAttributesEmitterHandler
selectedMainAttributesEmitterHandler(selectedMainAttributes: IAttributeItem[])

Emits the selected main attributes.

Parameters :
Name Type Optional Description
selectedMainAttributes IAttributeItem[] No

The selected main attributes.

Returns : void
selectedTabChange
selectedTabChange(tabKey: string)

Change the selected tab.

Parameters :
Name Type Optional Description
tabKey string No

The selected tab.

Returns : void

Properties

availableFilterSelectionAttributes
Type : IAttributeItem[]
Default value : []

List of available attributes for the simple filter selection.

availableSortSelectionAttributes
Type : IAttributeItem[]
Default value : []

List of available attributes for the simple filter selection.

Optional closeButtonRef
Type : ButtonComponent
Decorators :
@ViewChild('closeButton', {static: false})

Reference to the close button element.

filterState
Type : unknown
Default value : inject(FilterStateService)
filterToolbarService
Type : unknown
Default value : inject(FilterToolbarService)

The used services and references.

inboxState
Type : unknown
Default value : inject(InboxState)
inboxToolbarService
Type : unknown
Default value : inject(InboxToolbarService)

Injected set inbox toolbar service.

keyboardService
Type : unknown
Default value : inject(KeyboardService)
lockedAttributes
Type : ILockedAttribute[]
Default value : []

List of attributes key which are used to lock the attributes in the attribute settings. Gets updated by the used attributes in the filter toolbar.

mainFacadeSetterService
Type : unknown
Default value : inject(MainFacadeSetterService)

Injected set inbox configuration service.

query
Type : IQueryBuilderQuery
Default value : { identifier: 'head', rules: [], condition: QueryBuilderCondition.And, hierarchyLevel: 1, }

The query that is currently selected.

tabBarItems
Type : IInboxTabBarItem[]
Default value : []

The tab bar items.

transformedFilterSelections
Type : unknown
Default value : computed(() => { return this.mainFacadeSetterService.transformQueryInterfaceIntoFilterAttribute(this.filterSelections()) || []; })

The transformed filter selections from the query to the used interface in the simple filter selection.

updatePresetsService
Type : unknown
Default value : inject(UpdatePresetsService)

results matching ""

    No results matching ""