Readonly ATTRIBUTE_Readonly CDATA_node is a CDATASection node.
Readonly COMMENT_node is a Comment node.
Readonly DOCUMENT_node is a DocumentFragment node.
Readonly DOCUMENT_node is a document.
Readonly DOCUMENT_Set when other is a descendant of node.
Readonly DOCUMENT_Set when other is an ancestor of node.
Readonly DOCUMENT_Set when node and other are not in the same tree.
Readonly DOCUMENT_Set when other is following node.
Readonly DOCUMENT_Readonly DOCUMENT_Set when other is preceding node.
Readonly DOCUMENT_node is a doctype.
Readonly ELEMENT_node is an element.
Readonly ENTITY_Readonly ENTITY_Readonly NOTATION_Readonly PROCESSING_node is a ProcessingInstruction node.
Readonly TEXT_node is a Text node.
Readonly accessReadonly assignedReadonly attributesReadonly baseURIReturns node's node document's document base URL.
Readonly childReadonly childReturns the children.
Readonly childrenReturns the child elements.
Readonly classAllows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.
Returns the value of element's class content attribute. Can be set to change it.
Readonly clientReadonly clientReadonly clientReadonly clientReadonly datasetReadonly firstReturns the first child.
Readonly firstReturns the first child that is an element, and null otherwise.
Returns the value of element's id content attribute. Can be set to change it.
Readonly isReturns true if node is connected and false otherwise.
Readonly isReadonly lastReturns the last child.
Readonly lastReturns the last child that is an element, and null otherwise.
Readonly localReturns the local name.
Readonly namespaceURIReturns the namespace.
Readonly nextReturns the first following sibling that is an element, and null otherwise.
Readonly nextReturns the next sibling.
Readonly nodeReturns a string appropriate for the type of node.
Readonly nodeReturns the type of node.
Optional nonceReadonly offsetReadonly offsetReadonly offsetReadonly offsetReadonly offsetFires when the user aborts the download.
The event.
Fires when the object loses the input focus.
The focus event.
Occurs when playback is possible, but would require further buffering.
The event.
Fires when the contents of the object or selection have changed.
The event.
Fires when the user clicks the left mouse button on the object
The mouse event.
Fires when the user clicks the right mouse button in the client area, opening the context menu.
The mouse event.
Fires when the user double-clicks the object.
The mouse event.
Fires on the source object continuously during a drag operation.
The event.
Fires on the source object when the user releases the mouse at the close of a drag operation.
The event.
Fires on the target element when the user drags the object to a valid drop target.
The drag event.
Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
The drag event.
Fires on the target element continuously while the user drags the object over a valid drop target.
The event.
Fires on the source object when the user starts to drag a text selection or selected object.
The event.
Occurs when the duration attribute is updated.
The event.
Occurs when the media element is reset to its initial state.
The event.
Occurs when the end of playback is reached.
The event
Fires when an error occurs during object loading.
The event.
Fires when the object receives focus.
The event.
Fires when the user presses a key.
The keyboard event
Fires when the user presses an alphanumeric key.
The event.
Fires when the user releases a key.
The keyboard event
Fires immediately after the browser loads the object.
The event.
Occurs when media data is loaded at the current playback position.
The event.
Occurs when the duration and dimensions of the media have been determined.
The event.
Occurs when Internet Explorer begins looking for media data.
The event.
Fires when the user clicks the object with either mouse button.
The mouse event.
Fires when the user moves the mouse over the object.
The mouse event.
Fires when the user moves the mouse pointer outside the boundaries of the object.
The mouse event.
Fires when the user moves the mouse pointer into the object.
The mouse event.
Fires when the user releases a mouse button while the mouse is over the object.
The mouse event.
Occurs when playback is paused.
The event.
Occurs when the play method is requested.
The event.
Occurs when the audio or video has started playing.
The event.
Occurs to indicate progress while downloading media data.
The event.
Occurs when the playback rate is increased or decreased.
The event.
Fires when the user resets a form.
The event.
Fires when the user repositions the scroll box in the scroll bar on the object.
The event.
Occurs when the seek operation ends.
The event.
Occurs when the current playback position is moved.
The event.
Fires when the current selection changes.
The event.
Occurs when the download has stopped.
The event.
Occurs if the load operation has been intentionally halted.
The event.
Occurs to indicate the current playback position.
The event.
Optional ontouchcancelOptional ontouchendOptional ontouchmoveOptional ontouchstartOccurs when the volume is changed, or playback is muted or unmuted.
The event.
Occurs when playback stops because the next frame of a video resource is not available.
The event.
This is a legacy alias of onanimationend.
This is a legacy alias of onanimationiteration.
This is a legacy alias of onanimationstart.
This is a legacy alias of ontransitionend.
Readonly ownerReadonly parentReturns the parent element.
Readonly parentReturns the parent.
Readonly partReadonly prefixReturns the namespace prefix.
Readonly previousReturns the first preceding sibling that is an element, and null otherwise.
Readonly previousReturns the previous sibling.
Readonly scrollReadonly scrollReadonly shadowReturns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.
Returns the value of element's slot content attribute. Can be set to change it.
Readonly styleReadonly tagReturns the HTML-uppercased qualified name.
Sets/gets custom properties provided in additional template context.
<igx-column [additionalTemplateContext]="contextObject">
<ng-template igxCell let-cell="cell" let-props="additionalTemplateContext">
{{ props }}
</ng-template>
</igx-column>
IgxColumnComponent
Sets/gets whether the column header is included in autosize logic.
Useful when template for a column header is sized based on parent, for example a default div.
Default value is false.
let isResizable = this.column.resizable;
<igx-column [resizable] = "true"></igx-column>
IgxColumnComponent
Returns a reference to the bodyTemplate.
let bodyTemplate = this.column.bodyTemplate;
IgxColumnComponent
Sets a conditional class selector of the column cells. Accepts an object literal, containing key-value pairs, where the key is the name of the CSS class, while the value is either a callback function that returns a boolean, or boolean, like so:
callback = (rowData, columnKey, cellValue, rowIndex) => { return rowData[columnKey] > 6; }
cellClasses = { 'className' : this.callback };
<igx-column [cellClasses] = "cellClasses"></igx-column>
<igx-column [cellClasses] = "{'class1' : true }"></igx-column>
IgxColumnComponent
Sets conditional style properties on the column cells.
Similar to ngStyle it accepts an object literal where the keys are
the style properties and the value is the expression to be evaluated.
As with cellClasses it accepts a callback function.
styles = {
background: 'royalblue',
color: (rowData, columnKey, cellValue, rowIndex) => value.startsWith('Important') ? 'red': 'inherit'
}
<igx-column [cellStyles]="styles"></igx-column>
IgxColumnComponent
A list containing all the child columns under this column (if any). Empty without children or if this column is not Group or Layout.
Column index where the current field should end. The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field
<igx-column-layout>
<igx-column [colEnd]="3" [rowStart]="1" [colStart]="1"></igx-column>
</igx-column-layout>
IgxColumnComponent
Column index from which the field is starting.
<igx-column-layout>
<igx-column [colStart]="1" [rowStart]="1"></igx-column>
</igx-column-layout>
IgxColumnComponent
Returns a boolean indicating if the column is a ColumnGroup.
let columnGroup = this.column.columnGroup;
IgxColumnComponent
Returns a boolean indicating if the column is a ColumnLayout for multi-row layout.
let columnGroup = this.column.columnGroup;
IgxColumnComponent
Returns a boolean indicating if the column is a child of a ColumnLayout for multi-row layout.
let columnLayoutChild = this.column.columnLayoutChild;
IgxColumnComponent
Sets/gets the data type of the column values.
Default value is string.
let columnDataType = this.column.dataType;
<igx-column [dataType] = "'number'"></igx-column>
IgxColumnComponent
Gets whether the hiding is disabled.
let isHidingDisabled = this.column.disableHiding;
IgxColumnComponent
Gets whether the pinning is disabled.
let isPinningDisabled = this.column.disablePinning;
IgxColumnComponent
Gets whether the column is editable.
Default value is false.
let isEditable = this.column.editable;
IgxColumnComponent
Returns a reference to the validation error template.
let errorTemplate = this.column.errorTemplate;
Sets/gets the field value.
let columnField = this.column.field;
<igx-column [field] = "'ID'"></igx-column>
IgxColumnComponent
Returns a reference to the filterCellTemplate.
let filterCellTemplate = this.column.filterCellTemplate;
IgxColumnComponent
Sets/gets whether the column is filterable.
Default value is true.
let isFilterable = this.column.filterable;
<igx-column [filterable] = "false"></igx-column>
IgxColumnComponent
Returns the filteringExpressionsTree of the column.
let tree = this.column.filteringExpressionsTree;
IgxColumnComponent
Sets/gets whether the column filtering should be case sensitive.
Default value is true.
let filteringIgnoreCase = this.column.filteringIgnoreCase;
<igx-column [filteringIgnoreCase] = "false"></igx-column>
IgxColumnComponent
Gets the column filters.
let columnFilters = this.column.filters'
IgxColumnComponent
Applies display format to cell values in the column. Does not modify the underlying data.
Note: As the formatter is used in places like the Excel style filtering dialog, in certain
scenarios (remote filtering for example), the row data argument can be undefined.
In this example, we check to see if the column name is Salary, and then provide a method as the column formatter to format the value into a currency string.
columnInit(column: IgxColumnComponent) {
if (column.field == "Salary") {
column.formatter = (salary => this.format(salary));
}
}
format(value: number) : string {
return formatCurrency(value, "en-us", "$");
}
const column = this.grid.getColumnByName('Address');
const addressFormatter = (address: string, rowData: any) => data.privacyEnabled ? 'unknown' : address;
column.formatter = addressFormatter;
IgxColumnComponent
Sets/gets whether the column is groupable.
Default value is false.
let isGroupable = this.column.groupable;
<igx-column [groupable] = "true"></igx-column>
IgxColumnComponent
Gets a value indicating whether the summary for the column is enabled.
let hasSummary = this.column.hasSummary;
IgxColumnComponent
Sets/gets the header value.
let columnHeader = this.column.header;
<igx-column [header] = "'ID'"></igx-column>
IgxColumnComponent
Sets/gets the class selector of the column header.
let columnHeaderClass = this.column.headerClasses;
<igx-column [headerClasses] = "'column-header'"></igx-column>
IgxColumnComponent
Sets/gets the class selector of the column group header.
let columnHeaderClass = this.column.headerGroupClasses;
<igx-column [headerGroupClasses] = "'column-group-header'"></igx-column>
IgxColumnComponent
Sets conditional style properties on the column header group wrapper.
Similar to ngStyle it accepts an object literal where the keys are
the style properties and the value is the expression to be evaluated.
styles = {
background: 'royalblue',
color: (column) => column.pinned ? 'red': 'inherit'
}
<igx-column [headerGroupStyles]="styles"></igx-column>
IgxColumnComponent
Sets conditional style properties on the column header.
Similar to ngStyle it accepts an object literal where the keys are
the style properties and the value is the expression to be evaluated.
styles = {
background: 'royalblue',
color: (column) => column.pinned ? 'red': 'inherit'
}
<igx-column [headerStyles]="styles"></igx-column>
IgxColumnComponent
Returns a reference to the header template.
let headerTemplate = this.column.headerTemplate;
IgxColumnComponent
Gets whether the column is hidden.
let isHidden = this.column.hidden;
IgxColumnComponent
Gets the column index.
let columnIndex = this.column.index;
IgxColumnComponent
Returns a reference to the inline editor template.
let inlineEditorTemplate = this.column.inlineEditorTemplate;
IgxColumnComponent
Returns the level of the column in a column group.
Returns 0 if the column doesn't have a parent.
let columnLevel = this.column.level;
IgxColumnComponent
Sets/gets the maximum width of the column.
let columnMaxWidth = this.column.width;
<igx-column [maxWidth] = "'150px'"></igx-column>
IgxColumnComponent
Sets/gets the minimum width of the column.
Default value is 88;
let columnMinWidth = this.column.minWidth;
<igx-column [minWidth] = "'100px'"></igx-column>
IgxColumnComponent
Sets/gets the parent column.
let parentColumn = this.column.parent;
this.column.parent = higherLevelColumn;
IgxColumnComponent
Gets whether the column is pinned.
let isPinned = this.column.pinned;
IgxColumnComponent
Pass optional parameters for DatePipe and/or DecimalPipe to format the display value for date and numeric columns.
Accepts an IColumnPipeArgs object with any of the format, timezone and digitsInfo properties.
For more details see https://angular.io/api/common/DatePipe and https://angular.io/api/common/DecimalPipe
const pipeArgs: IColumnPipeArgs = {
format: 'longDate',
timezone: 'UTC',
digitsInfo: '1.1-2'
}
<igx-column dataType="date" [pipeArgs]="pipeArgs"></igx-column>
<igx-column dataType="number" [pipeArgs]="pipeArgs"></igx-column>
IgxColumnComponent
Sets/gets whether the column is resizable.
Default value is false.
let isResizable = this.column.resizable;
<igx-column [resizable] = "true"></igx-column>
IgxColumnComponent
Row index where the current field should end. The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field
<igx-column-layout>
<igx-column [rowEnd]="2" [rowStart]="1" [colStart]="1"></igx-column>
</igx-column-layout>
IgxColumnComponent
Row index from which the field is starting.
<igx-column-layout>
<igx-column [rowStart]="1" [colStart]="1"></igx-column>
</igx-column-layout>
IgxColumnComponent
Sets/gets whether the column is searchable.
Default value is true.
let isSearchable = this.column.searchable';
<igx-column [searchable] = "false"></igx-column>
IgxColumnComponent
Returns if the column is selectable.
let columnSelectable = this.column.selectable;
IgxColumnComponent
Returns if the column is selected.
let isSelected = this.column.selected;
IgxColumnComponent
Gets the column sortStrategy.
let sortStrategy = this.column.sortStrategy
IgxColumnComponent
Sets/gets whether the column is sortable.
Default value is false.
let isSortable = this.column.sortable;
<igx-column [sortable] = "true"></igx-column>
IgxColumnComponent
Sets/gets whether the column sorting should be case sensitive.
Default value is true.
let sortingIgnoreCase = this.column.sortingIgnoreCase;
<igx-column [sortingIgnoreCase] = "false"></igx-column>
IgxColumnComponent
Gets the column summaries.
let columnSummaries = this.column.summaries;
IgxColumnComponent
The summaryFormatter is used to format the display of the column summaries.
In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers.
columnInit(column: IgxColumnComponent) {
if (column.field == "OrderDate") {
column.summaryFormatter = this.summaryFormat;
}
}
summaryFormat(summary: IgxSummaryResult, summaryOperand: IgxSummaryOperand): string {
const result = summary.summaryResult;
if(summaryResult.key !== 'count' && result !== null && result !== undefined) {
const pipe = new DatePipe('fr-FR');
return pipe.transform(result,'mediumDate');
}
return result;
}
IgxColumnComponent
Returns a reference to the summaryTemplate.
let summaryTemplate = this.column.summaryTemplate;
IgxColumnComponent
Sets/gets the title value.
let title = this.column.title;
<igx-column [title] = "'Some column tooltip'"></igx-column>
IgxColumnComponent
Returns a reference to the top level parent column.
let topLevelParent = this.column.topLevelParent;
Gets the column visible index.
If the column is not visible, returns -1.
let visibleColumnIndex = this.column.visibleIndex;
IgxColumnComponent
Indicates whether the column will be visible when its parent is collapsed.
<igx-column-group>
<igx-column [visibleWhenCollapsed]="true"></igx-column>
</igx-column-group>
IgxColumnComponent
Gets the width of the column.
let columnWidth = this.column.width;
IgxColumnComponent
Autosize the column to the longest currently visible cell value, including the header cell.
@ViewChild('grid') grid: IgxGridComponent;
let column = this.grid.columnList.filter(c => c.field === 'ID')[0];
column.autosize();
IgxColumnComponent
Set if column should be autosized based only on the header content.
Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.
Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.
Moves a column to the specified visible index. If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. If passed index would move the column to a different column group. moving is not performed.
column.move(index);
IgxColumnComponent
Pins the column at the provided index in the pinned area.
Defaults to index 0 if not provided, or to the initial index in the pinned area.
Returns true if the column is successfully pinned. Returns false if the column cannot be pinned.
Column cannot be pinned if:
let success = this.column.pin();
IgxColumnComponent
Returns the first element that is a descendant of node that matches selectors.
Returns all element descendants of node that match selectors.
Displays element fullscreen and resolves promise when done.
When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.
If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.
Returns true if qualifiedName is now present, and false otherwise.
Unpins the column and place it at the provided index in the unpinned area.
Defaults to index 0 if not provided, or to the initial index in the unpinned area.
Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned.
Column cannot be unpinned if:
let success = this.column.unpin();
IgxColumnComponent
Ignite UI for Angular Column - Documentation
The Ignite UI Column is used within an
igx-gridelement to define what data the column will show. Features such as sorting, filtering & editing are enabled at the column level. You can also provide a template containing custom content inside the column usingng-templatewhich will be used for all cells within the column.Igx Parent
IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, IgxRowIslandComponent, IgxColumnGroupComponent, IgxColumnLayoutComponent