Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxPinnedAreaSeparatorComponent

Base class for various definition types for the grid.

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static ngAcceptInputType_activationBorderBottomWidth

ngAcceptInputType_activationBorderBottomWidth: string | number

Static ngAcceptInputType_activationBorderLeftWidth

ngAcceptInputType_activationBorderLeftWidth: string | number

Static ngAcceptInputType_activationBorderRightWidth

ngAcceptInputType_activationBorderRightWidth: string | number

Static ngAcceptInputType_activationBorderTopWidth

ngAcceptInputType_activationBorderTopWidth: string | number

Static ngAcceptInputType_actualLineBreakMode

ngAcceptInputType_actualLineBreakMode: string | TextCellLineBreakMode

Static ngAcceptInputType_actualPinnedRowOpacity

ngAcceptInputType_actualPinnedRowOpacity: string | number

Static ngAcceptInputType_borderBottomWidth

ngAcceptInputType_borderBottomWidth: string | number

Static ngAcceptInputType_borderLeftWidth

ngAcceptInputType_borderLeftWidth: string | number

Static ngAcceptInputType_borderRightWidth

ngAcceptInputType_borderRightWidth: string | number

Static ngAcceptInputType_borderTopWidth

ngAcceptInputType_borderTopWidth: string | number

Static ngAcceptInputType_contentOpacity

ngAcceptInputType_contentOpacity: string | number

Static ngAcceptInputType_errorBorderBottomWidth

ngAcceptInputType_errorBorderBottomWidth: string | number

Static ngAcceptInputType_errorBorderLeftWidth

ngAcceptInputType_errorBorderLeftWidth: string | number

Static ngAcceptInputType_errorBorderRightWidth

ngAcceptInputType_errorBorderRightWidth: string | number

Static ngAcceptInputType_errorBorderTopWidth

ngAcceptInputType_errorBorderTopWidth: string | number

Static ngAcceptInputType_horizontalAlignment

ngAcceptInputType_horizontalAlignment: string | CellContentHorizontalAlignment

Static ngAcceptInputType_lineBreakMode

ngAcceptInputType_lineBreakMode: string | TextCellLineBreakMode

Static ngAcceptInputType_pinnedRowOpacity

ngAcceptInputType_pinnedRowOpacity: string | number

Static ngAcceptInputType_verticalAlignment

ngAcceptInputType_verticalAlignment: string | CellContentVerticalAlignment

Static ɵcmp

ɵcmp: unknown

Static ɵfac

ɵfac: unknown

Accessors

activationBorder

  • get activationBorder(): string

  • Gets or sets the background color to use.

    Returns string

  • set activationBorder(v: string): void

  • Parameters

    • v: string

    Returns void

activationBorderBottomWidth

  • get activationBorderBottomWidth(): number

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

    Returns number

  • set activationBorderBottomWidth(v: number): void

  • Parameters

    • v: number

    Returns void

activationBorderLeftWidth

  • get activationBorderLeftWidth(): number

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

    Returns number

  • set activationBorderLeftWidth(v: number): void

  • Parameters

    • v: number

    Returns void

activationBorderRightWidth

  • get activationBorderRightWidth(): number

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

    Returns number

  • set activationBorderRightWidth(v: number): void

  • Parameters

    • v: number

    Returns void

activationBorderTopWidth

  • get activationBorderTopWidth(): number

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

    Returns number

  • set activationBorderTopWidth(v: number): void

  • Parameters

    • v: number

    Returns void

actualActivationBorder

  • get actualActivationBorder(): string

  • Gets the actual background color that will be used.

    Returns string

  • set actualActivationBorder(v: string): void

  • Parameters

    • v: string

    Returns void

actualBackground

  • get actualBackground(): string

  • Gets the actual background color that will be used.

    Returns string

  • set actualBackground(v: string): void

  • Parameters

    • v: string

    Returns void

actualBorder

  • get actualBorder(): string

  • Gets the actual border color that will be used.

    Returns string

  • set actualBorder(v: string): void

  • Parameters

    • v: string

    Returns void

actualErrorBorder

  • get actualErrorBorder(): string

  • Gets the actual error border color that will be used.

    Returns string

  • set actualErrorBorder(v: string): void

  • Parameters

    • v: string

    Returns void

actualLastStickyRowBackground

  • get actualLastStickyRowBackground(): string

  • Gets the actual color for the last row in the sticky row area.

    Returns string

  • set actualLastStickyRowBackground(v: string): void

  • Parameters

    • v: string

    Returns void

actualLineBreakMode

  • get actualLineBreakMode(): TextCellLineBreakMode

  • Gets the actual line break mode which will be used if text is present in the cell.

    Returns TextCellLineBreakMode

  • set actualLineBreakMode(v: TextCellLineBreakMode): void

  • Parameters

    Returns void

actualPinnedRowBackground

  • get actualPinnedRowBackground(): string

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

    Returns string

  • set actualPinnedRowBackground(v: string): void

  • Parameters

    • v: string

    Returns void

