Class KanbanProperties
Represents a class for KanbanProperties which includes data source, columns, fields, edit settings, allow title, and swimlane settings properties.
Inherited Members
Namespace: Syncfusion.JavaScript.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class KanbanProperties : EJTagHelper
Constructors
KanbanProperties()
Declaration
public KanbanProperties()
Properties
ActionBegin
Gets or sets triggered for every Kanban action before its starts.
Declaration
[JsonProperty("actionBegin")]
public string ActionBegin { get; set; }
Property Value
Type | Description |
---|---|
System.String | The actionBegin |
ActionComplete
Gets or sets triggered for every Kanban action success event.
Declaration
[JsonProperty("actionComplete")]
public string ActionComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The actionComplete |
ActionFailure
Gets or sets triggered for every Kanban action failure event.
Declaration
[JsonProperty("actionFailure")]
public string ActionFailure { get; set; }
Property Value
Type | Description |
---|---|
System.String | The actionFailure |
AllowDragAndDrop
Gets or sets a value that indicates whether to enable allowDragAndDrop behavior on Kanban.
Declaration
[JsonProperty("allowDragAndDrop")]
public bool AllowDragAndDrop { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowExternalDragAndDrop
Gets or sets a value that indicates whether to enable allowExternalDragAndDrop behavior on Kanban.
Declaration
[JsonProperty("allowExternalDragAndDrop")]
public bool AllowExternalDragAndDrop { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowFiltering
Gets or sets a value to filter the contents.
Declaration
[JsonProperty("allowFiltering")]
public bool AllowFiltering { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowHover
Gets or sets a value that indicates whether to allow card hover actions.
Declaration
[JsonProperty("allowHover")]
public bool AllowHover { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowKeyboardNavigation
Gets or sets a value To allow keyboard navigation actions.
Declaration
[JsonProperty("allowKeyboardNavigation")]
public bool AllowKeyboardNavigation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowPrinting
Gets or sets a value that indicates whether to enable or disable the Print.
Declaration
[JsonProperty("allowPrinting")]
public bool AllowPrinting { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowScrolling
Gets or sets a value that indicates whether to enable the scrollbar in the Kanban and view the card by scroll through the Kanban manually.
Declaration
[JsonProperty("allowScrolling")]
public bool AllowScrolling { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowSearching
Gets or sets a value To enable Searching operation in Kanban.
Declaration
[JsonProperty("allowSearching")]
public bool AllowSearching { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowSelection
Gets or sets a value that indicates whether to enable allowSelection behavior on Kanban.User can select card and the selected card will be highlighted on Kanban.
Declaration
[JsonProperty("allowSelection")]
public bool AllowSelection { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowTitle
Gets or sets a value indicating whether To enable or disable the title of the card.
Declaration
[JsonProperty("allowTitle")]
public bool AllowTitle { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowToggleColumn
Gets or sets a value To enable or disable the column expand /collapse.
Declaration
[JsonProperty("allowToggleColumn")]
public bool AllowToggleColumn { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
BeforeCardSelect
Gets or sets triggered before the card is clicked.
Declaration
[JsonProperty("beforeCardSelect")]
public string BeforeCardSelect { get; set; }
Property Value
Type | Description |
---|---|
System.String | The beforeCardSelect |
BeforePrint
Gets or sets triggered for before every Kanban print.
Declaration
[JsonProperty("beforePrint")]
public string BeforePrint { get; set; }
Property Value
Type | Description |
---|---|
System.String | The beforePrint |
BeginEdit
Gets or sets triggered before the card is going to be edited.
Declaration
[JsonProperty("beginEdit")]
public string BeginEdit { get; set; }
Property Value
Type | Description |
---|---|
System.String | The beginEdit |
CardClick
Gets or sets triggered after the card is clicked.
Declaration
[JsonProperty("cardClick")]
public string CardClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The cardClick |
CardDoubleClick
Gets or sets triggered when card is double clicked.
Declaration
[JsonProperty("cardDoubleClick")]
public string CardDoubleClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The cardDoubleClick |
CardDrag
Gets or sets triggered when the card is being dragged.
Declaration
[JsonProperty("cardDrag")]
public string CardDrag { get; set; }
Property Value
Type | Description |
---|---|
System.String | The cardDrag |
CardDragStart
Gets or sets triggered when card dragging start.
Declaration
[JsonProperty("cardDragStart")]
public string CardDragStart { get; set; }
Property Value
Type | Description |
---|---|
System.String | The cardDragStart |
CardDragStop
Gets or sets triggered when card dragging stops.
Declaration
[JsonProperty("cardDragStop")]
public string CardDragStop { get; set; }
Property Value
Type | Description |
---|---|
System.String | The cardDragStop |
CardDrop
Gets or sets triggered when the card is Drop.
Declaration
[JsonProperty("cardDrop")]
public string CardDrop { get; set; }
Property Value
Type | Description |
---|---|
System.String | The cardDrop |
CardSelect
Gets or sets triggered after the card is selected.
Declaration
[JsonProperty("cardSelect")]
public string CardSelect { get; set; }
Property Value
Type | Description |
---|---|
System.String | The cardSelect |
CardSettings
Gets or sets an object that indicates whether to Customize the card based on the Mapping Fields.
Declaration
[JsonProperty("cardSettings")]
public CardSettings CardSettings { get; set; }
Property Value
Type | Description |
---|---|
CardSettings | The cardSettings |
CellClick
Gets or sets triggered after the cell is clicked.
Declaration
[JsonProperty("cellClick")]
public string CellClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The cellClick |
Columns
Gets or sets a value Add or remove columns in Kanban columns collections
Declaration
[JsonProperty("columns")]
public List<KanbanColumn> Columns { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<KanbanColumn> | The columns |
ContextClick
Gets or sets Triggered when Context item is clicked.
Declaration
[JsonProperty("contextClick")]
public string ContextClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The contextClick |
ContextMenuSettings
Gets or sets an object that indicates whether to customize the context menu behavior of the Kanban.
Declaration
[JsonProperty("contextMenuSettings")]
public KanbanContextMenuSettings ContextMenuSettings { get; set; }
Property Value
Type | Description |
---|---|
KanbanContextMenuSettings | The contextMenuSettings |
ContextOpen
Gets or sets triggered when Context item is open.
Declaration
[JsonProperty("contextOpen")]
public string ContextOpen { get; set; }
Property Value
Type | Description |
---|---|
System.String | The contextOpen |
Create
Triggered when the Kanban is rendered completely.
Declaration
[JsonProperty("create")]
public string Create { get; set; }
Property Value
Type | Description |
---|---|
System.String | The create |
CssClass
Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CustomToolbarItems
Gets or sets a value that indicates whether to add customToolbarItems within the toolbar to perform any action in the Kanban.
Declaration
[JsonProperty("customToolbarItems")]
public List<KanbanCustomToolBarItems> CustomToolbarItems { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<KanbanCustomToolBarItems> | The customToolbarItems |
DataBound
Triggered when the Kanban is bound with data during initial rendering.
Declaration
[JsonProperty("dataBound")]
[HtmlAttributeName("databound")]
public string DataBound { get; set; }
Property Value
Type | Description |
---|---|
System.String | The dataBound |
DataSource
Gets or sets the data to render the Kanban with card.
Declaration
[JsonConverter(typeof(DataManagerConverter))]
[JsonProperty("dataSource")]
[HtmlAttributeName("dataSource")]
public object DataSource { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The dataSource |
Destroy
Triggered when Kanban going to destroy.
Declaration
[JsonProperty("destroy")]
public string Destroy { get; set; }
Property Value
Type | Description |
---|---|
System.String | The destroy |
EditSettings
Get or sets an object that indicates whether to customize the editing behavior of the Kanban.
Declaration
[JsonProperty("editSettings")]
public KanbanEditSettings EditSettings { get; set; }
Property Value
Type | Description |
---|---|
KanbanEditSettings | The editSettings |
EnableRTL
Gets or sets the Align content in the Kanban control from right to left by setting the property as true.
Declaration
[JsonProperty("enableRTL")]
public bool EnableRTL { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableTotalCount
Gets or sets a value indicating whether To show Total count of cards in each column.
Declaration
[JsonProperty("enableTotalCount")]
public bool EnableTotalCount { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableTouch
Gets or sets a value indicating whether To enable or disable the touch.
Declaration
[JsonProperty("enableTouch")]
public bool EnableTouch { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EndAdd
Gets or sets triggered after the card is added.
Declaration
[JsonProperty("endAdd")]
public string EndAdd { get; set; }
Property Value
Type | Description |
---|---|
System.String | The endAdd |
EndDelete
Gets or sets triggered after the card is deleted.
Declaration
[JsonProperty("endDelete")]
public string EndDelete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The endDelete |
EndEdit
Gets or sets triggered after the card is edited.
Declaration
[JsonProperty("endEdit")]
public string EndEdit { get; set; }
Property Value
Type | Description |
---|---|
System.String | The endEdit |
Fields
To customize field mappings for card , editing title and control key parameters
Declaration
[JsonProperty("fields")]
public CardFields Fields { get; set; }
Property Value
Type | Description |
---|---|
CardFields | The fields |
FilterSettings
To customize the filtering behavior based on queries given.
Declaration
[JsonProperty("filterSettings")]
public List<KanbanFilterSetting> FilterSettings { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<KanbanFilterSetting> | The filterSettings |
HeaderClick
Gets or sets triggered after the header is clicked.
Declaration
[JsonProperty("headerClick")]
public string HeaderClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The headerClick |
Height
Gets or sets an object that indicates to render the Kanban with specified height.
Declaration
[JsonProperty("height")]
public object Height { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The height |
HtmlAttributes
Declaration
[JsonIgnore]
public object HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
IsResponsive
Gets or sets a value indicating whether this instance When set to true, adapts the Kanban layout to fit the screen size of devices on which it renders.
Declaration
[JsonProperty("isResponsive")]
public bool IsResponsive { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
KeyField
Gets or sets to map datasource field for column values mapping
Declaration
[JsonProperty("keyField")]
public string KeyField { get; set; }
Property Value
Type | Description |
---|---|
System.String | The keyField |
Load
Triggered initially load.
Declaration
[JsonProperty("load")]
public string Load { get; set; }
Property Value
Type | Description |
---|---|
System.String | The load |
Locale
Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region.
Declaration
[JsonProperty("locale")]
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The locale |
MinWidth
Gets or sets a value that indicates whether to set the minimum width of the responsive Kanban while isResponsive property is true.
Declaration
[JsonProperty("minWidth")]
public int MinWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The minWidth |
Query
Query the dataSource from the Kanban.
Declaration
[JsonProperty("query")]
public string Query { get; set; }
Property Value
Type | Description |
---|---|
System.String | The query |
QueryCellInfo
Triggered every time a single card rendered request is made to access particular card information.
Declaration
[JsonProperty("queryCellInfo")]
public string QueryCellInfo { get; set; }
Property Value
Type | Description |
---|---|
System.String | The queryCellInfo |
ScrollSettings
Gets or sets an object that indicates whether to customize the scrolling behavior of the Kanban.
Declaration
[JsonProperty("scrollSettings")]
public KanbanScrollSettings ScrollSettings { get; set; }
Property Value
Type | Description |
---|---|
KanbanScrollSettings | The scrollSettings |
SearchSettings
To customize the searching behavior of the Kanban.
Declaration
[JsonProperty("searchSettings")]
public KanbanSearchSettings SearchSettings { get; set; }
Property Value
Type | Description |
---|---|
KanbanSearchSettings | The searchSettings |
SelectionType
Gets or sets To allow customize selection type. Accepting types are "single" and "multiple".
Declaration
[JsonProperty("selectionType")]
[JsonConverter(typeof(StringEnumConverter))]
public SelectionType SelectionType { get; set; }
Property Value
Type | Description |
---|---|
SelectionType | The selectionType |
ShowColumnWhenEmpty
Gets or sets a value indicating whether To render the Kanban empty column in the sample.
Declaration
[JsonProperty("showColumnWhenEmpty")]
public bool ShowColumnWhenEmpty { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
StackedHeaderRows
Gets or sets an object that indicates to managing the collection of stacked header rows for the Kanban.
Declaration
[JsonProperty("stackedHeaderRows")]
public List<KanbanStackedHeaderRow> StackedHeaderRows { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<KanbanStackedHeaderRow> | The stackedHeaderRows |
SwimlaneClick
Gets or sets triggered after the swimlane is clicked.
Declaration
[JsonProperty("swimlaneClick")]
public string SwimlaneClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The swimlaneClick |
SwimlaneSettings
Customize the settings for swimlane.
Declaration
[JsonProperty("swimlaneSettings")]
public SwimlaneSettings SwimlaneSettings { get; set; }
Property Value
Type | Description |
---|---|
SwimlaneSettings | The swimlaneSettings |
ToolbarClick
Gets or sets triggered when toolbar item is clicked.
Declaration
[JsonProperty("toolbarClick")]
public string ToolbarClick { get; set; }
Property Value
Type | Description |
---|---|
System.String | The toolbarClick |
TooltipSettings
The tooltip allows to display card details in a tooltip while hovering on it.
Declaration
[JsonProperty("tooltipSettings")]
public KanbanTooltipSettings TooltipSettings { get; set; }
Property Value
Type | Description |
---|---|
KanbanTooltipSettings | The tooltipSettings |
Width
Gets or sets an object that indicates to render the Kanban with specified width.
Declaration
[JsonProperty("width")]
public object Width { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The width |
Workflows
Gets or sets a value Add or remove workflows in Kanban workflows collections
Declaration
[JsonProperty("workflows")]
public List<KanbanWorkflow> Workflows { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<KanbanWorkflow> | The workflows |
Methods
GetControlDetails()
Declaration
protected override object GetControlDetails()
Returns
Type | Description |
---|---|
System.Object |
Overrides
ShouldSerializeColumns()
Gets or sets a value that indicates whether the columns should serialize.
Declaration
public bool ShouldSerializeColumns()
Returns
Type | Description |
---|---|
System.Boolean | The method returns a Boolean. |