Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxTextCellInfo

Backing information for a text cell in 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_activationStatus

ngAcceptInputType_activationStatus: string | number

Static ngAcceptInputType_actualBorderBottomWidth

ngAcceptInputType_actualBorderBottomWidth: string | number

Static ngAcceptInputType_actualBorderLeftWidth

ngAcceptInputType_actualBorderLeftWidth: string | number

Static ngAcceptInputType_actualBorderRightWidth

ngAcceptInputType_actualBorderRightWidth: string | number

Static ngAcceptInputType_actualBorderTopWidth

ngAcceptInputType_actualBorderTopWidth: string | number

Static ngAcceptInputType_actualContentOpacity

ngAcceptInputType_actualContentOpacity: string | number

Static ngAcceptInputType_actualOpacity

ngAcceptInputType_actualOpacity: string | number

Static ngAcceptInputType_actualPaddingBottom

ngAcceptInputType_actualPaddingBottom: string | number

Static ngAcceptInputType_actualPaddingLeft

ngAcceptInputType_actualPaddingLeft: string | number

Static ngAcceptInputType_actualPaddingRight

ngAcceptInputType_actualPaddingRight: string | number

Static ngAcceptInputType_actualPaddingTop

ngAcceptInputType_actualPaddingTop: 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_dataRow

ngAcceptInputType_dataRow: string | number

Static ngAcceptInputType_editID

ngAcceptInputType_editID: string | number

Static ngAcceptInputType_editOpacity

ngAcceptInputType_editOpacity: 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_height

ngAcceptInputType_height: string | number

Static ngAcceptInputType_horizontalAlignment

ngAcceptInputType_horizontalAlignment: string | CellContentHorizontalAlignment

Static ngAcceptInputType_hoverStatus

ngAcceptInputType_hoverStatus: string | number

Static ngAcceptInputType_indent

ngAcceptInputType_indent: string | number

Static ngAcceptInputType_isBorderDirty

ngAcceptInputType_isBorderDirty: string | boolean

Static ngAcceptInputType_isCollapsable

ngAcceptInputType_isCollapsable: string | boolean

Static ngAcceptInputType_isContentDirty

ngAcceptInputType_isContentDirty: string | boolean

Static ngAcceptInputType_isDataDirty

ngAcceptInputType_isDataDirty: string | boolean

Static ngAcceptInputType_isDeleted

ngAcceptInputType_isDeleted: string | boolean

Static ngAcceptInputType_isEdited

ngAcceptInputType_isEdited: string | boolean

Static ngAcceptInputType_isExpanded

ngAcceptInputType_isExpanded: string | boolean

Static ngAcceptInputType_isFilterRow

ngAcceptInputType_isFilterRow: string | boolean

Static ngAcceptInputType_isHitTestVisible

ngAcceptInputType_isHitTestVisible: string | boolean

Static ngAcceptInputType_isHoverable

ngAcceptInputType_isHoverable: string | boolean

Static ngAcceptInputType_isInEditMode

ngAcceptInputType_isInEditMode: string | boolean

Static ngAcceptInputType_isLastStickyRow

ngAcceptInputType_isLastStickyRow: string | boolean

Static ngAcceptInputType_isLayerDirty

ngAcceptInputType_isLayerDirty: string | boolean

Static ngAcceptInputType_isPlaceholdContentNeeded

ngAcceptInputType_isPlaceholdContentNeeded: string | boolean

Static ngAcceptInputType_isPositionDirty

ngAcceptInputType_isPositionDirty: string | boolean

Static ngAcceptInputType_isRowPinned

ngAcceptInputType_isRowPinned: string | boolean

Static ngAcceptInputType_isRowSticky

ngAcceptInputType_isRowSticky: string | boolean

Static ngAcceptInputType_isSelected

ngAcceptInputType_isSelected: string | boolean

Static ngAcceptInputType_isSizeDirty

ngAcceptInputType_isSizeDirty: string | boolean

Static ngAcceptInputType_isStateDirty

ngAcceptInputType_isStateDirty: string | boolean

