Blazor

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SfKanban<TValue> - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SfKanban<TValue>

    The Kanban component is an efficient way to visually depict various stages of a process using cards with transparent workflows.

    Inheritance
    System.Object
    Syncfusion.Blazor.SfBaseComponent
    SfDataBoundComponent
    SfKanban<TValue>
    Implements
    IKanban
    Inherited Members
    SfDataBoundComponent.SetDataManager<T>(Object)
    SfDataBoundComponent.DataManager
    SfDataBoundComponent.MainParent
    Namespace: Syncfusion.Blazor.Kanban
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class SfKanban<TValue> : SfDataBoundComponent, IKanban
    Type Parameters
    Name Description
    TValue

    Constructors

    SfKanban()

    Declaration
    public SfKanban()

    Fields

    JS_CARD_CLICK

    Declaration
    public const string JS_CARD_CLICK = "sfBlazor.Kanban.cardClick"
    Field Value
    Type Description
    System.String

    Properties

    AllowDragAndDrop

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

    Declaration
    public bool AllowDragAndDrop { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowKeyboard

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

    Declaration
    public bool AllowKeyboard { get; set; }
    Property Value
    Type Description
    System.Boolean

    CardSettings

    Declaration
    public KanbanCardSettings CardSettings { get; set; }
    Property Value
    Type Description
    KanbanCardSettings

    Columns

    Declaration
    public List<KanbanColumn> Columns { get; set; }
    Property Value
    Type Description
    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
    public ConstraintType ConstraintType { get; set; }
    Property Value
    Type Description
    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
    public string CssClass { get; set; }
    Property Value
    Type Description
    System.String

    DataSource

    Accepts the list items either through local or remote service and binds it to the component. It can be passed either as List or else can create an instance of the SfDataManager in case of processing remote data and can be assigned to the DataSource property.

    Declaration
    public IEnumerable<TValue> DataSource { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.IEnumerable<TValue>

    DataSourceChanged

    Invokes when data source changes.

    Declaration
    public EventCallback<IEnumerable<TValue>> DataSourceChanged { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<TValue>>

    DialogSettings

    Declaration
    public KanbanDialogSettings DialogSettings { get; set; }
    Property Value
    Type Description
    KanbanDialogSettings

    EnableRtl

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

    Declaration
    public bool EnableRtl { get; set; }
    Property Value
    Type Description
    System.Boolean

    EnableTooltip

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

    Declaration
    public bool EnableTooltip { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    public string Height { get; set; }
    Property Value
    Type Description
    System.String

    ID

    Declaration
    public string ID { get; set; }
    Property Value
    Type Description
    System.String

    KeyField

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

    Declaration
    public string KeyField { get; set; }
    Property Value
    Type Description
    System.String

    Locale

    Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

    Declaration
    public string Locale { get; set; }
    Property Value
    Type Description
    System.String

    Query

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

    Declaration
    public Query Query { get; set; }
    Property Value
    Type Description
    Query

    SortSettings

    Declaration
    public KanbanSortSettings SortSettings { get; set; }
    Property Value
    Type Description
    KanbanSortSettings

    StackedHeaders

    Declaration
    public List<KanbanStackedHeader> StackedHeaders { get; set; }
    Property Value
    Type Description
    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
    public KanbanSwimlaneSettings SwimlaneSettings { get; set; }
    Property Value
    Type Description
    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
    public string Width { get; set; }
    Property Value
    Type Description
    System.String

    Methods

    AddCard(TValue)

    Adds the new single card to the data source of Kanban and layout.

    Declaration
    public Task AddCard(TValue cardData)
    Parameters
    Type Name Description
    TValue cardData
    Returns
    Type Description
    System.Threading.Tasks.Task

    AddCard(List<TValue>)

    Adds the new more number of cards to the data source of Kanban and layout.

    Declaration
    public Task AddCard(List<TValue> cardData)
    Parameters
    Type Name Description
    System.Collections.Generic.List<TValue> cardData
    Returns
    Type Description
    System.Threading.Tasks.Task

    AddColumn(ColumnModel, Int32)

    To add the column based on the provided items in the columns with index value.

    Declaration
    public void AddColumn(ColumnModel item, int index)
    Parameters
    Type Name Description
    ColumnModel item
    System.Int32 index

    BuildRenderTree(RenderTreeBuilder)

    Declaration
    protected override void BuildRenderTree(RenderTreeBuilder __builder)
    Parameters
    Type Name Description
    Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

    CloseDialog()

    To manually close the dialog

    Declaration
    public Task CloseDialog()
    Returns
    Type Description
    System.Threading.Tasks.Task

    DeleteCard(TValue)

    Deletes the card based on provided data.

    Declaration
    public Task DeleteCard(TValue cardData)
    Parameters
    Type Name Description
    TValue cardData
    Returns
    Type Description
    System.Threading.Tasks.Task

    DeleteCard(List<TValue>)

    Deletes the card based on card collection in the argument list.

    Declaration
    public Task DeleteCard(List<TValue> cardData)
    Parameters
    Type Name Description
    System.Collections.Generic.List<TValue> cardData
    Returns
    Type Description
    System.Threading.Tasks.Task

    DeleteCard(Int32)

    Deletes the card based on the provided ID as Integer.

    Declaration
    public Task DeleteCard(int id)
    Parameters
    Type Name Description
    System.Int32 id
    Returns
    Type Description
    System.Threading.Tasks.Task

    DeleteCard(String)

    Deletes the card based on the provided ID as String.

    Declaration
    public Task DeleteCard(string id)
    Parameters
    Type Name Description
    System.String id
    Returns
    Type Description
    System.Threading.Tasks.Task

    DeleteColumn(Int32)

    To delete the column based on the provided the columns index.

    Declaration
    public void DeleteColumn(int index)
    Parameters
    Type Name Description
    System.Int32 index

    GetColumnData(List<String>, IEnumerable<TValue>)

    Declaration
    public List<TValue> GetColumnData(List<string> key, IEnumerable<TValue> dataSource = null)
    Parameters
    Type Name Description
    System.Collections.Generic.List<System.String> key
    System.Collections.Generic.IEnumerable<TValue> dataSource
    Returns
    Type Description
    System.Collections.Generic.List<TValue>

    GetSelectedCards()

    Gets the list of selected cards from the board.

    Declaration
    public Task<List<DOM>> GetSelectedCards()
    Returns
    Type Description
    System.Threading.Tasks.Task<System.Collections.Generic.List<DOM>>

    GetSwimlaneData(String)

    Returns the swimlane column data based on the swimlane keyField input.

    Declaration
    public List<TValue> GetSwimlaneData(string keyField)
    Parameters
    Type Name Description
    System.String keyField
    Returns
    Type Description
    System.Collections.Generic.List<TValue>

    HideColumn(String)

    Hides the column from the Kanban board based on the provided key in the columns.

    Declaration
    public Task HideColumn(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Threading.Tasks.Task

    HideSpinner()

    Manually showed spinner needs to hide by HideSpinner.

    Declaration
    public Task HideSpinner()
    Returns
    Type Description
    System.Threading.Tasks.Task

    System.Threading.Tasks.Task

    OnAfterRenderAsync(Boolean)

    Declaration
    protected override Task OnAfterRenderAsync(bool firstRender)
    Parameters
    Type Name Description
    System.Boolean firstRender
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)

    OnInitializedAsync()

    Declaration
    protected override Task OnInitializedAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnInitializedAsync()

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnParametersSetAsync()

    OpenDialog(CurrentAction, TValue)

    To manually open the dialog

    Declaration
    public Task OpenDialog(CurrentAction action, TValue data)
    Parameters
    Type Name Description
    CurrentAction action
    TValue data
    Returns
    Type Description
    System.Threading.Tasks.Task

    Refresh()

    Refreshes the Kanban header and content.

    Declaration
    public void Refresh()

    ShowColumn(String)

    To show or hide the column based on the provided key in the columns.

    Declaration
    public Task ShowColumn(string key)
    Parameters
    Type Name Description
    System.String key
    Returns
    Type Description
    System.Threading.Tasks.Task

    ShowSpinner()

    By default, Kanban shows the spinner for all its actions. You can use this method to show spinner at your needed time.

    Declaration
    public Task ShowSpinner()
    Returns
    Type Description
    System.Threading.Tasks.Task

    System.Threading.Tasks.Task

    UpdateCard(TValue)

    Updates the changes made in the card object by passing it as a parameter to the data source.

    Declaration
    public Task UpdateCard(TValue cardData)
    Parameters
    Type Name Description
    TValue cardData
    Returns
    Type Description
    System.Threading.Tasks.Task

    UpdateCard(List<TValue>)

    Update the more number of cards to the data source of Kanban.

    Declaration
    public Task UpdateCard(List<TValue> cardData)
    Parameters
    Type Name Description
    System.Collections.Generic.List<TValue> cardData
    Returns
    Type Description
    System.Threading.Tasks.Task

    Explicit Interface Implementations

    IKanban.KanbanTemplates

    Declaration
    KanbanTemplates IKanban.KanbanTemplates { get; set; }
    Returns
    Type Description
    KanbanTemplates

    Implements

    IKanban
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved