Skip to content

SiColumnSelectionDialogService documentation

provided in root
✓

Attributes and Methods

NameTypeDefaultDescription
showColumnSelectionDialog(...)
(dialogConfig: SiColumnSelectionDialogConfig, diOptions: ModalDependencyInjectionOptions) => Observable<ColumnSelectionDialogResult>Opens a column selection dialog.

Despite other dialogs, this dialog informs the consumer not ONLY with clicking submit or cancel , but also with changing the place or visibility of a dialog row thanks to the instant type of emitted event.

Parameters

Types Documentation

Properties
columns: Column[]
type: ColumnSelectionDialogResultType
when type === 'restoreDefault' , this function is set and allows to provide the columns
updateColumns?: (columns: Column[]) => void
Properties
a11yItemMovedMessage?: TranslatableString
a11yItemNotMovedMessage?: TranslatableString
bodyTitle: TranslatableString
cancelBtnName?: TranslatableString
columns: Column[]
columnVisibilityConfigurable?: boolean
heading: TranslatableString
hiddenText?: TranslatableString
listAriaLabel?: TranslatableString
renameInputAriaLabel?: TranslatableString
restoreEnabled?: boolean
restoreToDefaultBtnName?: TranslatableString
submitBtnName?: TranslatableString
translationParams?: { [ key: string ]: any } }
visibleText?: TranslatableString
Properties
Optional environment Injector.
environmentInjector?: EnvironmentInjector
Optional element Injector.
injector?: Injector
Additional providers for the modal.
providers?: StaticProvider[]
Properties
If true, the column is disabled and cannot be interacted with. This means, the user cannot change any of the column options like the visibility etc.
disabled: boolean
If true, the order of the column can be changed by dragging it to another position.
draggable: boolean
If true, the title can be renamed.
editable?: boolean
Unique id
id: string
Title of the column.
title: string
Decides if the column is visible to the user.
visible: boolean
("ok" | "cancel" | "instant" | "restoreDefault")
Emit type of dialog actions.

ok : Emitted when user submits. cancel : Emitted when user clicks cancel. instant : Emitted when visibility or place of a row changes.

instant type is used to reflect the ui changes real time even before closing the dialog.
(string & Translatable)
Represents a translatable string. This can either be a translation key, e.g. ACTIONS.EDIT that will be automatically translated when displayed on the UI or a pre-translated string, e.g. Edit . Equivalent to a normal string in usage and functionality.
Translatable
import

Except where otherwise noted, content on this site is licensed under MIT License.