Static ngAcceptInputType_lineBreakMode

ngAcceptInputType_lineBreakMode: string | TextCellLineBreakMode

Static ngAcceptInputType_opacity

ngAcceptInputType_opacity: string | number

Static ngAcceptInputType_paddingBottom

ngAcceptInputType_paddingBottom: string | number

Static ngAcceptInputType_paddingLeft

ngAcceptInputType_paddingLeft: string | number

Static ngAcceptInputType_paddingRight

ngAcceptInputType_paddingRight: string | number

Static ngAcceptInputType_paddingTop

ngAcceptInputType_paddingTop: string | number

Static ngAcceptInputType_pinned

ngAcceptInputType_pinned: string | PinnedPositions

Static ngAcceptInputType_pinnedRowOpacity

ngAcceptInputType_pinnedRowOpacity: string | number

Static ngAcceptInputType_selectedStatus

ngAcceptInputType_selectedStatus: string | number

Static ngAcceptInputType_snappedX

ngAcceptInputType_snappedX: string | number

Static ngAcceptInputType_snappedY

ngAcceptInputType_snappedY: string | number

Static ngAcceptInputType_sortDirection

ngAcceptInputType_sortDirection: string | ColumnSortDirection

Static ngAcceptInputType_verticalAlignment

ngAcceptInputType_verticalAlignment: string | CellContentVerticalAlignment

Static ngAcceptInputType_virtualizationPercentage

ngAcceptInputType_virtualizationPercentage: string | number

Static ngAcceptInputType_width

ngAcceptInputType_width: string | number

Static ngAcceptInputType_x

ngAcceptInputType_x: string | number

Static ngAcceptInputType_y

ngAcceptInputType_y: string | number

Accessors

actionManager

  • get actionManager(): ICellActionManager

  • Gets the action manager to propagate actions back to the grid.

    Returns ICellActionManager

  • set actionManager(v: ICellActionManager): void

  • Parameters

    • v: ICellActionManager

    Returns void

activationBorder

  • get activationBorder(): string

  • Gets the actual background color of the cell

    Returns string

  • set activationBorder(v: string): void

  • Parameters

    • v: string

    Returns void

activationBorderBottomWidth

  • get activationBorderBottomWidth(): number

  • Gets or sets the bottom activation border to use for the content.

    Returns number

  • set activationBorderBottomWidth(v: number): void

  • Parameters

    • v: number

    Returns void

activationBorderLeftWidth

  • get activationBorderLeftWidth(): number

  • Gets or sets the left activation border to use for the content.

    Returns number

  • set activationBorderLeftWidth(v: number): void

  • Parameters

    • v: number

    Returns void

activationBorderRightWidth

  • get activationBorderRightWidth(): number

  • Gets or sets the right activation border to use for the content.

    Returns number

  • set activationBorderRightWidth(v: number): void

  • Parameters

    • v: number

    Returns void

activationBorderTopWidth

  • get activationBorderTopWidth(): number

  • Gets or sets the top activation border to use for the content.

    Returns number

  • set activationBorderTopWidth(v: number): void

  • Parameters

    • v: number

    Returns void

activationStatus

  • get activationStatus(): number

  • Gets the amount that the cell is activated. This is a value between 0 and 1.

    Returns number

  • set activationStatus(v: number): void

  • Parameters

    • v: number

    Returns void

actualBackground

  • get actualBackground(): string

  • Gets the actual background color of the cell

    Returns string

  • set actualBackground(v: string): void

  • Parameters

    • v: string

    Returns void

actualBorder

  • get actualBorder(): string

  • Gets the actual background color of the cell

    Returns string

  • set actualBorder(v: string): void

  • Parameters

    • v: string

    Returns void

actualBorderBottomWidth

  • get actualBorderBottomWidth(): number

  • Gets or sets the actual bottom border to use for the content.

    Returns number

  • set actualBorderBottomWidth(v: number): void

  • Parameters

    • v: number

    Returns void

actualBorderLeftWidth

  • get actualBorderLeftWidth(): number

  • Gets or sets the actual left border to use for the content.

    Returns number

  • set actualBorderLeftWidth(v: number): void

  • Parameters

    • v: number

    Returns void

actualBorderRightWidth

  • get actualBorderRightWidth(): number

  • Gets or sets the actual right border to use for the content.

    Returns number

  • set actualBorderRightWidth(v: number): void

  • Parameters

    • v: number

    Returns void

actualBorderTopWidth

  • get actualBorderTopWidth(): number

  • Gets or sets the actual top border to use for the content.

    Returns number

  • set actualBorderTopWidth(v: number): void

  • Parameters

    • v: number

    Returns void

actualContentOpacity

  • get actualContentOpacity(): number

  • Gets the actual content opacity of the cell.

    Returns number

  • set actualContentOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

actualFont

  • get actualFont(): string

  • Returns string

  • set actualFont(v: string): void

  • Parameters

    • v: string

    Returns void

actualOpacity

  • get actualOpacity(): number

  • Gets the actual opacity of the cell.

    Returns number

  • set actualOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

actualPaddingBottom

  • get actualPaddingBottom(): number

  • Gets or sets the bottom padding to use for the content.

    Returns number

  • set actualPaddingBottom(v: number): void

  • Parameters

    • v: number

    Returns void

actualPaddingLeft

  • get actualPaddingLeft(): number

  • Gets or sets the left padding to use for the content.

    Returns number

  • set actualPaddingLeft(v: number): void

  • Parameters

    • v: number

    Returns void

actualPaddingRight

  • get actualPaddingRight(): number

  • Gets or sets the right padding to use for the content.

    Returns number

  • set actualPaddingRight(v: number): void

  • Parameters

    • v: number

    Returns void

actualPaddingTop

  • get actualPaddingTop(): number

  • Gets or sets the top padding to use for the content.

    Returns number

  • set actualPaddingTop(v: number): void

  • Parameters

    • v: number

    Returns void

actualTextColor

  • get actualTextColor(): string

  • Gets the actual color of the text for the cell, if any.

    Returns string

  • set actualTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

background

  • get background(): string

  • Gets or sets the background color of the cell.

    Returns string

  • set background(v: string): void

  • Parameters

    • v: string

    Returns void

border

  • get border(): string

  • Gets or sets the border color of the cell.

    Returns string

  • set border(v: string): void

  • Parameters

    • v: string

    Returns void

borderBottomWidth

  • get borderBottomWidth(): number

  • Gets or sets the bottom border to use for the content.

    Returns number

  • set borderBottomWidth(v: number): void

  • Parameters

    • v: number

    Returns void

borderLeftWidth

  • get borderLeftWidth(): number

  • Gets or sets the left border to use for the content.

    Returns number

  • set borderLeftWidth(v: number): void

  • Parameters

    • v: number

    Returns void

borderRightWidth

  • get borderRightWidth(): number

  • Gets or sets the right border to use for the content.

    Returns number

  • set borderRightWidth(v: number): void

  • Parameters

    • v: number

    Returns void

borderTopWidth

  • get borderTopWidth(): number

  • Gets or sets the top border to use for the content.

    Returns number

  • set borderTopWidth(v: number): void

  • Parameters

    • v: number

    Returns void

contentOpacity

  • get contentOpacity(): number

  • Gets or sets the opacity of the content of the cell.

    Returns number

  • set contentOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

dataRow

  • get dataRow(): number

  • Gets the absolute data row for the current cell.

    Returns number

  • set dataRow(v: number): void

  • Parameters

    • v: number

    Returns void

deletedTextColor

  • get deletedTextColor(): string

  • Gets or sets the text color for cells in deleted rows.

    Returns string

  • set deletedTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

editError

  • get editError(): string

  • Gets or sets the error message for the cell.

    Returns string

  • set editError(v: string): void

  • Parameters

    • v: string

    Returns void

editFont

  • get editFont(): string

  • Returns string

  • set editFont(v: string): void

  • Parameters

    • v: string

    Returns void

editID

  • get editID(): number

  • Returns number

  • set editID(v: number): void

  • Parameters

    • v: number

    Returns void

