Interface IKanban

Interface for the class Kanban.

Namespace: Syncfusion.Blazor.Kanban

Assembly: Syncfusion.Blazor.dll

Syntax

public interface IKanban

Properties

AllowDragAndDrop

Enables or disables the drag and drop actions in the Kanban.

Declaration

bool AllowDragAndDrop { get; set; }

Property Value

Type
System.Boolean

AllowKeyboard

When this property is set to true, it allows the keyboard interaction in the Kanban board.

Declaration

bool AllowKeyboard { get; set; }

Property Value

Type
System.Boolean

CardSettings

Defines the Kanban board related settings such as header field, content field, template, show or hide header, and single or multiple selection.

Declaration

KanbanCardSettings CardSettings { get; set; }

Property Value

Type
KanbanCardSettings

Columns

Defines the Kanban board columns and their properties such as header text, key field, template, allow toggle, expand, or collapse state, min or max count, and show or hide item count.

Declaration

List<KanbanColumn> Columns { get; set; }

Property Value

Type
System.Collections.Generic.List<KanbanColumn>

ConstraintType

Defines the constraint type used to apply validation based on column or swimlane. The possible values are: Column Swimlane.

Declaration

ConstraintType ConstraintType { get; set; }

Property Value

Type
ConstraintType

CssClass

It is used to customize the Kanban, which accepts custom CSS class names that define specific user-defined styles and themes to be applied on the Kanban element.

Declaration

string CssClass { get; set; }

Property Value

Type
System.String

DialogSettings

Defines the dialog settings such as template and fields.

Declaration

KanbanDialogSettings DialogSettings { get; set; }

Property Value

Type
KanbanDialogSettings

EnableRtl

Enable or disable rendering component in the right to left direction.

Declaration

bool EnableRtl { get; set; }

Property Value

Type
System.Boolean

EnableTooltip

Enables or disables the tooltip in the Kanban board. The property relates to the tooltipTemplate property.

Declaration

bool EnableTooltip { get; set; }

Property Value

Type
System.Boolean

ExternalDropId

Defines the ID of drop component on which drop should occur.

Declaration

List<string> ExternalDropId { get; set; }

Property Value

Type
System.Collections.Generic.List<System.String>

Height

Sets the Height of the Kanban component, accepting both string and number values. The string type includes either pixel or percentage values. When height is set with specific pixel value, then the Kanban will be rendered to that specified space. In case, if auto value is set, then the height of the Kanban gets auto-adjusted within the given container.

Declaration

string Height { get; set; }

Property Value

Type
System.String

KanbanTemplates

Enables or disables the template in the Kanban board. The property relates to the tooltipTemplate property.

Declaration

KanbanTemplates KanbanTemplates { get; set; }

Property Value

Type
KanbanTemplates

KeyField

Defines the key field of the Kanban board. The Kanban renders its layout based on this key field.

Declaration

string KeyField { get; set; }

Property Value

Type
System.String

Query

Defines the external Query that will be executed along with the data processing.

Declaration

Query Query { get; set; }

Property Value

Type
Query

SortSettings

Defines the sort settings such as sortBy, field and direction.

Declaration

KanbanSortSettings SortSettings { get; set; }

Property Value

Type
KanbanSortSettings

StackedHeaders

Defines the stacked header for Kanban columns with text and key fields.

Declaration

List<KanbanStackedHeader> StackedHeaders { get; set; }

Property Value

Type
System.Collections.Generic.List<KanbanStackedHeader>

SwimlaneSettings

Defines the swimlane settings to the Kanban board such as key field, text field, template, allow drag-and-drop, show or hide an empty row, show or hide items count, and more.

Declaration

KanbanSwimlaneSettings SwimlaneSettings { get; set; }

Property Value

Type
KanbanSwimlaneSettings

Width

Sets the Width of the Kanban component, accepting both string and number values. The string value can be either pixel or percentage format. When set to auto, the Kanban width gets auto-adjusted and displays its content related to the viewable screen size.

Declaration

string Width { get; set; }

Property Value

Type
System.String

Methods

CallStateHasChangedAsync()

Represents the StateHasChanged method.

Declaration

Task CallStateHasChangedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.

PropertyChanged()

Specifies the PropertyChanged method.

Declaration

Task PropertyChanged()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.