actualPinnedRowOpacity

  • get actualPinnedRowOpacity(): number

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

    Returns number

  • set actualPinnedRowOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

actualStickyRowBackground

  • get actualStickyRowBackground(): string

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

    Returns string

  • set actualStickyRowBackground(v: string): void

  • Parameters

    • v: string

    Returns void

actualTextColor

  • get actualTextColor(): string

  • Gets the actual color used for displaying text.

    Returns string

  • set actualTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

background

  • get background(): string

  • Gets or sets the background color to use.

    Returns string

  • set background(v: string): void

  • Parameters

    • v: string

    Returns void

border

  • get border(): string

  • Gets or sets the background color to use.

    Returns string

  • set border(v: string): void

  • Parameters

    • v: string

    Returns void

borderBottomWidth

  • get borderBottomWidth(): number

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

    Returns number

  • set borderBottomWidth(v: number): void

  • Parameters

    • v: number

    Returns void

borderLeftWidth

  • get borderLeftWidth(): number

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

    Returns number

  • set borderLeftWidth(v: number): void

  • Parameters

    • v: number

    Returns void

borderRightWidth

  • get borderRightWidth(): number

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

    Returns number

  • set borderRightWidth(v: number): void

  • Parameters

    • v: number

    Returns void

borderTopWidth

  • get borderTopWidth(): number

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

    Returns number

  • set borderTopWidth(v: number): void

  • Parameters

    • v: number

    Returns void

cellStyleKeyRequested

  • get cellStyleKeyRequested(): EventEmitter<{
        args: IgxCellStyleRequestedEventArgs;
        sender: any;
    }>

  • Called when the style key for a cell is needed. Used for recycling the cell.

    Returns EventEmitter<{
        args: IgxCellStyleRequestedEventArgs;
        sender: any;
    }>

contentOpacity

  • get contentOpacity(): number

  • Gets or sets the opacity of the content.

    Returns number

  • set contentOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

dataBinding

  • get dataBinding(): EventEmitter<{
        args: IgxDataBindingEventArgs;
        sender: any;
    }>

  • Called when a cell is data binding.

    Returns EventEmitter<{
        args: IgxDataBindingEventArgs;
        sender: any;
    }>

dataBound

  • get dataBound(): EventEmitter<{
        args: IgxDataBindingEventArgs;
        sender: any;
    }>

  • Called when a cell has been data bound.

    Returns EventEmitter<{
        args: IgxDataBindingEventArgs;
        sender: any;
    }>

errorBorder

  • get errorBorder(): string

  • Gets or sets the error border color to use.

    Returns string

  • set errorBorder(v: string): void

  • Parameters

    • v: string

    Returns void

errorBorderBottomWidth

  • get errorBorderBottomWidth(): number

  • Returns number

  • set errorBorderBottomWidth(v: number): void

  • Parameters

    • v: number

    Returns void

errorBorderLeftWidth

  • get errorBorderLeftWidth(): number

  • Returns number

  • set errorBorderLeftWidth(v: number): void

  • Parameters

    • v: number

    Returns void

errorBorderRightWidth

  • get errorBorderRightWidth(): number

  • Returns number

  • set errorBorderRightWidth(v: number): void

  • Parameters

    • v: number

    Returns void

errorBorderTopWidth

  • get errorBorderTopWidth(): number

  • Returns number

  • set errorBorderTopWidth(v: number): void

  • Parameters

    • v: number

    Returns void

horizontalAlignment

lastStickyRowBackground

  • get lastStickyRowBackground(): string

  • Gets or sets the color for the last row in the sticky row area.

    Returns string

  • set lastStickyRowBackground(v: string): void

  • Parameters

    • v: string

    Returns void

lineBreakMode

  • get lineBreakMode(): TextCellLineBreakMode

  • Gets or sets the line breaking mode to use if text is present in the cell.

    Returns TextCellLineBreakMode

  • set lineBreakMode(v: TextCellLineBreakMode): void

  • Parameters

    Returns void

pinnedRowBackground

  • get pinnedRowBackground(): string

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

    Returns string

  • set pinnedRowBackground(v: string): void

  • Parameters

    • v: string

    Returns void

pinnedRowOpacity

  • get pinnedRowOpacity(): number

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

    Returns number

  • set pinnedRowOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

stickyRowBackground

  • get stickyRowBackground(): string

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

    Returns string

  • set stickyRowBackground(v: string): void

  • Parameters

    • v: string

    Returns void

textColor

  • get textColor(): string

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

    Returns string

  • set textColor(v: string): void

  • Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): string

  • Returns string

  • set textStyle(v: string): void

  • Parameters

    • v: string

    Returns void

verticalAlignment

Methods

findByName

  • Parameters

    • name: string

    Returns any

getNamedValue

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

    Parameters

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

    Returns any

hasNamedValue

  • 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

  • Returns if this definition has named value.

    Returns boolean

ngOnInit

removeNamedValue

  • Removes the named value from this definition by name.

    Parameters

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

    Returns void

setNamedValue

Static _createFromInternal