editOpacity

  • get editOpacity(): number

  • Gets or sets the opacity for cells that have unsaved edits.

    Returns number

  • set editOpacity(v: number): void

  • Parameters

    • v: number

    Returns void

errorBorder

  • get errorBorder(): string

  • Gets or sets the error border color of the cell.

    Returns string

  • set errorBorder(v: string): void

  • Parameters

    • v: string

    Returns void

errorBorderBottomWidth

  • get errorBorderBottomWidth(): number

  • Gets or sets the bottom error border to use for the content.

    Returns number

  • set errorBorderBottomWidth(v: number): void

  • Parameters

    • v: number

    Returns void

errorBorderLeftWidth

  • get errorBorderLeftWidth(): number

  • Gets or sets the left error border to use for the content.

    Returns number

  • set errorBorderLeftWidth(v: number): void

  • Parameters

    • v: number

    Returns void

errorBorderRightWidth

  • get errorBorderRightWidth(): number

  • Gets or sets the right error border to use for the content.

    Returns number

  • set errorBorderRightWidth(v: number): void

  • Parameters

    • v: number

    Returns void

errorBorderTopWidth

  • get errorBorderTopWidth(): number

  • Gets or sets the top error border to use for the content.

    Returns number

  • set errorBorderTopWidth(v: number): void

  • Parameters

    • v: number

    Returns void

filterRowBackground

  • get filterRowBackground(): string

  • Gets or sets the background color for filter row.

    Returns string

  • set filterRowBackground(v: string): void

  • Parameters

    • v: string

    Returns void

font

  • get font(): string

  • Returns string

  • set font(v: string): void

  • Parameters

    • v: string

    Returns void

height

  • get height(): number

  • Gets the height of the cell.

    Returns number

  • set height(v: number): void

  • Parameters

    • v: number

    Returns void

horizontalAlignment

hoverBackground

  • get hoverBackground(): string

  • Gets or sets the hover background color of the cell.

    Returns string

  • set hoverBackground(v: string): void

  • Parameters

    • v: string

    Returns void

hoverStatus

  • get hoverStatus(): number

  • Gets the amount that the cell is hovered. This is a value between 0 and 1.

    Returns number

  • set hoverStatus(v: number): void

  • Parameters

    • v: number

    Returns void

hoverTextColor

  • get hoverTextColor(): string

  • Gets or sets the hover text color of the cell.

    Returns string

  • set hoverTextColor(v: string): void

  • Parameters

    • v: string

    Returns void

indent

  • get indent(): number

  • Gets the indent level of the cell.

    Returns number

  • set indent(v: number): void

  • Parameters

    • v: number

    Returns void

