Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxColumnComponent

Hierarchy

Implements

  • OnInit

Constructors

Accessors

Methods

Constructors

constructor

Accessors

activationBorder

  • get activationBorder(): string
  • set activationBorder(v: string): void

activationBorderBottomWidth

  • get activationBorderBottomWidth(): number
  • set activationBorderBottomWidth(v: number): void

activationBorderLeftWidth

  • get activationBorderLeftWidth(): number
  • set activationBorderLeftWidth(v: number): void

activationBorderRightWidth

  • get activationBorderRightWidth(): number
  • set activationBorderRightWidth(v: number): void

activationBorderTopWidth

  • get activationBorderTopWidth(): number
  • set activationBorderTopWidth(v: number): void

actualActivationBorder

  • get actualActivationBorder(): string
  • set actualActivationBorder(v: string): void

actualBackground

  • get actualBackground(): string
  • set actualBackground(v: string): void

actualBorder

  • get actualBorder(): string
  • set actualBorder(v: string): void

  • Gets the actual border color that will be used.

    Returns string

  • Gets the actual border color that will be used.

    Parameters

    • v: string

    Returns void

actualHeaderText

  • get actualHeaderText(): string
  • set actualHeaderText(v: string): void

  • Gets the actual text displayed in the header of the column

    Returns string

  • Gets the actual text displayed in the header of the column

    Parameters

    • v: string

    Returns void

actualLastStickyRowBackground

  • get actualLastStickyRowBackground(): string
  • set actualLastStickyRowBackground(v: string): void

actualLineBreakMode

actualPinnedRowBackground

  • get actualPinnedRowBackground(): string
  • set actualPinnedRowBackground(v: string): void

actualPinnedRowOpacity

  • get actualPinnedRowOpacity(): number
  • set actualPinnedRowOpacity(v: number): void

actualSelectedBackground

  • get actualSelectedBackground(): string
  • set actualSelectedBackground(v: string): void

  • Gets the actual background color that is used for the cells when they are selected

    Returns string

  • Gets the actual background color that is used for the cells when they are selected

    Parameters

    • v: string

    Returns void

actualStickyRowBackground

  • get actualStickyRowBackground(): string
  • set actualStickyRowBackground(v: string): void

actualTextColor

  • get actualTextColor(): string
  • set actualTextColor(v: string): void

animationSettings

  • get animationSettings(): GridColumnAnimationSettings
  • set animationSettings(v: GridColumnAnimationSettings): void

  • Gets or sets the animation settings to use for this column.

    Returns GridColumnAnimationSettings

  • Gets or sets the animation settings to use for this column.

    Parameters

    • v: GridColumnAnimationSettings

    Returns void

background

  • get background(): string
  • set background(v: string): void

  • Gets or sets the background color to use.

    Returns string

  • Gets or sets the background color to use.

    Parameters

    • v: string

    Returns void

border

  • get border(): string
  • set border(v: string): void

  • Gets or sets the background color to use.

    Returns string

  • Gets or sets the background color to use.

    Parameters

    • v: string

    Returns void

borderBottomWidth

  • get borderBottomWidth(): number
  • set borderBottomWidth(v: number): void

  • Gets or sets the amount of bottom border to use for the cell content of this column.

    Returns number

  • Gets or sets the amount of bottom border to use for the cell content of this column.

    Parameters

    • v: number

    Returns void

borderLeftWidth

  • get borderLeftWidth(): number
  • set borderLeftWidth(v: number): void

  • Gets or sets the amount of left border to use for the cell content for this column.

    Returns number

  • Gets or sets the amount of left border to use for the cell content for this column.

    Parameters

    • v: number

    Returns void

borderRightWidth

  • get borderRightWidth(): number
  • set borderRightWidth(v: number): void

  • Gets or sets the amount of right border to use for the cell content of this column.

    Returns number

  • Gets or sets the amount of right border to use for the cell content of this column.

    Parameters

    • v: number

    Returns void

borderTopWidth

  • get borderTopWidth(): number
  • set borderTopWidth(v: number): void

  • Gets or sets the amount of top border to use for the cell content for this column.

    Returns number

  • Gets or sets the amount of top border to use for the cell content for this column.

    Parameters

    • v: number

    Returns void

