Interface ColumnDefIf

Represents a column definition of one table column.

Hierarchy

  • ColumnDefIf

Implemented by

Properties

classes editInputPipe? editable? getEditRenderer? headerLabel isVisible? maxWidth minWidth property rendererMap sortComparator? sortIconVisible? sortState? sortStatesOrder? sortable? width

Properties

classes

classes: AreaObjectMapType<string[]>

Represents an object that maps an area to a collection of objects.

Optional editInputPipe

editInputPipe?: editInputPipe

Represents an edit input pipe.

Optional editable

editable?: BooleanFunction

Determines if a column is editable or not.

Param

The variable to check.

Returns

  • Returns true if the variable is editable, false otherwise.

Optional getEditRenderer

getEditRenderer?: GetEditRenderer

Retrieves the edit renderer for the column.

Name

getEditRenderer

Function

Param

The element for which to retrieve the edit renderer.

Returns

  • The edit renderer for the specified element, or null if not found.

headerLabel

headerLabel: string

Represents the label for a header.

Optional isVisible

isVisible?: BooleanFunction

Determines if the column is visible or not.

Returns

  • If the element is visible, returns true. Otherwise, returns false.

maxWidth

maxWidth: SizeIf

Represents the maximum width of a column.

minWidth

minWidth: SizeIf

Represents the minimum width of a column.

property

property: string

Represents a property name of the table row element.

rendererMap

rendererMap: AreaObjectMapType<CellRendererIf>

Template

Optional sortComparator

sortComparator?: (<T>(a, b) => number)

Type declaration

    • <T>(a, b): number

    • Represents a function that compares two values for sorting purposes. The function takes two arguments of type T, compares them, and returns a number. If the result is negative, it means 'a' comes before 'b' in the sorted order. If the result is positive, it means 'b' comes before 'a' in the sorted order. If the result is zero, it means the two values are considered equal for sorting purposes.

      Type Parameters

      • T

      Parameters

      • a: T

        The first value to be compared.

      • b: T

        The second value to be compared.

      Returns number

      A number indicating the relative order of 'a' and 'b'.

      Typeparam

      T The type of values being compared.

Optional sortIconVisible

sortIconVisible?: BooleanFunction

Determines if the sort icon is visible.

Returns

Indicates whether the sort icon is visible.

Optional sortState

sortState?: SortState

Represents the state of sorting for a list.

Optional sortStatesOrder

sortStatesOrder?: SortState[]

Represents the order of multiple sort states.

Optional sortable

sortable?: BooleanFunction

Determines whether or not a column can be sorted.

Param

Specifies if an item is sortable.

Returns

  • Indicating whether the item is sortable or not.

width

width: SizeIf

Represents the size of a column along the width dimension.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc