smart-webcomponents-angular

import {BaseElement, Animation} from "./smart.element" export interface KanbanProperties { /** * 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. * Default value: false */ allowColumnReorder?: boolean; /** * 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. * Default value: false */ allowColumnEdit?: boolean; /** * 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. * Default value: false */ allowColumnRemove?: boolean; /** * 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. * Default value: false */ allowColumnHide?: boolean; /** * 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. * Default value: false */ addNewButton?: boolean; /** * Determines whether the add button is visible in the column header and/or after the tasks in the column. * Default value: both */ addNewButtonDisplayMode?: KanbanAddNewButtonDisplayMode | string; /** * Sets or gets whether a column with a button for adding new status columns to the Kanban will be displayed. * Default value: false */ addNewColumn?: boolean; /** * 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. * Default value: null */ addNewColumnWidth?: number | null; /** * Allows the dragging of tasks. * Default value: true */ allowDrag?: boolean; /** * Allows the dropping of tasks. * Default value: true */ allowDrop?: boolean; /** * Allows the dropping of tasks placeholder. When you drag a task over another task it will make an empty space for the task. * Default value: false */ allowDropPlaceholder?: boolean; /** * 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. * Default value: false */ applyColumnColorToTasks?: boolean; /** * 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. * Default value: true */ autoLoadState?: boolean; /** * 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. * Default value: false */ autoSaveState?: boolean; /** * Automatically updates the columns height depending on the tasks inside the column. The effect of this property is observed when 'columnColorEntireSurface' is true. * Default value: false */ autoColumnHeight?: boolean; /** * Allows collapsing the card content. * Default value: false */ collapsible?: boolean; /** * Displays colors in the column header, when the column's color property is set. * Default value: false */ columnColors?: boolean; /** * Sets the Kanban columns width. When this property is set, the kanban columns width is set and a horizontal scrollbar may appear. * Default value: null */ columnWidth?: number | null; /** * Displays background in the Kanban column. * Default value: false */ columnColorEntireSurface?: boolean; /** * Displays a column footer which shows the summary of the column. * Default value: false */ columnFooter?: boolean; /** * Describes the columns properties. * Default value: */ columns?: KanbanColumn[]; /** * Toggles the visibility of the column actions icon. * Default value: false */ columnActions?: boolean; /** * Determines whether task count information is displayed in column headers. * Default value: false */ columnSummary?: boolean; /** * Determines whether a column header has a template. You can pass 'string', 'function' or HTMLTemplateElement as a value. * Default value: null */ columnHeaderTemplate?: any; /** * 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. * Default value: headerAndMenu */ columnEditMode?: KanbanColumnEditMode | string; /** * 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. * Default value: */ currentUser?: string | number; /** * Sets or gets whether the default dialog for adding/removing tasks or comments is disabled. * Default value: false */ disableDialog?: boolean; /** * 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. * Default value: null */ dialogCustomizationFunction?: any; /** * 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. * Default value: null */ dialogRendered?: any; /** * Determines the data source to be visualized in the kanban board. * Default value: null */ dataSource?: KanbanDataSource[]; /** * 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. * Default value: { checklist: 'checklist', color: 'color', comments: 'comments', dueDate: 'dueDate', id: 'id', priority: 'priority', progress: 'progress', startDate: 'startDate', status: 'status', swimlane: 'swimlane', tags: 'tags', text: 'text', userId: 'userId'. createdUserId: 'createdUserId', createdDate: 'createdDate', updatedUserId: 'updatedUserId', updatedDate: 'updatedDate' } */ dataSourceMap?: { checklist: string; color: string; comments: string; dueDate: string; id: string; priority: string; progress: string; startDate: string; status: string; swimlane: string; tags: string; text: string; userId: string; createdUserId: string; upDatedUserId: string; createdDate: Date; upDatedDate: Date;}; /** * 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. * Default value: auto */ dragOffset?: boolean; /** * Sets or gets whether tasks can be edited (including the assigning of users to tasks). * Default value: false */ editable?: boolean; /** * 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. * Default value: doubleClick */ editMode?: KanbanEditMode | string; /** * Sets or gets the format string of the "Due date" label and the "Start date" and "Due date" editors. * Default value: "d" */ formatStringDate?: string; /** * Sets or gets the format string of comments time stamp. * Default value: "MMM d, HH:mm" */ formatStringTime?: string; /** * Sets or gets the header position. The header contains the Customize, Filter, Sort, and Search buttons. * Default value: none */ headerPosition?: KanbanHeaderPosition | string; /** * Sets or gets the way column hierarchy is represented. * Default value: columns */ hierarchy?: KanbanHierarchy | string; /** * Sets or gets the license which unlocks the product. * Default value: "" */ license?: string; /** * Sets or gets the locale. Used in conjunction with the property messages. * Default value: "en" */ locale?: string; /** * Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. * Default value: * { 'en': { 'addFilter': '+ Add filter', 'and': 'And', 'apply': 'Apply', 'booleanFirst': '☐', 'booleanLast': '☑', 'cancel': 'Cancel', 'CONTAINS': 'contains', 'CONTAINS_CASE_SENSITIVE': 'contains (case sensitive)', 'dateFirst': '1', 'dateLast': '9', 'DOES_NOT_CONTAIN': 'does not contain', 'DOES_NOT_CONTAIN_CASE_SENSITIVE': 'does not contain (case sensitive)', 'EMPTY': 'empty', 'ENDS_WITH': 'ends with', 'ENDS_WITH_CASE_SENSITIVE': 'ends with (case sensitive)', 'EQUAL': 'equal', 'EQUAL_CASE_SENSITIVE': 'equal (case sensitive)', 'filter': 'Filter', 'filteredByMultiple': '%', 'removeComment': 'Remove comment', 'promptColumn': 'Are you sure you want to remove this column?'} } */ messages?: any; /** * Callback function which can be used for customizing the tasks rendering. The Kanban calls it with 2 arguments - task html element and task data. * Default value: null */ onTaskRender?: any; /** * 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. * Default value: null */ onFilterPrepare?: any; /** * 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. * Default value: null */ onSortPrepare?: any; /** * 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. * Default value: null */ onColumnHeaderRender?: any; /** * 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. * Default value: null */ onColumnFooterRender?: any; /** * Determines selection mode. * Default value: zeroOrOne */ selectionMode?: KanbanSelectionMode | string; /** * Sets or gets whether the tasks history will be stored and displayed in the task dialog. * Default value: false */ storeHistory?: boolean; /** * Sets or gets the task history items that will be stored when storeHistory is enabled. * Default value: 20 */ storeHistoryItems?: number; /** * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. * Default value: false */ rightToLeft?: boolean; /** * 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. * Default value: false */ readonly?: boolean; /** * Describes the swimlanes in the kanban board. Sub-columns are not applicable when swimlanes are present. * Default value: */ swimlanes?: KanbanSwimlane[]; /** * Sets or gets the index of the column at which to start the swimlanes. * Default value: 0 */ swimlanesFrom?: number; /** * Sets or gets the index of the column at which to end the swimlanes. By default, swimlanes end at the last column. * Default value: null */ swimlanesTo?: number; /** * Sets or gets the allowed tags. If no tags are listed, all tags from the data source are allowed. * Default value: */ tags?: any[]; /** * Toggles the visibility of the task actions icon. * Default value: false */ taskActions?: boolean; /** * 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'); }} * Default value: null */ taskActionsRendered?: any; /** * Toggles the visibility of the task comments icon. * Default value: false */ taskComments?: boolean; /** * Toggles the visibility of the task due icon. * Default value: false */ taskDue?: boolean; /** * Sets or gets whether tasks can be shown in all levels of column hierarchy or only on leaf columns. * Default value: false */ taskPosition?: KanbanTaskPosition | string; /** * Toggles the visibility of the task priority icon (shown when priority is low or high). * Default value: true */ taskPriority?: boolean; /** * Toggles the visibility of task progress bar and the completed sub-tasks label. * Default value: false */ taskProgress?: boolean; /** * 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. * Default value: */ taskCustomFields?: any; /** * The task's background color depends on the task's color property. By default the color is rendered within the task's left border. * Default value: false */ taskColorEntireSurface?: boolean; /** * 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'. * Default value: true */ taskSubTasksInput?: boolean; /** * 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. * Default value: none */ taskSubTasks?: KanbanTaskSubTasks | string; /** * Toggles the visibility of task tags. * Default value: true */ taskTags?: boolean; /** * Toggles the visibility of the task user icon. * Default value: true */ taskUserIcon?: boolean; /** * 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. * Default value: null */ textTemplate?: any; /** * Determines the theme. Theme defines the look of the element * Default value: "" */ theme?: string; /** * 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. * Default value: false */ priorityList?: boolean; /** * Determines the priority Kanban tasks can be assigned to. Example: [{label: 'low', value: 'low'}, {label: 'high', value: 'high'}] * Default value: */ priority?: KanbanPriority[]; /** * 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. * Default value: false */ userList?: boolean; /** * Determines the users Kanban tasks can be assigned to and their characteristics and privileges. * Default value: */ users?: KanbanUser[]; } /** Kanban represents a kanban board that visually depicts work at various stages of a process using cards to represent tasks and columns to represent each stage of the process. */ export interface Kanban extends BaseElement, KanbanProperties { /* Get a member by its name */ [name: string]: any; /** * This event is triggered when a task has been updated. * @param event. The custom event. Custom data event was created with: ev.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 */ onChange: ((this: any, ev: Event) => any) | null; /** * This event is triggered when the edit/prompt dialog is closed. * @param event. The custom event. */ onClose: ((this: any, ev: Event) => any) | null; /** * 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. */ onClosing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a column is added. * @param event. The custom event. Custom data event was created with: ev.detail(label, dataField, collapsed) * label - The column label. * dataField - The column data field. * collapsed - The column's collapsed state. */ onColumnAdd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a column is removed. * @param event. The custom event. Custom data event was created with: ev.detail(label, dataField, collapsed) * label - The column label. * dataField - The column data field. * collapsed - The column's collapsed state. */ onColumnRemove?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a column is reordered. * @param event. The custom event. Custom data event was created with: ev.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. */ onColumnReorder?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a column is updated. * @param event. The custom event. Custom data event was created with: ev.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. */ onColumnUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a column header is clicked. * @param event. The custom event. Custom data event was created with: ev.detail(label, dataField, collapsed) * label - The column label. * dataField - The column data field. * collapsed - The column's collapsed state. */ onColumnClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a column header is double clicked. * @param event. The custom event. Custom data event was created with: ev.detail(label, dataField, collapsed) * label - The column label. * dataField - The column data field. * collapsed - The column's collapsed state. */ onColumnDoubleClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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 data event was created with: ev.detail(label, dataField) * label - The column label. * dataField - The column data field. */ onColumnShow?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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 data event was created with: ev.detail(label, dataField) * label - The column label. * dataField - The column data field. */ onColumnHide?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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 data event was created with: ev.detail(label, dataField) * label - The column label. * dataField - The column data field. */ onColumnCollapse?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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 data event was created with: ev.detail(label, dataField) * label - The column label. * dataField - The column data field. */ onColumnExpand?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a comment is added to the Kanban Task. * @param event. The custom event. Custom data event was created with: ev.detail(id, value) * id - The task's id. * value - The comment object. It has 'text: string, time: Date and userId:number' properties. */ onCommentAdd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a comment is removed from the Kanban Task. * @param event. The custom event. Custom data event was created with: ev.detail(id, value) * id - The task's id. * value - The comment object. It has 'text: string, time: Date and userId:number' properties. */ onCommentRemove?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a comment is updated in the Kanban Task. * @param event. The custom event. Custom data event was created with: ev.detail(id, value) * id - The task's id. * value - The comment object. It has 'text: string, time: Date and userId:number' properties. */ onCommentUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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 data event was created with: ev.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 */ onDragEnd: ((this: any, ev: Event) => any) | null; /** * This event is triggered when the user is dragging a task. * @param event. The custom event. Custom data event was created with: ev.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 */ onDragging?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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 data event was created with: ev.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 */ onDragStart: ((this: any, ev: Event) => any) | null; /** * This event is triggered when a filter has been applied. * @param event. The custom event. */ onFilter?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the edit/prompt dialog is opened. * @param event. The custom event. */ onOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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 data event was created with: ev.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). */ onOpening?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when sorting has been applied. * @param event. The custom event. */ onSort?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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 data event was created with: ev.detail(value, id) * value - The task data that is added to the Kanban. * id - The task data id. */ onTaskBeforeAdd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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 data event was created with: ev.detail(value, id) * value - The task data that is added to the Kanban. * id - The task data id. */ onTaskAdd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a task is removed. * @param event. The custom event. Custom data event was created with: ev.detail(value, id) * value - The task data that is removed from the Kanban. * id - The task data id. */ onTaskRemove?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a task is updated. * @param event. The custom event. Custom data event was created with: ev.detail(value, oldValue, id) * value - The task data that is updated. * oldValue - The update task's old data. * id - The task data id. */ onTaskUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a task is clicked. * @param event. The custom event. Custom data event was created with: ev.detail(value, id) * value - The task data. * id - The task data id. */ onTaskClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a task is double clicked. * @param event. The custom event. Custom data event was created with: ev.detail(value, id) * value - The task data. * id - The task data id. */ onTaskDoubleClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * 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: any, operator?: string): void; /** * 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: [] | string, orderBy: [] | string): void; /** * 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?: any): void; /** * 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?: any): void; /** * Begins an edit operation * @param {number | string | HTMLElement} task. The task's id or corresponding HTMLElement */ beginEdit(task: number | string | HTMLElement): void; /** * Ends the current edit operation and discards changes */ cancelEdit(): void; /** * Closes any open header panel (drop down) */ closePanel(): void; /** * Collapses a Kanban column. * @param {number | string} column. The index or dataField of the column to collapse */ collapse(column: number | string): void; /** * Clears the Kanban's selection. */ clearSelection(): void; /** * Hides a Kanban column. * @param {number | string} column. The index or dataField of the column to hide */ hide(column: number | string): void; /** * Creates a copy of a task in the same column. * @param {number | string | HTMLElement} task. The task's id or corresponding HTMLElement */ copyTask(task: number | string | HTMLElement): void; /** * Ends the current edit operation and saves changes */ endEdit(): void; /** * 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} */ ensureVisible(task: number | string | HTMLElement): HTMLElement; /** * Expands a Kanban column. * @param {number | string} column. The index or dataField of the column to expand */ expand(column: number | string): void; /** * Expands all Kanban columns. */ expandAll(): void; /** * Exports the Kanban's data. * @param {string} dataFormat. The file format to export to. Supported formats: 'csv', 'html', 'json', 'pdf', 'tsv', 'xlsx', 'xml'. * @param {string} fileName. The name of the file to export to * @param {Function} callback?. A callback function to pass the exported data to (if fileName is not provided) * @returns {any} */ exportData(dataFormat: string, fileName: string, callback?: Function): any; /** * Gets the data of a column. The returned value is a JSON object with the following fields: 'label', 'dataField', 'collapsed', 'collapsible', 'allowRemove', 'editable', 'reorder', 'orientation'. * @param {string} dataField. The column's data field * @returns {any} */ getColumn(dataField: string): any; /** * Gets the data of a task. The returned value is a JSON object with the following fields: 'checklist', 'id', 'color', 'comments', 'history', 'dueDate', 'startDate', 'priority', 'progress', 'status', 'swimlane', 'tags', 'text', 'description', 'userId', 'createdUserId', 'createdDate', 'updatedUserId', 'updatedDate' * @param {number} id. The task's id * @returns {any} */ getTask(id: number): any; /** * Gets the selected ids. The returned value is an array. Each item in the array is the 'id' of a selected task. * @param {number} id. The task's id * @returns {any} */ getSelectedTasks(id: number): any; /** * Gets the Kanban's state. Returns an object with the following type: { collapsed: {}, dataSource: [], filtering: { filters: [], operator: string }, selection: { selected: [], selectionStart?: number | string, selectionInColumn: string, swimlane: string }, sorting: { dataFields: [], dataTypes: [], orderBy: [] }, tabs: [], visibility: { taskActions: boolean, taskComments: boolean, taskDue: boolean, taskPriority: boolean, taskProgress: boolean, taskTags: boolean, taskUserIcon: boolean } } * @returns {any} */ getState(): any; /** * Loads the Kanban's state. * @param state?. An object returned by one of the methods getState or saveState. If not passed, gets saved state from the browser's localStorage. */ loadState(state?: { collapsed: {}, dataSource: [], filtering: { filters: [], operator: string }, selection: { selected: [], selectionStart?: number | string, selectionInColumn: string, swimlane: string }, sorting: { dataFields: [], dataTypes: [], orderBy: [] }, tabs: [], visibility: { taskActions: boolean, taskComments: boolean, taskDue: boolean, taskPriority: boolean, taskProgress: boolean, taskTags: boolean, taskUserIcon: boolean } }): void; /** * Moves a task to a different column. * @param {number | string | HTMLElement} task. The task's id or corresponding HTMLElement * @param {string} newStatus. The new status of the task (its new column's dataField) */ moveTask(task: number | string | HTMLElement, newStatus: string): void; /** * Opens the "Customize tasks" header panel (drop down) */ openCustomizePanel(): void; /** * Opens the "Filter" header panel (drop down) */ openFilterPanel(): void; /** * Opens the "Sort" header panel (drop down) */ openSortPanel(): void; /** * Removes filtering */ removeFilter(): void; /** * Removes sorting */ removeSort(): void; /** * Removes a task. * @param {number | string | HTMLElement} task. The task's id or corresponding HTMLElement * @param {boolean} prompt?. Whether or not to prompt the user before removing the task */ removeTask(task: number | string | HTMLElement, prompt?: boolean): void; /** * Removes a column. * @param {string} dataField. The column's data field */ removeColumn(dataField: string): void; /** * Saves the Kanban's state to the browser's localStorage. */ saveState(): void; /** * Shows a Kanban column. * @param {number | string} column. The index or dataField of the column to show */ show(column: number | string): void; /** * Shows all Kanban columns. */ showAllColumns(): void; /** * Selects a task. * @param {number | string} task. The task's id. */ selectTask(task: number | string): void; /** * Unselects a task. * @param {number | string} task. The task's id. */ unselectTask(task: number | string): void; /** * Updates a task. * @param {number | string | HTMLElement} task. The task's id or corresponding HTMLElement * @param {{}} newData. The new data to visualize in the task. */ updateTask(task: number | string | HTMLElement, newData: {}): void; /** * Updates a column. * @param {string} dataField. The new column's data field * @param {{}} newData. The new data to visualize in the column. */ updateColumn(dataField: string, newData: {}): void; } export interface KanbanColumn { /** * Sets or gets whether the column's button for adding tasks is visible. Works in conjunction with the Kanban property of the same name. * Default value: true */ addNewButton?: boolean; /** * Sets or gets whether the column can be removed from the column menu. * Default value: true */ allowRemove?: boolean; /** * Sets or gets whether the column is collapsed. * Default value: false */ collapsed?: boolean; /** * Sets or gets whether the column is collapsible. Works in conjunction with the Kanban property of the same name. * Default value: true */ collapsible?: boolean; /** * Sets or gets the column's sub-columns. Sub-columns has the same properties as top-level columns. * Default value: null */ columns?: { addNewButton: boolean, collapsed: string, collapsible: string, columns: [], dataField: string, label: string, orientation: string, selected: string }[]; /** * Sets or gets the column's data source bound field. Corresponds to the status field in the data source. * Default value: "" */ dataField?: string; /** * Sets or gets the text displayed in the column's header. * Default value: "" */ label?: string; /** * Sets or gets whether a column is editable. * Default value: true */ editable?: boolean; /** * Sets or gets whether a column is visible. * Default value: true */ visible?: boolean; /** * Sets or gets whether a column can be reordered. * Default value: true */ reorder?: boolean; /** * Sets or gets whether the tasks in the column flow vertically or horizontally. * Default value: vertical */ orientation?: KanbanColumnOrientation | string; /** * Sets or gets whether the column is selected. Only applicable to sub-columns when hierarchy is 'tabs'. * Default value: false */ selected?: boolean; /** * Determines whether a column header has a template. You can pass 'string', 'function' or HTMLTemplateElement as a value. * Default value: null */ headerTemplate?: any; /** * Sets the Kanban column width. When this property is set, the kanban column width is set and a horizontal scrollbar may appear. * Default value: null */ width?: number | null; } export interface KanbanDataSource { /** * The task's unique ID. * Default value: */ id?: string | number; /** * A list of sub-tasks. * Default value: null */ checklist?: { completed: boolean, text: string }[]; /** * A color used to highlight the task's card visually. * Default value: "null" */ color?: string; /** * Comments about a task. * Default value: null */ comments?: { text: string, time: Date, userId: string | number }[]; /** * The task's due date. * Default value: null */ dueDate?: Date; /** * The task's priority. * Default value: "normal" */ priority?: string; /** * The task's progress in percentages - a number from 0 to 100. * Default value: null */ progress?: number; /** * The task's start date. * Default value: null */ startDate?: Date; /** * The task's status. Has to correspond to the dataField of a column or sub-column from the columns property/array. * Default value: "" */ status?: string; /** * The swimlane of the task. Has to correspond to the dataField of a swimlane from the swimlanes property/array, if it is defined. * Default value: "null" */ swimlane?: string; /** * A comma-separated list of tags. * Default value: "" */ tags?: string; /** * The text of the task. * Default value: "" */ text?: string; /** * The ID of the user assigned to the task. Has to correspond to the id of an item from the users property/array. * Default value: null */ userId?: string | number; } export interface KanbanSwimlane { /** * The swimlane's color. * Default value: "null" */ color?: string; /** * Sets or gets the swimlane's data source bound field. Corresponds to the swimlane field in the data source. * Default value: "" */ dataField?: string; /** * Sets or gets the text displayed in the swimlane. * Default value: "" */ label?: string; } export interface KanbanPriority { /** * The priority label displayed. * Default value: "" */ label?: string; /** * The priority value. * Default value: "" */ value?: string; } export interface KanbanUser { /** * Sets whether the user has a privilege to add or copy tasks. * Default value: true */ allowAdd?: boolean; /** * Sets whether the user has a privilege to add comments to tasks. * Default value: true */ allowComment?: boolean; /** * Sets whether the user has a privilege to drag tasks. Works along with the property allowDrag. * Default value: true */ allowDrag?: boolean; /** * Sets whether the user has a privilege to edit tasks. Works along with the property editable. * Default value: true */ allowEdit?: boolean; /** * Sets whether the user has a privilege to remove tasks. * Default value: true */ allowRemove?: boolean; /** * The user's unique ID. Corresponds to the userId field in the data source and the property currentUser. * Default value: null */ id?: string | number; /** * A url to an image representing the user. * Default value: "" */ image?: string; /** * The user's name as it will appear in the Users list and "Assigned to" editor. * Default value: "" */ name?: string; } declare global { interface Document { createElement(tagName: "smart-kanban"): Kanban; querySelector(selectors: "smart-kanban"): Kanban | null; querySelectorAll(selectors: "smart-kanban"): NodeListOf<Kanban>; getElementsByTagName(qualifiedName: "smart-kanban"): HTMLCollectionOf<Kanban>; getElementsByName(elementName: "smart-kanban"): NodeListOf<Kanban>; } } /**Determines whether the add button is visible in the column header and/or after the tasks in the column. */ export declare type KanbanAddNewButtonDisplayMode = 'top' | 'bottom' | 'both'; /**Sets or gets whether the tasks in the column flow vertically or horizontally. */ export declare type KanbanColumnOrientation = 'vertical' | 'horizontal'; /**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. */ export declare type KanbanColumnEditMode = 'header' | 'menu' | 'headerAndMenu'; /**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. */ export declare type KanbanEditMode = 'doubleClick' | 'singleClick'; /**Sets or gets the header position. The header contains the Customize, Filter, Sort, and Search buttons. */ export declare type KanbanHeaderPosition = 'none' | 'top' | 'bottom'; /**Sets or gets the way column hierarchy is represented. */ export declare type KanbanHierarchy = 'columns' | 'tabs'; /**Determines selection mode. */ export declare type KanbanSelectionMode = 'zeroOrOne' | 'zeroOrManyExtended'; /**Sets or gets whether tasks can be shown in all levels of column hierarchy or only on leaf columns. */ export declare type KanbanTaskPosition = 'all' | 'leaf'; /**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. */ export declare type KanbanTaskSubTasks = 'none' | 'onePerRow' | 'onlyUnfinished';