isBorderDirty

  • get isBorderDirty(): boolean

  • Gets if the content of the cell is dirty.

    Returns boolean

  • set isBorderDirty(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isCollapsable

  • get isCollapsable(): boolean

  • Gets if the cell needs to display an expansion indicator.

    Returns boolean

  • set isCollapsable(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isContentDirty

  • get isContentDirty(): boolean

  • Gets if the content of the cell is dirty.

    Returns boolean

  • set isContentDirty(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isDataDirty

  • get isDataDirty(): boolean

  • Gets if the data of the cell is dirty.

    Returns boolean

  • set isDataDirty(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isDeleted

  • get isDeleted(): boolean

  • Gets whether the cell is part of a deleted row.

    Returns boolean

  • set isDeleted(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isEdited

  • get isEdited(): boolean

  • Gets whether the cell has been edited.

    Returns boolean

  • set isEdited(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isExpanded

  • get isExpanded(): boolean

  • Gets the expansion state of the cell.

    Returns boolean

  • set isExpanded(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isFilterRow

  • get isFilterRow(): boolean

  • Gets if this cell is in the filter row.

    Returns boolean

  • set isFilterRow(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isHitTestVisible

  • get isHitTestVisible(): boolean

  • Gets or sets whether the cell is hit test visible.

    Returns boolean

  • set isHitTestVisible(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isHoverable

  • get isHoverable(): boolean

  • Gets whether the cell is hoverable or not.

    Returns boolean

  • set isHoverable(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isInEditMode

  • get isInEditMode(): boolean

  • Gets whether the cell is in edit mode.

    Returns boolean

  • set isInEditMode(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isLastStickyRow

  • get isLastStickyRow(): boolean

  • Gets if this cell is the last row that can stick to the top of the grid.

    Returns boolean

  • set isLastStickyRow(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isLayerDirty

  • get isLayerDirty(): boolean

  • Gets if the layer of the cell is dirty.

    Returns boolean

  • set isLayerDirty(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isPlaceholdContentNeeded

  • get isPlaceholdContentNeeded(): boolean

  • Gets if placeholder content is needed when virtualized.

    Returns boolean

  • set isPlaceholdContentNeeded(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isPositionDirty

  • get isPositionDirty(): boolean

  • Gets if the position of the cell is dirty.

    Returns boolean

  • set isPositionDirty(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isRowPinned

  • get isRowPinned(): boolean

  • Gets if this cell belongs to a row that has been marked as pinned.

    Returns boolean

  • set isRowPinned(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isRowSticky

  • get isRowSticky(): boolean

  • Gets if this cell belongs to a row that will stick to the top of the grid.

    Returns boolean

  • set isRowSticky(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isSelected

  • get isSelected(): boolean

  • Gets if the cell is selected.

    Returns boolean

  • set isSelected(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isSizeDirty

  • get isSizeDirty(): boolean

  • Gets if the size of the cell is dirty.

    Returns boolean

  • set isSizeDirty(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

isStateDirty

  • get isStateDirty(): boolean

  • Gets if the layer of the cell is dirty.

    Returns boolean

  • set isStateDirty(v: boolean): void

  • Parameters

    • v: boolean

    Returns void

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 break mode to use if text is present in the cell.

    Returns TextCellLineBreakMode

  • set lineBreakMode(v: TextCellLineBreakMode): void

  • Parameters

    Returns void

opacity

  • get opacity(): number

  • Gets or sets the opacity of the cell.

    Returns number

  • set opacity(v: number): void

  • Parameters

    • v: number

    Returns void

originalValue

  • get originalValue(): any

  • Gets or sets the original value for the cell, before processing.

    Returns any

  • set originalValue(v: any): void

  • Parameters

    • v: any

    Returns void

paddingBottom

  • get paddingBottom(): number

  • Gets or sets the bottom padding to use for the content.

    Returns number

  • set paddingBottom(v: number): void

  • Parameters

    • v: number

    Returns void

paddingLeft

  • get paddingLeft(): number

  • Gets or sets the left padding to use for the content.

    Returns number

  • set paddingLeft(v: number): void

  • Parameters

    • v: number

    Returns void

paddingRight

  • get paddingRight(): number

  • Gets or sets the right padding to use for the content.

    Returns number

  • set paddingRight(v: number): void

  • Parameters

    • v: number

    Returns void

paddingTop

  • get paddingTop(): number

  • Gets or sets the top padding to use for the content.

    Returns number

  • set paddingTop(v: number): void

  • Parameters

    • v: number

    Returns void

pinned

  • get pinned(): PinnedPositions

  • Gets the fixed column position of this cell.

    Returns PinnedPositions

  • set pinned(v: PinnedPositions): void

  • Parameters

    Returns void

pinnedRowBackground

  • get pinnedRowBackground(): string

  • Gets or sets the background color for the cell that has been 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

renderValue

  • get renderValue(): string

  • Gets or sets the text value, if any, which was rendered by a text cell.

    Returns string

  • set renderValue(v: string): void

  • Parameters

    • v: string

    Returns void

resolvedContentOpacity

  • get resolvedContentOpacity(): number

  • Returns number

resolvedTextAlign

  • get resolvedTextAlign(): "center" | "left" | "right"

  • Returns "center" | "left" | "right"

rowItem

  • get rowItem(): any

  • Returns any

  • set rowItem(v: any): void

  • Parameters

    • v: any

    Returns void

selectedBackground

  • get selectedBackground(): string

  • Gets or sets the selected background color of the cell.

    Returns string

  • set selectedBackground(v: string): void

  • Parameters

    • v: string

    Returns void

selectedStatus

  • get selectedStatus(): number

  • Gets the amount that the cell is selected. This is a value between 0 and 1.

    Returns number

  • set selectedStatus(v: number): void

  • Parameters

    • v: number

    Returns void

snappedX

  • get snappedX(): number

  • Gets the pixel snapped X position of the cell within the content.

    Returns number

  • set snappedX(v: number): void

  • Parameters

    • v: number

    Returns void

snappedY

  • get snappedY(): number

  • Gets the snapped Y position of the cell within the content.

    Returns number

  • set snappedY(v: number): void

  • Parameters

    • v: number

    Returns void

sortDirection

  • get sortDirection(): ColumnSortDirection

  • Gets the current sort direction for the column containing the cell.

    Returns ColumnSortDirection

  • set sortDirection(v: ColumnSortDirection): void

  • Parameters

    Returns void

sortIndicatorColor

  • get sortIndicatorColor(): string

  • Gets or sets the color for the sort indicator icon.

    Returns string

  • set sortIndicatorColor(v: string): void

  • Parameters

    • v: string

    Returns void

stickyRowBackground

  • get stickyRowBackground(): string

  • Gets or sets the background color for the cell when it is stuck to the top of the grid as a pinned row.

    Returns string

  • set stickyRowBackground(v: string): void

  • Parameters

    • v: string

    Returns void

styleKey

  • get styleKey(): string

  • Gets the style key of the current cell, used for recycling.

    Returns string

  • set styleKey(v: string): void

  • Parameters

    • v: string

    Returns void

textColor

  • get textColor(): string

  • Gets or sets the color of the text for the cell, if any.

    Returns string

  • set textColor(v: string): void

  • Parameters

    • v: string

    Returns void

textValue

  • get textValue(): string

  • Sets or gets the text value for the cell.

    Returns string

  • set textValue(v: string): void

  • Parameters

    • v: string

    Returns void

verticalAlignment

virtualizationPercentage

  • get virtualizationPercentage(): number

  • Gets or sets the virtualization percentage value. This is between 0 an 1, and indicates how virtual the content is at present.

    Returns number

  • set virtualizationPercentage(v: number): void

  • Parameters

    • v: number

    Returns void

width

  • get width(): number

  • Gets the width of the cell.

    Returns number

  • set width(v: number): void

  • Parameters

    • v: number

    Returns void

x

  • get x(): number

  • Gets the X position of the cell within the content.

    Returns number

  • set x(v: number): void

  • Parameters

    • v: number

    Returns void

y

  • get y(): number

  • Gets the Y position of the cell within the content.

    Returns number

  • set y(v: number): void

  • Parameters

    • v: number

    Returns void

Methods

addOnChangedListener

  • Parameters

    • listener: (() => void)
        • (): void

        • Returns void

    Returns void

findByName

  • Parameters

    • name: string

    Returns any

getNamedValue

  • Gets a named value from the cell.

    Parameters

    • valueName: string
      • The name of the value to get.

    Returns any

hasNamedValue

  • Returns if there is a named value stored for the cell.

    Parameters

    • valueName: string
      • The name of the value to check.

    Returns boolean

isCustomFieldDirty

  • Parameters

    • propertyName: string

    Returns boolean

isDirty

  • Gets if a named property is dirty.

    Parameters

    • propertyName: string
      • The property name to check.

    Returns boolean

isDirtyById

  • Gets if a named property is dirty.

    Parameters

    • propertyId_: number

    Returns boolean

removeNamedValue

  • Removes a named value from the cell.

    Parameters

    • valueName: string
      • The name of the value to remove.

    Returns void

removeOnChangedListener

  • Parameters

    • listener: (() => void)
        • (): void

        • Returns void

    Returns void

setNamedValue

  • Parameters

    • valueName: string
    • value: any

    Returns void