menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class SwimlaneSettingsModel - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class SwimlaneSettingsModel

    Represents settings for swimlanes in the Kanban component.

    Inheritance
    System.Object
    SwimlaneSettingsModel
    Namespace: Syncfusion.Blazor.Kanban
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class SwimlaneSettingsModel : Object
    Remarks

    This model governs the configuration and behavior of swimlanes, such as drag and drop, key fields, and visibility.

    Constructors

    SwimlaneSettingsModel()

    Declaration
    public SwimlaneSettingsModel()

    Properties

    AllowDragAndDrop

    Gets or sets a value indicating whether drag and drop actions are allowed within the swimlane.

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

    A boolean value indicating the allowability of drag-and-drop operations.

    Remarks

    Set this property to true to enable movement of items across swimlanes using drag-and-drop.

    Count

    Gets or sets the card count within the swimlane.

    Declaration
    public int Count { get; set; }
    Property Value
    Type Description
    System.Int32

    An integer representing the number of cards in the swimlane.

    Remarks

    This property does not directly limit the card number but reflects their existing count.

    KeyField

    Gets or sets the key field of the Kanban board which determines the layout of the swimlane.

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

    A string representing the key field used for organizing items in the swimlane.

    Remarks

    Use this key field to define how data should be organized and displayed in swimlanes.

    ShowEmptyRow

    Gets or sets a value indicating whether an empty swimlane row is shown.

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

    A boolean value indicating the visibility of empty swimlane rows.

    Remarks

    Toggle this setting to manage visibility of swimlanes that do not contain any items.

    ShowItemCount

    Gets or sets a value indicating whether the item count is displayed in the swimlane.

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

    A boolean value indicating whether to show item counts; default is true.

    Remarks

    This setting enables display of the number of items within each swimlane for reference.

    SortDirection

    Gets or sets the sorting direction for swimlane resources, options include Ascending or Descending.

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

    A SortDirection enum value indicating sort order preference.

    Remarks

    Sort swimlane resources to achieve the desired layout and organization of data.

    Template

    Gets or sets the swimlane template.

    Declaration
    public RenderFragment<SwimlaneSettingsModel> Template { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment<SwimlaneSettingsModel>

    A Microsoft.AspNetCore.Components.RenderFragment<> defining the visual template for the swimlane.

    Remarks

    Customize swimlane appearance by applying a unique template, enriching user interface complexity.

    TextField

    Gets or sets the header text field for the swimlane.

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

    A string representing the header text associated with the swimlane.

    Remarks

    Define this field to determine the textual label displayed in each swimlane header.

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