smart-webcomponents-angular
Version:
[](https://jqwidgets.com/license/)
880 lines (879 loc) • 250 kB
JavaScript
import { Directive, Input, Output, EventEmitter } from '@angular/core';
import { BaseElement, Smart } from './smart.element';
import * as i0 from "@angular/core";
export { Smart } from './smart.element';
export class KanbanComponent extends BaseElement {
constructor(ref) {
super(ref);
this.eventHandlers = [];
/** @description This event is triggered when a task has been updated.
* @param event. The custom event. Custom event was created with: event.detail( oldValue, task, value)
* oldValue - The old data of the task
* task - The HTML element of the task whose data has been changed
* value - The new data of the task
*/
this.onChange = new EventEmitter();
/** @description This event is triggered when the edit/prompt dialog is closed.
* @param event. The custom event. */
this.onClose = new EventEmitter();
/** @description This event is triggered when the edit/prompt dialog is about to be closed. The closing operation can be canceled by calling event.preventDefault() in the event handler function.
* @param event. The custom event. */
this.onClosing = new EventEmitter();
/** @description This event is triggered when a column is added.
* @param event. The custom event. Custom event was created with: event.detail( label, dataField, collapsed)
* label - The column label.
* dataField - The column data field.
* collapsed - The column's collapsed state.
*/
this.onColumnAdd = new EventEmitter();
/** @description This event is triggered when a column is removed.
* @param event. The custom event. Custom event was created with: event.detail( label, dataField, collapsed)
* label - The column label.
* dataField - The column data field.
* collapsed - The column's collapsed state.
*/
this.onColumnRemove = new EventEmitter();
/** @description This event is triggered when a column is reordered.
* @param event. The custom event. Custom event was created with: event.detail( oldIndex, index, column)
* oldIndex - The column's old index.
* index - The column's new index.
* column - The column's data object with 'label', 'dataField' and 'collapsed' fields.
*/
this.onColumnReorder = new EventEmitter();
/** @description This event is triggered when a column is updated.
* @param event. The custom event. Custom event was created with: event.detail( oldValue, value, column)
* oldValue - The column's old label.
* value - The column's new label.
* column - The column's data object with 'label', 'dataField' and 'collapsed' fields.
*/
this.onColumnUpdate = new EventEmitter();
/** @description This event is triggered when a column header is clicked.
* @param event. The custom event. Custom event was created with: event.detail( label, dataField, collapsed)
* label - The column label.
* dataField - The column data field.
* collapsed - The column's collapsed state.
*/
this.onColumnClick = new EventEmitter();
/** @description This event is triggered when a column header is double clicked.
* @param event. The custom event. Custom event was created with: event.detail( label, dataField, collapsed)
* label - The column label.
* dataField - The column data field.
* collapsed - The column's collapsed state.
*/
this.onColumnDoubleClick = new EventEmitter();
/** @description This event is triggered when a column is shown by using the column's action menu or the Kanban's 'show' method.
* @param event. The custom event. Custom event was created with: event.detail( label, dataField)
* label - The column label.
* dataField - The column data field.
*/
this.onColumnShow = new EventEmitter();
/** @description This event is triggered when a column is hidden by using the column's action menu or the Kanban's 'hide' method.
* @param event. The custom event. Custom event was created with: event.detail( label, dataField)
* label - The column label.
* dataField - The column data field.
*/
this.onColumnHide = new EventEmitter();
/** @description This event is triggered when a column is collapsed by using the column's action menu or the Kanban's 'collapse' method.
* @param event. The custom event. Custom event was created with: event.detail( label, dataField)
* label - The column label.
* dataField - The column data field.
*/
this.onColumnCollapse = new EventEmitter();
/** @description This event is triggered when a column is expanded by using the column's action menu or the Kanban's 'expand' method.
* @param event. The custom event. Custom event was created with: event.detail( label, dataField)
* label - The column label.
* dataField - The column data field.
*/
this.onColumnExpand = new EventEmitter();
/** @description This event is triggered when a comment is added to the Kanban Task.
* @param event. The custom event. Custom event was created with: event.detail( id, value)
* id - The task's id.
* value - The comment object. It has 'text: string, time: Date and userId:number' properties.
*/
this.onCommentAdd = new EventEmitter();
/** @description This event is triggered when a comment is removed from the Kanban Task.
* @param event. The custom event. Custom event was created with: event.detail( id, value)
* id - The task's id.
* value - The comment object. It has 'text: string, time: Date and userId:number' properties.
*/
this.onCommentRemove = new EventEmitter();
/** @description This event is triggered when a comment is updated in the Kanban Task.
* @param event. The custom event. Custom event was created with: event.detail( id, value)
* id - The task's id.
* value - The comment object. It has 'text: string, time: Date and userId:number' properties.
*/
this.onCommentUpdate = new EventEmitter();
/** @description This event is triggered when a task is dropped somewhere in the DOM. The dragging operation can be canceled by calling event.preventDefault() in the event handler function.
* @param event. The custom event. Custom event was created with: event.detail( container, data, item, items, originalEvent, previousContainer, target)
* container - the Kanban the dragged task(s) is dropped to
* data - an object with additional drag details
* item - the task that is dragged; if multiple tasks are dragged, this is the task that has been clicked when initiating the drag operation
* items - an array with all dragged tasks
* originalEvent - the original, browser, event that initiates the drag operation
* previousContainer - the Kanban the dragged item(s) is dragged from
* target - the element the dragged tasks are dropped to
*/
this.onDragEnd = new EventEmitter();
/** @description This event is triggered when the user is dragging a task.
* @param event. The custom event. Custom event was created with: event.detail( data, item, items, originalEvent)
* data - an object with additional drag details
* item - the task that is dragged; if multiple tasks are dragged, this is the task that has been clicked when initiating the drag operation
* items - an array with all dragged tasks
* originalEvent - the original, browser, event that initiates the drag operation
*/
this.onDragging = new EventEmitter();
/** @description This event is triggered when the user starts dragging task(s). The dragging operation can be canceled by calling event.preventDefault() in the event handler function.
* @param event. The custom event. Custom event was created with: event.detail( container, data, item, items, originalEvent, previousContainer)
* container - the Kanban the dragged task(s) is dragged from
* data - an object with additional drag details
* item - the task that is dragged; if multiple tasks are dragged, this is the task that has been clicked when initiating the drag operation
* items - an array with all dragged tasks
* originalEvent - the original, browser, event that initiates the drag operation
* previousContainer - the Kanban the dragged item(s) is dragged from
*/
this.onDragStart = new EventEmitter();
/** @description This event is triggered when a filter has been applied.
* @param event. The custom event. */
this.onFilter = new EventEmitter();
/** @description This event is triggered when the edit/prompt dialog is opened.
* @param event. The custom event. */
this.onOpen = new EventEmitter();
/** @description This event is triggered when the edit/prompt dialog is about to be opened. The opening operation can be canceled by calling event.preventDefault() in the event handler function. If you want to cancel the default Kanban dialog, call event.preventDefault();
* @param event. The custom event. Custom event was created with: event.detail( comment, purpose, task)
* comment - The comment that is about to be removed (if applicable).
* purpose - The purpose of the dialog to be opened - <em>'edit'</em> or <em>'prompt'</em>.
* task - The task that is about to be edited or removed (if applicable).
*/
this.onOpening = new EventEmitter();
/** @description This event is triggered when sorting has been applied.
* @param event. The custom event. */
this.onSort = new EventEmitter();
/** @description This event is triggered before a new task is added. You can use the event.detail.value and event.detail.id to customize the new Task before adding it to the Kanban. Example: kanban.onTaskBeforeAdd = (event) => { const data = event.detail.value; const id = event.detail.id; event.detail.id = 'BG12';}
* @param event. The custom event. Custom event was created with: event.detail( value, id)
* value - The task data that is added to the Kanban.
* id - The task data id.
*/
this.onTaskBeforeAdd = new EventEmitter();
/** @description This event is triggered when a new task is added. Example: kanban.onTaskAdd = (event) => { const data = event.detail.value; const id = event.detail.id; }
* @param event. The custom event. Custom event was created with: event.detail( value, id)
* value - The task data that is added to the Kanban.
* id - The task data id.
*/
this.onTaskAdd = new EventEmitter();
/** @description This event is triggered when a task is removed.
* @param event. The custom event. Custom event was created with: event.detail( value, id)
* value - The task data that is removed from the Kanban.
* id - The task data id.
*/
this.onTaskRemove = new EventEmitter();
/** @description This event is triggered when a task is updated.
* @param event. The custom event. Custom event was created with: event.detail( value, oldValue, id)
* value - The task data that is updated.
* oldValue - The update task's old data.
* id - The task data id.
*/
this.onTaskUpdate = new EventEmitter();
/** @description This event is triggered when a task is clicked.
* @param event. The custom event. Custom event was created with: event.detail( value, id)
* value - The task data.
* id - The task data id.
*/
this.onTaskClick = new EventEmitter();
/** @description This event is triggered when a task is double clicked.
* @param event. The custom event. Custom event was created with: event.detail( value, id)
* value - The task data.
* id - The task data id.
*/
this.onTaskDoubleClick = new EventEmitter();
this.nativeElement = ref.nativeElement;
}
/** @description Creates the component on demand.
* @param properties An optional object of properties, which will be added to the template binded ones.
*/
createComponent(properties = {}) {
this.nativeElement = document.createElement('smart-kanban');
for (let propertyName in properties) {
this.nativeElement[propertyName] = properties[propertyName];
}
return this.nativeElement;
}
/** @description Enables or disables column reordering. When this property is set to true and allowDrag is enabled, users will be able to reoder columns through drag & drop. For example: Click and drag the first column's header and drop it over another column. */
get allowColumnReorder() {
return this.nativeElement ? this.nativeElement.allowColumnReorder : undefined;
}
set allowColumnReorder(value) {
this.nativeElement ? this.nativeElement.allowColumnReorder = value : undefined;
}
/** @description Enables or disables column editing. When this property is set to true, users will be able to dynamically change the column's header label by double clicking on it. */
get allowColumnEdit() {
return this.nativeElement ? this.nativeElement.allowColumnEdit : undefined;
}
set allowColumnEdit(value) {
this.nativeElement ? this.nativeElement.allowColumnEdit = value : undefined;
}
/** @description Enables or disables column removing. When this property is set to true, users will be able to dynamically remove a column through the column actions menu. the 'columnActions' property should be true. */
get allowColumnRemove() {
return this.nativeElement ? this.nativeElement.allowColumnRemove : undefined;
}
set allowColumnRemove(value) {
this.nativeElement ? this.nativeElement.allowColumnRemove = value : undefined;
}
/** @description Enables or disables column hiding. When this property is set to true, users will be able to dynamically hide a column through the column actions menu. the 'columnActions' property should be true. */
get allowColumnHide() {
return this.nativeElement ? this.nativeElement.allowColumnHide : undefined;
}
set allowColumnHide(value) {
this.nativeElement ? this.nativeElement.allowColumnHide = value : undefined;
}
/** @description Toggles the visibility of the column buttons for adding tasks. A particular button can be disabled by setting addNewButton in the column's definition to false. */
get addNewButton() {
return this.nativeElement ? this.nativeElement.addNewButton : undefined;
}
set addNewButton(value) {
this.nativeElement ? this.nativeElement.addNewButton = value : undefined;
}
/** @description Determines whether the add button is visible in the column header and/or after the tasks in the column. */
get addNewButtonDisplayMode() {
return this.nativeElement ? this.nativeElement.addNewButtonDisplayMode : undefined;
}
set addNewButtonDisplayMode(value) {
this.nativeElement ? this.nativeElement.addNewButtonDisplayMode = value : undefined;
}
/** @description Sets or gets whether a column with a button for adding new status columns to the Kanban will be displayed. */
get addNewColumn() {
return this.nativeElement ? this.nativeElement.addNewColumn : undefined;
}
set addNewColumn(value) {
this.nativeElement ? this.nativeElement.addNewColumn = value : undefined;
}
/** @description Sets the width of the add new column. The property is used, if the 'columnWidth' property is set, too. It specifies the width of the dynamic new column. */
get addNewColumnWidth() {
return this.nativeElement ? this.nativeElement.addNewColumnWidth : undefined;
}
set addNewColumnWidth(value) {
this.nativeElement ? this.nativeElement.addNewColumnWidth = value : undefined;
}
/** @description Allows the dragging of tasks. */
get allowDrag() {
return this.nativeElement ? this.nativeElement.allowDrag : undefined;
}
set allowDrag(value) {
this.nativeElement ? this.nativeElement.allowDrag = value : undefined;
}
/** @description Allows the dropping of tasks. */
get allowDrop() {
return this.nativeElement ? this.nativeElement.allowDrop : undefined;
}
set allowDrop(value) {
this.nativeElement ? this.nativeElement.allowDrop = value : undefined;
}
/** @description Allows the dropping of tasks placeholder. When you drag a task over another task it will make an empty space for the task. */
get allowDropPlaceholder() {
return this.nativeElement ? this.nativeElement.allowDropPlaceholder : undefined;
}
set allowDropPlaceholder(value) {
this.nativeElement ? this.nativeElement.allowDropPlaceholder = value : undefined;
}
/** @description This property changes the visual appeal of the Kanban columns and tasks. When set to true and the Kanban columns have their 'color' property set, the color is also applied to the tasks and edit dialog. */
get applyColumnColorToTasks() {
return this.nativeElement ? this.nativeElement.applyColumnColorToTasks : undefined;
}
set applyColumnColorToTasks(value) {
this.nativeElement ? this.nativeElement.applyColumnColorToTasks = value : undefined;
}
/** @description Enables or disables auto load state from the browser's localStorage. Information about tasks and their position and selected state, filtering, sorting, collapsed columns, as well as the values of the properties taskActions, taskComments, taskDue, taskPriority, taskProgress, taskTags, and taskUserIcon is loaded. */
get autoLoadState() {
return this.nativeElement ? this.nativeElement.autoLoadState : undefined;
}
set autoLoadState(value) {
this.nativeElement ? this.nativeElement.autoLoadState = value : undefined;
}
/** @description Enables or disables auto save state to the browser's localStorage. Information about tasks and their position and selected state, filtering, sorting, collapsed columns, as well as the values of the properties taskActions, taskComments, taskDue, taskPriority, taskProgress, taskTags, and taskUserIcon is saved. */
get autoSaveState() {
return this.nativeElement ? this.nativeElement.autoSaveState : undefined;
}
set autoSaveState(value) {
this.nativeElement ? this.nativeElement.autoSaveState = value : undefined;
}
/** @description Automatically updates the columns height depending on the tasks inside the column. The effect of this property is observed when 'columnColorEntireSurface' is true. */
get autoColumnHeight() {
return this.nativeElement ? this.nativeElement.autoColumnHeight : undefined;
}
set autoColumnHeight(value) {
this.nativeElement ? this.nativeElement.autoColumnHeight = value : undefined;
}
/** @description Allows collapsing the card content. */
get collapsible() {
return this.nativeElement ? this.nativeElement.collapsible : undefined;
}
set collapsible(value) {
this.nativeElement ? this.nativeElement.collapsible = value : undefined;
}
/** @description Displays colors in the column header, when the column's color property is set. */
get columnColors() {
return this.nativeElement ? this.nativeElement.columnColors : undefined;
}
set columnColors(value) {
this.nativeElement ? this.nativeElement.columnColors = value : undefined;
}
/** @description Sets the Kanban columns width. When this property is set, the kanban columns width is set and a horizontal scrollbar may appear. */
get columnWidth() {
return this.nativeElement ? this.nativeElement.columnWidth : undefined;
}
set columnWidth(value) {
this.nativeElement ? this.nativeElement.columnWidth = value : undefined;
}
/** @description Displays background in the Kanban column. */
get columnColorEntireSurface() {
return this.nativeElement ? this.nativeElement.columnColorEntireSurface : undefined;
}
set columnColorEntireSurface(value) {
this.nativeElement ? this.nativeElement.columnColorEntireSurface = value : undefined;
}
/** @description Displays a column footer which shows the summary of the column. */
get columnFooter() {
return this.nativeElement ? this.nativeElement.columnFooter : undefined;
}
set columnFooter(value) {
this.nativeElement ? this.nativeElement.columnFooter = value : undefined;
}
/** @description Describes the columns properties. */
get columns() {
return this.nativeElement ? this.nativeElement.columns : undefined;
}
set columns(value) {
this.nativeElement ? this.nativeElement.columns = value : undefined;
}
/** @description Toggles the visibility of the column actions icon. */
get columnActions() {
return this.nativeElement ? this.nativeElement.columnActions : undefined;
}
set columnActions(value) {
this.nativeElement ? this.nativeElement.columnActions = value : undefined;
}
/** @description Determines whether task count information is displayed in column headers. */
get columnSummary() {
return this.nativeElement ? this.nativeElement.columnSummary : undefined;
}
set columnSummary(value) {
this.nativeElement ? this.nativeElement.columnSummary = value : undefined;
}
/** @description Determines whether a column header has a template. You can pass 'string', 'function' or HTMLTemplateElement as a value. */
get columnHeaderTemplate() {
return this.nativeElement ? this.nativeElement.columnHeaderTemplate : undefined;
}
set columnHeaderTemplate(value) {
this.nativeElement ? this.nativeElement.columnHeaderTemplate = value : undefined;
}
/** @description Determines the column edit behavior. With the 'header' option, edit starts on double click on the column's label. In 'menu' mode, edit is allowed from the 'columnActions' menu. In 'headerAndMenu' option, column editing includes both options. */
get columnEditMode() {
return this.nativeElement ? this.nativeElement.columnEditMode : undefined;
}
set columnEditMode(value) {
this.nativeElement ? this.nativeElement.columnEditMode = value : undefined;
}
/** @description Sets or gets the id of the current user. Has to correspond to the id of an item from the users property/array. Depending on the current user, different privileges are enabled. If no current user is set, privileges depend on the element's properties. */
get currentUser() {
return this.nativeElement ? this.nativeElement.currentUser : undefined;
}
set currentUser(value) {
this.nativeElement ? this.nativeElement.currentUser = value : undefined;
}
/** @description Sets or gets whether the default dialog for adding/removing tasks or comments is disabled. */
get disableDialog() {
return this.nativeElement ? this.nativeElement.disableDialog : undefined;
}
set disableDialog(value) {
this.nativeElement ? this.nativeElement.disableDialog = value : undefined;
}
/** @description Sets or gets a customization function for the dialog. This function can be used to customize the dialog look or to replace it. The Kanban calls this function with 5 arguments - 'dialog', 'taskOrComment', 'editors', 'purpose' and 'type'. The dialog is the 'smart-window' instance used as a default Kanban dialog. 'taskOrComment' is object which could be Kanban task or comment. 'purpose' could be 'add' or 'edit' and 'type' could be 'task' or 'column' depending on the action. */
get dialogCustomizationFunction() {
return this.nativeElement ? this.nativeElement.dialogCustomizationFunction : undefined;
}
set dialogCustomizationFunction(value) {
this.nativeElement ? this.nativeElement.dialogCustomizationFunction = value : undefined;
}
/** @description Sets or gets a function called when the dialog is rendered. The Kanban calls this function with 6 arguments - 'dialog', 'editors', 'labels', 'tabs', 'layout', 'taskOrComment'. The dialog is the 'smart-window' instance used as a default Kanban dialog. 'taskOrComment' is object which could be Kanban task or comment. 'editors', 'labels', 'tabs' and 'layout' are JSON objects with key which describes the element type and value which is HTML Element. */
get dialogRendered() {
return this.nativeElement ? this.nativeElement.dialogRendered : undefined;
}
set dialogRendered(value) {
this.nativeElement ? this.nativeElement.dialogRendered = value : undefined;
}
/** @description Determines the data source to be visualized in the kanban board. */
get dataSource() {
return this.nativeElement ? this.nativeElement.dataSource : undefined;
}
set dataSource(value) {
this.nativeElement ? this.nativeElement.dataSource = value : undefined;
}
/** @description Determines the the relation (mapping) between the Kanban's default fields (keywords) and the data fields from the data source. Not necessary if both match. Only some of the default mapping can be overwritten. */
get dataSourceMap() {
return this.nativeElement ? this.nativeElement.dataSourceMap : undefined;
}
set dataSourceMap(value) {
this.nativeElement ? this.nativeElement.dataSourceMap = value : undefined;
}
/** @description Determines the offset of the drag feedback element from the mouse cursor when dragging tasks. The first member of the array is the horizontal offset and the second one - the vertical offset. If set to 'auto', the offset is based on the mouse position when the dragging started. */
get dragOffset() {
return this.nativeElement ? this.nativeElement.dragOffset : undefined;
}
set dragOffset(value) {
this.nativeElement ? this.nativeElement.dragOffset = value : undefined;
}
/** @description Sets or gets whether tasks can be edited (including the assigning of users to tasks). */
get editable() {
return this.nativeElement ? this.nativeElement.editable : undefined;
}
set editable(value) {
this.nativeElement ? this.nativeElement.editable = value : undefined;
}
/** @description Determines the edit behavior. It could be either singleClick or doubleClick. The dialog edit window is by default opened when user double clicks on a Kanban task. */
get editMode() {
return this.nativeElement ? this.nativeElement.editMode : undefined;
}
set editMode(value) {
this.nativeElement ? this.nativeElement.editMode = value : undefined;
}
/** @description Sets or gets the format string of the "Due date" label and the "Start date" and "Due date" editors. */
get formatStringDate() {
return this.nativeElement ? this.nativeElement.formatStringDate : undefined;
}
set formatStringDate(value) {
this.nativeElement ? this.nativeElement.formatStringDate = value : undefined;
}
/** @description Sets or gets the format string of comments time stamp. */
get formatStringTime() {
return this.nativeElement ? this.nativeElement.formatStringTime : undefined;
}
set formatStringTime(value) {
this.nativeElement ? this.nativeElement.formatStringTime = value : undefined;
}
/** @description Sets or gets the header position. The header contains the Customize, Filter, Sort, and Search buttons. */
get headerPosition() {
return this.nativeElement ? this.nativeElement.headerPosition : undefined;
}
set headerPosition(value) {
this.nativeElement ? this.nativeElement.headerPosition = value : undefined;
}
/** @description Sets or gets the way column hierarchy is represented. */
get hierarchy() {
return this.nativeElement ? this.nativeElement.hierarchy : undefined;
}
set hierarchy(value) {
this.nativeElement ? this.nativeElement.hierarchy = value : undefined;
}
/** @description Sets or gets the license which unlocks the product. */
get license() {
return this.nativeElement ? this.nativeElement.license : undefined;
}
set license(value) {
this.nativeElement ? this.nativeElement.license = value : undefined;
}
/** @description Sets or gets the locale. Used in conjunction with the property messages. */
get locale() {
return this.nativeElement ? this.nativeElement.locale : undefined;
}
set locale(value) {
this.nativeElement ? this.nativeElement.locale = value : undefined;
}
/** @description Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. */
get messages() {
return this.nativeElement ? this.nativeElement.messages : undefined;
}
set messages(value) {
this.nativeElement ? this.nativeElement.messages = value : undefined;
}
/** @description Callback function which can be used for customizing the tasks rendering. The Kanban calls it with 2 arguments - task html element and task data. */
get onTaskRender() {
return this.nativeElement ? this.nativeElement.onTaskRender : undefined;
}
set onTaskRender(value) {
this.nativeElement ? this.nativeElement.onTaskRender = value : undefined;
}
/** @description Callback function which can be used for customizing the filter items. The function is called with 1 argument - Array of items which will be displayed in the filter drop down. You can modify that array to remove or update items to filter by. */
get onFilterPrepare() {
return this.nativeElement ? this.nativeElement.onFilterPrepare : undefined;
}
set onFilterPrepare(value) {
this.nativeElement ? this.nativeElement.onFilterPrepare = value : undefined;
}
/** @description Callback function which can be used for customizing the sort items. The function is called with 1 argument - Array of items which will be displayed in the sort drop down. You can modify that array to remove or update items to sort by. */
get onSortPrepare() {
return this.nativeElement ? this.nativeElement.onSortPrepare : undefined;
}
set onSortPrepare(value) {
this.nativeElement ? this.nativeElement.onSortPrepare = value : undefined;
}
/** @description Callback function which can be used for customizing the column header rendering. The Kanban calls it with 3 arguments - column header html element and column data and column data field. */
get onColumnHeaderRender() {
return this.nativeElement ? this.nativeElement.onColumnHeaderRender : undefined;
}
set onColumnHeaderRender(value) {
this.nativeElement ? this.nativeElement.onColumnHeaderRender = value : undefined;
}
/** @description Callback function which can be used for customizing the column footer rendering. The Kanban calls it with 3 arguments - column header html element and column data and column data field. */
get onColumnFooterRender() {
return this.nativeElement ? this.nativeElement.onColumnFooterRender : undefined;
}
set onColumnFooterRender(value) {
this.nativeElement ? this.nativeElement.onColumnFooterRender = value : undefined;
}
/** @description Determines selection mode. */
get selectionMode() {
return this.nativeElement ? this.nativeElement.selectionMode : undefined;
}
set selectionMode(value) {
this.nativeElement ? this.nativeElement.selectionMode = value : undefined;
}
/** @description Sets or gets whether the tasks history will be stored and displayed in the task dialog. */
get storeHistory() {
return this.nativeElement ? this.nativeElement.storeHistory : undefined;
}
set storeHistory(value) {
this.nativeElement ? this.nativeElement.storeHistory = value : undefined;
}
/** @description Sets or gets the task history items that will be stored when storeHistory is enabled. */
get storeHistoryItems() {
return this.nativeElement ? this.nativeElement.storeHistoryItems : undefined;
}
set storeHistoryItems(value) {
this.nativeElement ? this.nativeElement.storeHistoryItems = value : undefined;
}
/** @description Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. */
get rightToLeft() {
return this.nativeElement ? this.nativeElement.rightToLeft : undefined;
}
set rightToLeft(value) {
this.nativeElement ? this.nativeElement.rightToLeft = value : undefined;
}
/** @description Sets or gets whether the edit dialog is displayed in readonly mode. In that mode it shows only the task details, but the editing is disabled. However, if comments are enabled, you will be able to add comments in the dialog. */
get readonly() {
return this.nativeElement ? this.nativeElement.readonly : undefined;
}
set readonly(value) {
this.nativeElement ? this.nativeElement.readonly = value : undefined;
}
/** @description Describes the swimlanes in the kanban board. Sub-columns are not applicable when swimlanes are present. */
get swimlanes() {
return this.nativeElement ? this.nativeElement.swimlanes : undefined;
}
set swimlanes(value) {
this.nativeElement ? this.nativeElement.swimlanes = value : undefined;
}
/** @description Sets or gets the index of the column at which to start the swimlanes. */
get swimlanesFrom() {
return this.nativeElement ? this.nativeElement.swimlanesFrom : undefined;
}
set swimlanesFrom(value) {
this.nativeElement ? this.nativeElement.swimlanesFrom = value : undefined;
}
/** @description Sets or gets the index of the column at which to end the swimlanes. By default, swimlanes end at the last column. */
get swimlanesTo() {
return this.nativeElement ? this.nativeElement.swimlanesTo : undefined;
}
set swimlanesTo(value) {
this.nativeElement ? this.nativeElement.swimlanesTo = value : undefined;
}
/** @description Sets or gets the allowed tags. If no tags are listed, all tags from the data source are allowed. */
get tags() {
return this.nativeElement ? this.nativeElement.tags : undefined;
}
set tags(value) {
this.nativeElement ? this.nativeElement.tags = value : undefined;
}
/** @description Toggles the visibility of the task actions icon. */
get taskActions() {
return this.nativeElement ? this.nativeElement.taskActions : undefined;
}
set taskActions(value) {
this.nativeElement ? this.nativeElement.taskActions = value : undefined;
}
/** @description Represents a callback function which is called when the task actions menu is created. The task actions element is passed as parameter and allows you to customize the menu. Example: (list) => { list.innerHTML = 'Custom Item'; list.onclick = () => { alert('clicked'); }} */
get taskActionsRendered() {
return this.nativeElement ? this.nativeElement.taskActionsRendered : undefined;
}
set taskActionsRendered(value) {
this.nativeElement ? this.nativeElement.taskActionsRendered = value : undefined;
}
/** @description Toggles the visibility of the task comments icon. */
get taskComments() {
return this.nativeElement ? this.nativeElement.taskComments : undefined;
}
set taskComments(value) {
this.nativeElement ? this.nativeElement.taskComments = value : undefined;
}
/** @description Toggles the visibility of the task due icon. */
get taskDue() {
return this.nativeElement ? this.nativeElement.taskDue : undefined;
}
set taskDue(value) {
this.nativeElement ? this.nativeElement.taskDue = value : undefined;
}
/** @description Sets or gets whether tasks can be shown in all levels of column hierarchy or only on leaf columns. */
get taskPosition() {
return this.nativeElement ? this.nativeElement.taskPosition : undefined;
}
set taskPosition(value) {
this.nativeElement ? this.nativeElement.taskPosition = value : undefined;
}
/** @description Toggles the visibility of the task priority icon (shown when priority is low or high). */
get taskPriority() {
return this.nativeElement ? this.nativeElement.taskPriority : undefined;
}
set taskPriority(value) {
this.nativeElement ? this.nativeElement.taskPriority = value : undefined;
}
/** @description Toggles the visibility of task progress bar and the completed sub-tasks label. */
get taskProgress() {
return this.nativeElement ? this.nativeElement.taskProgress : undefined;
}
set taskProgress(value) {
this.nativeElement ? this.nativeElement.taskProgress = value : undefined;
}
/** @description Sets the task custom fields displayed in the card. Each array item should have 'dataField', 'label' 'dataType' and optionally 'visible', 'image' and 'cover' properties. The 'dataField' determines the value, the label is displayed as title, 'dataType' is used for formatting and 'visible' determines whether the field will be displayed. If your string represents an image either URL or Base64, set image: true. If you want to display that image as a cover image, set cover:true, too. */
get taskCustomFields() {
return this.nativeElement ? this.nativeElement.taskCustomFields : undefined;
}
set taskCustomFields(value) {
this.nativeElement ? this.nativeElement.taskCustomFields = value : undefined;
}
/** @description The task's background color depends on the task's color property. By default the color is rendered within the task's left border. */
get taskColorEntireSurface() {
return this.nativeElement ? this.nativeElement.taskColorEntireSurface : undefined;
}
set taskColorEntireSurface(value) {
this.nativeElement ? this.nativeElement.taskColorEntireSurface = value : undefined;
}
/** @description Displays an input in the task's card for adding dynamically a sub task. The 'taskSubTasks' property should be set to a value different than 'none'. */
get taskSubTasksInput() {
return this.nativeElement ? this.nativeElement.taskSubTasksInput : undefined;
}
set taskSubTasksInput(value) {
this.nativeElement ? this.nativeElement.taskSubTasksInput = value : undefined;
}
/** @description Sets the rendering mode of sub tasks. 'none' - default value. Sub tasks are displayed only in the edit dialog. 'onePerRow' - all sub tasks are displayed in the task's card. 'onlyUnfinished' - only tasks which are not completed are displayed in the task's card. */
get taskSubTasks() {
return this.nativeElement ? this.nativeElement.taskSubTasks : undefined;
}
set taskSubTasks(value) {
this.nativeElement ? this.nativeElement.taskSubTasks = value : undefined;
}
/** @description Toggles the visibility of task tags. */
get taskTags() {
return this.nativeElement ? this.nativeElement.taskTags : undefined;
}
set taskTags(value) {
this.nativeElement ? this.nativeElement.taskTags = value : undefined;
}
/** @description Toggles the visibility of the task user icon. */
get taskUserIcon() {
return this.nativeElement ? this.nativeElement.taskUserIcon : undefined;
}
set taskUserIcon(value) {
this.nativeElement ? this.nativeElement.taskUserIcon = value : undefined;
}
/** @description Sets or gets a template to be applied to task text. Can be a string beginning with # and referencing the id of a template element on the page. Can also be a function that modifies the task text or the template itself. Finally, it can also be a string that will be parsed. */
get textTemplate() {
return this.nativeElement ? this.nativeElement.textTemplate : undefined;
}
set textTemplate(value) {
this.nativeElement ? this.nativeElement.textTemplate = value : undefined;
}
/** @description Determines the theme. Theme defines the look of the element */
get theme() {
return this.nativeElement ? this.nativeElement.theme : undefined;
}
set theme(value) {
this.nativeElement ? this.nativeElement.theme = value : undefined;
}
/** @description Determines whether the priority list (as defined by the priority property) will be shown when clicking the priority icon. Only applicable if editable privileges are enabled. */
get priorityList() {
return this.nativeElement ? this.nativeElement.priorityList : undefined;
}
set priorityList(value) {
this.nativeElement ? this.nativeElement.priorityList = value : undefined;
}
/** @description Determines the priority Kanban tasks can be assigned to. Example: [{label: 'low', value: 'low'}, {label: 'high', value: 'high'}] */
get priority() {
return this.nativeElement ? this.nativeElement.priority : undefined;
}
set priority(value) {
this.nativeElement ? this.nativeElement.priority = value : undefined;
}
/** @description Determines whether the user list (as defined by the users property) will be shown when clicking the user icon. Only applicable if editable privileges are enabled. */
get userList() {
return this.nativeElement ? this.nativeElement.userList : undefined;
}
set userList(value) {
this.nativeElement ? this.nativeElement.userList = value : undefined;
}
/** @description Determines the users Kanban tasks can be assigned to and their characteristics and privileges. */
get users() {
return this.nativeElement ? this.nativeElement.users : undefined;
}
set users(value) {
this.nativeElement ? this.nativeElement.users = value : undefined;
}
/** @description Adds filtering. Example: const filterGroup = new Smart.FilterGroup(); const filterObject = filterGroup.createFilter('string', 'Italy', 'contains'); filterGroup.addFilter('and', filterObject); kanban.addFilter([['Country', filterGroup]]);
* @param {any} filters. Filter information. Example: kanban.addFilter([['Country', filterGroup]]);. Each array item is a sub array with two items - 'dataField' and 'filterGroup' object. The 'dataField' is any valid data field from the data source bound to the Kanban like 'dueDate', 'startDate' or custom fields like 'Country'. Filter conditions which you can use in the expressions: '=', 'EQUAL','<>', 'NOT_EQUAL', '!=', '<', 'LESS_THAN','>', 'GREATER_THAN', '<=', 'LESS_THAN_OR_EQUAL', '>=', 'GREATER_THAN_OR_EQUAL','starts with', 'STARTS_WITH','ends with', 'ENDS_WITH', '', 'EMPTY', 'CONTAINS','DOES_NOT_CONTAIN', 'NULL','NOT_NULL'
* @param {string} operator?. Logical operator between the filters of different fields. Possible values are: 'and', 'or'.
*/
addFilter(filters, operator) {
if (this.nativeElement.isRendered) {
this.nativeElement.addFilter(filters, operator);
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.addFilter(filters, operator);
});
}
}
/** @description Adds sorting. Example: kanban.addSort(['Country'], 'ascending');
* @param {[] | string} dataFields. The data field(s) to sort by
* @param {[] | string} orderBy. The sort direction(s) to sort the data field(s) by. Possible values are: 'ascending' and 'descending'.
*/
addSort(dataFields, orderBy) {
if (this.nativeElement.isRendered) {
this.nativeElement.addSort(dataFields, orderBy);
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.addSort(dataFields, orderBy);
});
}
}
/** @description Adds a task to a Kanban column. If no data is specified, an empty task is added to the first column.
* @param {any} data?. An object containing the new task's data
*/
addTask(data) {
if (this.nativeElement.isRendered) {
this.nativeElement.addTask(data);
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.addTask(data);
});
}
}
/** @description Adds a column to a Kanban. If no data is specified, an empty column is added.
* @param {any} data?. An object containing the new column's data
*/
addColumn(data) {
if (this.nativeElement.isRendered) {
this.nativeElement.addColumn(data);
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.addColumn(data);
});
}
}
/** @description Begins an edit operation
* @param {number | string | HTMLElement} task. The task's id or corresponding HTMLElement
*/
beginEdit(task) {
if (this.nativeElement.isRendered) {
this.nativeElement.beginEdit(task);
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.beginEdit(task);
});
}
}
/** @description Ends the current edit operation and discards changes
*/
cancelEdit() {
if (this.nativeElement.isRendered) {
this.nativeElement.cancelEdit();
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.cancelEdit();
});
}
}
/** @description Closes any open header panel (drop down)
*/
closePanel() {
if (this.nativeElement.isRendered) {
this.nativeElement.closePanel();
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.closePanel();
});
}
}
/** @description Collapses a Kanban column.
* @param {number | string} column. The index or dataField of the column to collapse
*/
collapse(column) {
if (this.nativeElement.isRendered) {
this.nativeElement.collapse(column);
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.collapse(column);
});
}
}
/** @description Clears the Kanban's selection.
*/
clearSelection() {
if (this.nativeElement.isRendered) {
this.nativeElement.clearSelection();
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.clearSelection();
});
}
}
/** @description Hides a Kanban column.
* @param {number | string} column. The index or dataField of the column to hide
*/
hide(column) {
if (this.nativeElement.isRendered) {
this.nativeElement.hide(column);
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.hide(column);
});
}
}
/** @description Creates a copy of a task in the same column.
* @param {number | string | HTMLElement} task. The task's id or corresponding HTMLElement
*/
copyTask(task) {
if (this.nativeElement.isRendered) {
this.nativeElement.copyTask(task);
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.copyTask(task);
});
}
}
/** @description Ends the current edit operation and saves changes
*/
endEdit() {
if (this.nativeElement.isRendered) {
this.nativeElement.endEdit();
}
else {
this.nativeElement.whenRendered(() => {
this.nativeElement.endEdit();
});
}
}
/** @description Makes sure a task is visible by scrolling to it. If succcessful, the method returns the HTML element of the task.
* @param {number | string | HTMLElement} task. The task's id or corresponding HTMLElement
* @returns {HTMLElement}
*/
async ensureVisible(task) {
const getResultOnRender = () => {
return new Promise(resolve => {
this.nativeElement.whenRendered(() => {