cellStyleKeyRequested

  • get cellStyleKeyRequested(): EventEmitter<object>

contentOpacity

  • get contentOpacity(): number
  • set contentOpacity(v: number): void

dataBinding

  • get dataBinding(): EventEmitter<object>

dataBound

  • get dataBound(): EventEmitter<object>

  • Called when a cell has been data bound.

    Returns EventEmitter<object>

filter

  • get filter(): ColumnFilterCondition
  • set filter(v: ColumnFilterCondition): void

  • Gets or sets a filter to apply on the values of this column

    Returns ColumnFilterCondition

  • Gets or sets a filter to apply on the values of this column

    Parameters

    • v: ColumnFilterCondition

    Returns void

header

  • Gets or sets the header definition for this column.

    Returns IgxHeaderComponent

  • Gets or sets the header definition for this column.

    Parameters

    Returns void

headerText

  • get headerText(): string
  • set headerText(v: string): void

  • Gets or sets the text displayed in the header of the column

    Returns string

  • Gets or sets the text displayed in the header of the column

    Parameters

    • v: string

    Returns void

horizontalAlignment

isAutoGenerated

  • get isAutoGenerated(): boolean
  • set isAutoGenerated(v: boolean): void

  • Gets whether this column was auto generated.

    Returns boolean

  • Gets whether this column was auto generated.

    Parameters

    • v: boolean

    Returns void

isFilteringEnabled

  • get isFilteringEnabled(): boolean
  • set isFilteringEnabled(v: boolean): void

  • Gets or sets whether filtering is enabled for this column.

    Returns boolean

  • Gets or sets whether filtering is enabled for this column.

    Parameters

    • v: boolean

    Returns void

isFromMarkup

  • get isFromMarkup(): boolean
  • set isFromMarkup(v: boolean): void

  • Gets whether this column was projected from markup/templates and is constrained.

    Returns boolean

  • Gets whether this column was projected from markup/templates and is constrained.

    Parameters

    • v: boolean

    Returns void

isHidden

  • get isHidden(): boolean
  • set isHidden(v: boolean): void

  • Gets or sets whether or not a column is hidden from the grid

    Returns boolean

  • Gets or sets whether or not a column is hidden from the grid

    Parameters

    • v: boolean

    Returns void

isResizingEnabled

  • get isResizingEnabled(): boolean
  • set isResizingEnabled(v: boolean): void

  • Gets or sets whether filtering is enabled for this column.

    Returns boolean

  • Gets or sets whether filtering is enabled for this column.

    Parameters

    • v: boolean

    Returns void

lastStickyRowBackground

  • get lastStickyRowBackground(): string
  • set lastStickyRowBackground(v: string): void

lineBreakMode

minWidth

  • get minWidth(): number
  • set minWidth(v: number): void

  • Gets or sets the minimum width to use for this column. Overrides the DefaultColumnMinWidth from the grid, if set.

    Returns number

  • Gets or sets the minimum width to use for this column. Overrides the DefaultColumnMinWidth from the grid, if set.

    Parameters

    • v: number

    Returns void

name

  • get name(): string
  • set name(v: string): void

  • Gets or sets an unique name of the Column

    Returns string

  • Gets or sets an unique name of the Column

    Parameters

    • v: string

    Returns void

paddingBottom

  • get paddingBottom(): number
  • set paddingBottom(v: number): void

  • Gets or sets the amount of bottom padding to use for the cell content of this column.

    Returns number

  • Gets or sets the amount of bottom padding to use for the cell content of this column.

    Parameters

    • v: number

    Returns void

paddingLeft

  • get paddingLeft(): number
  • set paddingLeft(v: number): void

  • Gets or sets the amount of left padding to use for the cell content for this column.

    Returns number

  • Gets or sets the amount of left padding to use for the cell content for this column.

    Parameters

    • v: number

    Returns void

paddingRight

  • get paddingRight(): number
  • set paddingRight(v: number): void

  • Gets or sets the amount of right padding to use for the cell content of this column.

    Returns number

  • Gets or sets the amount of right padding to use for the cell content of this column.

    Parameters

    • v: number

    Returns void

