Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcDateTimeCellInfo

Backing information about a date time cell for the grid.

Hierarchy

Hierarchy (view full)

Constructors

Accessors

Methods

Constructors

constructor

Accessors

actionManager

  • get actionManager(): ICellActionManager

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

    Returns ICellActionManager

  • set actionManager(v): void

  • Parameters

    • v: ICellActionManager

    Returns void

activationBorder

  • get activationBorder(): string

  • Gets the actual background color of the cell

    Returns string

  • set activationBorder(v): 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): 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): 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): 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): 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): void

  • Parameters

    • v: number

    Returns void

actualBackground

  • get actualBackground(): string

  • Gets the actual background color of the cell

    Returns string

  • set actualBackground(v): void

  • Parameters

    • v: string

    Returns void

actualBorder

  • get actualBorder(): string

  • Gets the actual background color of the cell

    Returns string

  • set actualBorder(v): 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): 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): 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): 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): void

  • Parameters

    • v: number

    Returns void

actualContentOpacity

  • get actualContentOpacity(): number

  • Gets the actual content opacity of the cell.

    Returns number

  • set actualContentOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualFont

  • get actualFont(): string

  • Returns string

  • set actualFont(v): void

  • Parameters

    • v: string

    Returns void

actualOpacity

  • get actualOpacity(): number

  • Gets the actual opacity of the cell.

    Returns number

  • set actualOpacity(v): 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): 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): 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): 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): 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): void

  • Parameters

    • v: string

    Returns void

background

  • get background(): string

  • Gets or sets the background color of the cell.

    Returns string

  • set background(v): void

  • Parameters

    • v: string

    Returns void

border

  • get border(): string

  • Gets or sets the border color of the cell.

    Returns string

  • set border(v): 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): 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): 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): 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): 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): void

  • Parameters

    • v: number

    Returns void

dataRow

  • get dataRow(): number

  • Gets the absolute data row for the current cell.

    Returns number

  • set dataRow(v): void

  • Parameters

    • v: number

    Returns void

dateTimeFormat

  • get dateTimeFormat(): DateTimeFormats

  • Sets or gets the simple DateTimeFormat to use for the cell.

    Returns DateTimeFormats

  • set dateTimeFormat(v): void

  • Parameters

    Returns void

dateTimeValue

  • get dateTimeValue(): Date

  • Sets or gets the DateTime value for the cell.

    Returns Date

  • set dateTimeValue(v): void

  • Parameters

    • v: Date

    Returns void

deletedTextColor

  • get deletedTextColor(): string

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

    Returns string

  • set deletedTextColor(v): void

  • Parameters

    • v: string

    Returns void

editError

  • get editError(): string

  • Gets or sets the error message for the cell.

    Returns string

  • set editError(v): void

  • Parameters

    • v: string

    Returns void

editFont

  • get editFont(): string

  • Returns string

  • set editFont(v): void

  • Parameters

    • v: string

    Returns void

editID

  • get editID(): number

  • Returns number

  • set editID(v): 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): 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): 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): 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): 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): 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): void

  • Parameters

    • v: number

    Returns void

filterRowBackground

  • get filterRowBackground(): string

  • Gets or sets the background color for filter row.

    Returns string

  • set filterRowBackground(v): void

  • Parameters

    • v: string

    Returns void

font

  • get font(): string

  • Returns string

  • set font(v): void

  • Parameters

    • v: string

    Returns void

formatOverride

  • get formatOverride(): any

  • The format options to apply to the value

    Returns any

  • set formatOverride(v): void

  • Parameters

    • v: any

    Returns void

formatSpecifiers

  • get formatSpecifiers(): any[]

  • Returns any[]

  • set formatSpecifiers(v): void

  • Parameters

    • v: any[]

    Returns void

formatStringOverride

  • get formatStringOverride(): string

  • The format string to apply to the value

    Returns string

  • set formatStringOverride(v): void

  • Parameters

    • v: string

    Returns void

height

  • get height(): number

  • Gets the height of the cell.

    Returns number

  • set height(v): void

  • Parameters

    • v: number

    Returns void

horizontalAlignment

  • get horizontalAlignment(): CellContentHorizontalAlignment

  • Gets or sets the horiztonal alignment of the cell content.

    Returns CellContentHorizontalAlignment

  • set horizontalAlignment(v): void

  • Parameters

    Returns void

hoverBackground

  • get hoverBackground(): string

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

    Returns string

  • set hoverBackground(v): 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): 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): void

  • Parameters

    • v: string

    Returns void

indent

  • get indent(): number

  • Gets the indent level of the cell.

    Returns number

  • set indent(v): void

  • Parameters

    • v: number

    Returns void

isBorderDirty

  • get isBorderDirty(): boolean

  • Gets if the content of the cell is dirty.

    Returns boolean

  • set isBorderDirty(v): 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): void

  • Parameters

    • v: boolean

    Returns void

isContentDirty

  • get isContentDirty(): boolean

  • Gets if the content of the cell is dirty.

    Returns boolean

  • set isContentDirty(v): void

  • Parameters

    • v: boolean

    Returns void

isDataDirty

  • get isDataDirty(): boolean

  • Gets if the data of the cell is dirty.

    Returns boolean

  • set isDataDirty(v): 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): void

  • Parameters

    • v: boolean

    Returns void

isEdited

  • get isEdited(): boolean

  • Gets whether the cell has been edited.

    Returns boolean

  • set isEdited(v): void

  • Parameters

    • v: boolean

    Returns void

isExpanded

  • get isExpanded(): boolean

  • Gets the expansion state of the cell.

    Returns boolean

  • set isExpanded(v): void

  • Parameters

    • v: boolean

    Returns void

isFilterRow

  • get isFilterRow(): boolean

  • Gets if this cell is in the filter row.

    Returns boolean

  • set isFilterRow(v): 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): void

  • Parameters

    • v: boolean

    Returns void

isHoverable

  • get isHoverable(): boolean

  • Gets whether the cell is hoverable or not.

    Returns boolean

  • set isHoverable(v): void

  • Parameters

    • v: boolean

    Returns void

isInEditMode

  • get isInEditMode(): boolean

  • Gets whether the cell is in edit mode.

    Returns boolean

  • set isInEditMode(v): 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): void

  • Parameters

    • v: boolean

    Returns void

isLayerDirty

  • get isLayerDirty(): boolean

  • Gets if the layer of the cell is dirty.

    Returns boolean

  • set isLayerDirty(v): void

  • Parameters

    • v: boolean

    Returns void

isOffsetValue

  • get isOffsetValue(): boolean

  • Sets or gets whether the value to use is a DateTimeOffset value.

    Returns boolean

  • set isOffsetValue(v): void

  • Parameters

    • v: boolean

    Returns void

isPlaceholdContentNeeded

  • get isPlaceholdContentNeeded(): boolean

  • Gets if placeholder content is needed when virtualized.

    Returns boolean

  • set isPlaceholdContentNeeded(v): void

  • Parameters

    • v: boolean

    Returns void

isPositionDirty

  • get isPositionDirty(): boolean

  • Gets if the position of the cell is dirty.

    Returns boolean

  • set isPositionDirty(v): 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): 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): void

  • Parameters

    • v: boolean

    Returns void

isSelected

  • get isSelected(): boolean

  • Gets if the cell is selected.

    Returns boolean

  • set isSelected(v): void

  • Parameters

    • v: boolean

    Returns void

isSizeDirty

  • get isSizeDirty(): boolean

  • Gets if the size of the cell is dirty.

    Returns boolean

  • set isSizeDirty(v): void

  • Parameters

    • v: boolean

    Returns void

isStateDirty

  • get isStateDirty(): boolean

  • Gets if the layer of the cell is dirty.

    Returns boolean

  • set isStateDirty(v): 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): 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): void

  • Parameters

    Returns void

opacity

  • get opacity(): number

  • Gets or sets the opacity of the cell.

    Returns number

  • set opacity(v): 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): 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): 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): 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): 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): void

  • Parameters

    • v: number

    Returns void

pinned

  • get pinned(): PinnedPositions

  • Gets the fixed column position of this cell.

    Returns PinnedPositions

  • set pinned(v): 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): 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): 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): 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): 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): 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): 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): 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): 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): void

  • Parameters

    Returns void

sortIndicatorColor

  • get sortIndicatorColor(): string

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

    Returns string

  • set sortIndicatorColor(v): 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): 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): 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): void

  • Parameters

    • v: string

    Returns void

verticalAlignment

  • get verticalAlignment(): CellContentVerticalAlignment

  • Gets or sets the vertical alignment of the cell content.

    Returns CellContentVerticalAlignment

  • set verticalAlignment(v): void

  • Parameters

    Returns void

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): void

  • Parameters

    • v: number

    Returns void

width

  • get width(): number

  • Gets the width of the cell.

    Returns number

  • set width(v): 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): 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): void

  • Parameters

    • v: number

    Returns void

Methods

addOnChangedListener

  • addOnChangedListener(listener): void

  • Parameters

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

        • Returns void

    Returns void

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any

getNamedValue

  • getNamedValue(valueName): any

  • Gets a named value from the cell.

    Parameters

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

    Returns any

hasNamedValue

  • hasNamedValue(valueName): boolean

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

    Parameters

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

    Returns boolean

isCustomFieldDirty

  • isCustomFieldDirty(propertyName): boolean

  • Parameters

    • propertyName: string

    Returns boolean

isDirty

  • isDirty(propertyName): boolean

  • Gets if a named property is dirty.

    Parameters

    • propertyName: string
      • The property name to check.

    Returns boolean

isDirtyById

  • isDirtyById(propertyId_): boolean

  • Gets if a named property is dirty.

    Parameters

    • propertyId_: number

    Returns boolean

removeNamedValue

  • removeNamedValue(valueName): void

  • Removes a named value from the cell.

    Parameters

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

    Returns void

removeOnChangedListener

  • removeOnChangedListener(listener): void

  • Parameters

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

        • Returns void

    Returns void

setNamedValue

  • setNamedValue(valueName, value): void

  • Parameters

    • valueName: string
    • value: any

    Returns void