paddingTop

  • get paddingTop(): number
  • set paddingTop(v: number): void

  • Gets or sets the amount of top padding to use for the cell content for this column.

    Returns number

  • Gets or sets the amount of top padding to use for the cell content for this column.

    Parameters

    • v: number

    Returns void

pinnedRowBackground

  • get pinnedRowBackground(): string
  • set pinnedRowBackground(v: string): void

  • Gets or sets the background color for cells belonging to rows marked as pinned.

    Returns string

  • Gets or sets the background color for cells belonging to rows marked as pinned.

    Parameters

    • v: string

    Returns void

pinnedRowOpacity

  • get pinnedRowOpacity(): number
  • set pinnedRowOpacity(v: number): void

propertyPath

  • get propertyPath(): string
  • set propertyPath(v: string): void

  • Gets or sets the key used for the column binding

    Returns string

  • Gets or sets the key used for the column binding

    Parameters

    • v: string

    Returns void

selectedBackground

  • get selectedBackground(): string
  • set selectedBackground(v: string): void

  • Gets or sets the background color to use for the cells when they are selected

    Returns string

  • Gets or sets the background color to use for the cells when they are selected

    Parameters

    • v: string

    Returns void

shouldRemoveWhenHidden

  • get shouldRemoveWhenHidden(): boolean
  • set shouldRemoveWhenHidden(v: boolean): void

  • Gets or sets if a column should be removed from the grid when it is fully hidden

    Returns boolean

  • Gets or sets if a column should be removed from the grid when it is fully hidden

    Parameters

    • v: boolean

    Returns void

sortDirection

  • Gets the current sort direction (None, Ascending, Descending) for this column.

    Returns ColumnSortDirection

  • Gets the current sort direction (None, Ascending, Descending) for this column.

    Parameters

    Returns void

stickyRowBackground

  • get stickyRowBackground(): string
  • set stickyRowBackground(v: string): void

  • Gets or sets the background color for content that sticks to the top of the grid.

    Returns string

  • Gets or sets the background color for content that sticks to the top of the grid.

    Parameters

    • v: string

    Returns void

textColor

  • get textColor(): string
  • set textColor(v: string): void

  • Gets or sets the color to use for displaying text.

    Returns string

  • Gets or sets the color to use for displaying text.

    Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): string
  • set textStyle(v: string): void

verticalAlignment

width

  • get width(): ColumnWidth
  • set width(v: ColumnWidth): void

  • Gets or sets the width to use for this column.

    Returns ColumnWidth

  • Gets or sets the width to use for this column.

    Parameters

    • v: ColumnWidth

    Returns void

Methods

getNamedHeaderValue

  • getNamedHeaderValue(valueName: string): any

  • Gets the value of a named header value for this column by name.

    Parameters

    • valueName: string
      • Name of the named header value to retrieve.

    Returns any

getNamedValue

  • getNamedValue(valueName: string): any

  • Gets the value for a named value from this definition.

    Parameters

    • valueName: string
      • The named value name to check for.

    Returns any

getUniqueKey

  • getUniqueKey(): string

  • Get the unique key used to identify this column.

    Returns string

hasNamedHeaderValue

  • hasNamedHeaderValue(valueName: string): boolean

  • Returns if there is a named header value with a given name.

    Parameters

    • valueName: string
      • The named value to check for.

    Returns boolean

hasNamedHeaderValues

  • hasNamedHeaderValues(): boolean

  • Returns if the column has named header values.

    Returns boolean

hasNamedValue

  • hasNamedValue(valueName: string): boolean

  • Returns if this definition has a named value with a given name.

    Parameters

    • valueName: string
      • The named value name to check for.

    Returns boolean

hasNamedValues

  • hasNamedValues(): boolean

ngOnInit

  • ngOnInit(): void

removeNamedHeaderValue

  • removeNamedHeaderValue(valueName: string): void

  • Removes a named header value with the given name from the named header values for this column.

    Parameters

    • valueName: string
      • The named header value to remove.

    Returns void

removeNamedValue

  • removeNamedValue(valueName: string): void

  • Removes the named value from this definition by name.

    Parameters

    • valueName: string
      • The named value name to remove.

    Returns void

setNamedHeaderValue

  • Parameters

    Returns void

setNamedValue

Static _createFromInternal