dundas.controls.DataGrid Class

 

Inheritance Hierarchy

 
Class
   dundas.controls.DataControl
      dundas.controls.DataGrid
 

Properties

 
  Name Description
allowMultipleRowSelection Gets or sets a value indicating whether multiple rows can be selected and de-selected by clicking.
altRowCellStyleDefinition Gets or sets the StyleDefinition for the body alternate row cells.
animationType Gets or sets the animation type in measure cells which will be highlighted.
annotationStyleDefinition Gets or sets the StyleDefinition for cell annotation indicators.
autoFitToFill Gets or sets a value indicating whether columns without a set width are automatically resized to fit within the table and fill its width.
background Gets or sets the brush used to fill the background of the control. Inherited from dundas.controls.DataControl.
bodyStyleDefinition Gets or sets the StyleDefinition for the body table.
borderBrush Gets or sets the brush used to fill the border around the control. Inherited from dundas.controls.DataControl.
borderRadius Gets or sets the radius in pixels for rounding the corners of the border. Inherited from dundas.controls.DataControl.
borderStyle Gets or sets the style of the border around the control. Inherited from dundas.controls.DataControl.
borderWidth Gets or sets the width of the border around the control. Inherited from dundas.controls.DataControl.
canvasService Gets the canvas service associated with this control. Inherited from dundas.controls.DataControl.
cellBottomBorderWidth Gets or sets the width of the body cell and row header cell bottom border.
cellLeftBorderWidth Gets or sets the width of the body cell and column header cell left border.
cellPadding Gets or sets the cell padding.
cellRightBorderWidth Gets or sets the width of the body cell and column header cell right border.
cellStyleDefinition Gets or sets the StyleDefinition for body cells.
cellTopBorderWidth Gets or sets the width of the body cell and row header cell top border.
cellValueChangeColor Gets or sets the measure cell value change highlight color.
cellValueChangeDuration Gets or sets the measure cell value change highlight duration in milliseconds.
columnExpandedHeaderCellStyleDefinition Gets or sets the StyleDefinition for the column header expanded cells.
columnGrandTotalStyleDefinition Gets or sets the StyleDefinition for the grand total column cells.
columnGroupHeaderBottomBorderColor Gets or sets the color of the column group header's bottom border.
columnGroupHeaderVerticalBorderColor Gets or sets the color of the column group header's vertical border.
columnHeaderBottomCellPadding Gets or sets the column header bottom cell padding.
columnHeaderCellColor Gets or sets the color of the column header cell.
columnHeaderCellStyleDefinition Gets or sets the StyleDefinition for the column header cells.
columnHeaderExpandedCellColor Gets or sets the color of the column header expanded cell.
columnHeaderExpanderColor Gets or sets the StyleDefinition of the column header expander.
columnHeaderGrandTotalStyleDefinition Gets or sets the StyleDefinition for the grand total column header cells.
columnHeaderHorizontalBorderColor Gets or sets the color of the column header's horizontal border.
columnHeaderHorizontalBorderWidth Gets or sets the column header horizontal border width.
columnHeaderLastRowBackgroundColor Gets or sets the background color of the column header's last row.
columnHeaderLastRowBorderColor Gets or sets the border color of the column header's last row.
columnHeaderLastRowCellStyleDefinition Gets or sets the StyleDefinition for the column header's last row cells.
columnHeaderSpacingWidth Gets or sets the spacing between the column header and body.
columnHeaderTextRotationAngle Gets or sets the text rotation angle (in degrees) of column header.
columnHeaderTopCellPadding Gets or sets the column header top cell padding.
columnHeaderVerticalBorderColor Gets or sets the color of the column header's vertical border.
columnHierarchyHeaders Gets or sets the column hierarchy header definitions for customizing column hierarchy headers.
columnHierarchyTextWrap Gets or sets the column hierarchy text wrapping.
columns Gets or sets the column definitions for customizing columns.
compactHeaderTextWrap Gets or sets the compact row header text wrapping.
compactRowHeaderCaption Gets or sets the compact row header caption in the table.
compactRowHeaderMeasureColumnWidth Gets or sets the compact row header measure column width in the table when transposed.
compactRowHeaderWidth Gets or sets the compact row header width in the table.
container Gets the DOM element this control will render to. Inherited from dundas.controls.DataControl.
cornerHeaderBottomBorderBrush Gets or sets a brush to apply along the bottom of the corner header cells.
cornerHeaderBottomBorderBrushWidth Gets or sets the width of the corner header bottom border brush in pixels.
cornerHeaderHorizontalBorderColor Gets or sets the color of the corner header's horizontal border.
cornerHeaderTableCellStyleDefinition Gets or sets the StyleDefinition for the corner header cell.
cornerHeaderTableStyleDefinition Gets or sets the StyleDefinition for the corner header.
cornerHeaderVerticalBorderColor Gets or sets the color of the corner header's vertical border.
desiredHeight Gets the desired height of this control.
filterIndicatorDisplayMode Gets or sets the header filter indicator display mode.
frozenBodyBorderColor Gets or sets the frozen body border color.
frozenBodyBorderStyle Gets or sets the frozen body border style.
frozenBodyBorderWidth Gets or sets the frozen body border width.
frozenHeaderBorderColor Gets or sets the frozen header border color.
frozenHeaderBorderStyle Gets or sets the frozen header border style.
frozenHeaderBorderWidth Gets or sets the frozen header border width.
frozenTotalRowStyleDefinition Gets or sets the StyleDefinition for the frozen total cells.
gridPadding Gets or sets the padding around the table.
gridStyleDefinition Gets or sets the StyleDefinition for the grid.
groupRowCellStyleDefinition Gets or sets the StyleDefinition for the column group header's cell.
height Gets the current rendered height of the control. Inherited from dundas.controls.DataControl.
horizontalSplitterWidth Gets or sets the horizontal splitter width.
hoverStyleDefinition Gets or sets the StyleDefinition for the hover style.
id Gets or sets the unique ID of the data grid. Inherited from dundas.controls.DataControl.
indentationWidth Gets or sets the Single Indented column's indentation width.
innerPadding Gets the total padding reserved between the boundaries of the control and its content. Inherited from dundas.controls.DataControl.
isAligning Gets or sets a value indicating whether the control is currently being aligned. Inherited from dundas.controls.DataControl.
isCellValueChangedHighlighted Gets or sets a value indicating whether value changes in measure cells will be highlighted.
isChildItemCountShownInTotal Gets or sets a value indicating whether total caption should include child item count.
isCollapsingSeparateHierarchyAllowed Gets or sets a value indicating whether the values of one hierarchy can be collapsed into a value from the previous hierarchy.
isColorSelfAligning Gets or sets a value indicating whether this table displays colors based on the same range of values in every copy when repeated.
isColumnHeaderShown Gets or sets a value indicating whether column headers are shown.
isColumnHeaderTextRotated Gets or sets to rotate column header text.
isColumnHierarchyHeaderShown Gets or sets a value indicating whether column headers are shown.
isColumnMergeEnabled Gets or sets a value indicating whether adjacent column headers with the same header text will be merged.
isColumnReorderEnabled Gets or sets a value indicating whether viewers can drag and drop column headers to reorder them.
isColumnResizeEnabled Gets a value indicating if column resize is enabled or not.
isDrawPending Gets a value indicating whether the control is about to re-draw. Inherited from dundas.controls.DataControl.
isExpanderShownOnHover Gets or sets a value indicating whether the expander buttons in row and column headers will be shown only when hovered over or tapped.
isFilteringOptionShown Gets a value indicating if the filter option will be displayed in the popup dialog.
isGrandTotalHidden Gets or sets a value indicating whether the grand total will be hidden in single indented column layout.
isHeaderMenuShown Gets or sets a value indicating whether the column header menu for sorting and filtering is displayed when hovered over or tapped.
isKeyboardSelectionOn Gets or sets a value indicating whether selection using the keyboard is enabled if isSelectionOn is true.
isOneClickSortEnabled Gets or sets the one click sort.
isOneClickSortIgnoringGrouping Gets or sets a value indicating whether one click sorting for measures ignores hierarchical grouping and sorts rows independently.
isRedundantColumnHeaderShown Gets or sets a value indicating whether column headers are shown for a single column repeated by a columns hierarchy.
isRowHeaderTooltipShown Gets or sets a value indicating whether tooltips will be shown when row headers are hovered over or long-tapped.
isRowNumberShown Gets or sets a value indicating whether a column of row numbers is displayed in the table.
isRowNumberTooltipShown Gets or sets a value indicating whether to display row number as tooltip while scrolling.
isSelectionOn Gets or sets a value indicating whether row, column and body cell selection is enabled.
isSeparateStyleSheetEnabledInReport Gets or sets a value indicating whether separate style definitions are supported for each table in repeater view mode.
isSortingOptionShown Gets a value indicating if the sort option will be displayed in the popup dialog.
isStateStyleAppliedToEntireRow Gets or sets a value indicating whether state styles set up for one column will apply to the entire row of column cells.
isStateStyleAppliedToRowHeader Gets or sets a value indicating whether state styles set up will apply to row header cells.
isTotalRowFrozen Gets or sets a value indicating whether row totals will be frozen in the table.
isTotalsAtBottom Gets or sets a value indicating whether totals will be shown at the bottom rather than the top.
isTouchSelectingEnabled Gets or sets a value indicating whether selecting text is currently enabled on touch devices.
isVisible Gets a value indicating if the data grid is visible or not.
legend Gets or sets the legend used by this control. Inherited from dundas.controls.DataControl.
maxRowCount Gets or sets the maximum number of rows to be displayed in the table when Auto Expand To Fit option is enabled.
missingDataStyleDefinition Gets or sets the StyleDefinition for measure cells displayed where the value is missing from the original data source.
padding Gets or sets the padding reserved between the boundaries of the control and its content. Inherited from dundas.controls.DataControl.
renderMode Gets or sets the row header mode.
resizedRowViewWidth Gets or sets a fixed width set in pixels for the row header view.
rowExpandedHeaderCellStyleDefinition Gets or sets the StyleDefinition for the row header expanded cells.
rowHeaderCellStyleDefinition Gets or sets the StyleDefinition for the row header cells.
rowHeaderColumns Gets or sets the row header column definitions for customizing row header columns.
rowHeaderExpanderColor Gets or sets the color of the row header expander.
rowHeaderFrozenTotalRowStyleDefinition Gets or sets the StyleDefinition for the row header frozen total cells.
rowHeaderGrandTotalStyleDefinition Gets or sets the StyleDefinition for the grand total row cells.
rowHeaderSpacingWidth Gets or sets the spacing between the row header and body.
rowHeaderTableStyleDefinition Gets or sets the StyleDefinition for the row header table.
rowHeaderTotalRowStyleDefinition Gets or sets the StyleDefinition for the row header total cells.
scrollBarWidth Gets or sets the scroll bar width.
selectStyleDefinition Gets or sets the StyleDefinition for the selection style.
spacingColor Gets or sets the spacing color.
splitterColor Gets or sets the splitter color.
subtotalText Gets or sets the text displayed for the subtotal rows.
tableContainer Gets the table container.
totalRowStyleDefinition Gets or sets the StyleDefinition for the total cells.
totalText Gets or sets the text displayed for the (grand) total row.
verticalSplitterWidth Gets or sets the vertical splitter width.
width Gets the current rendered width of the control. Inherited from dundas.controls.DataControl.
 
 

Methods

 
  Name Description
addNewStyleManager
alignHorizontallyWith Aligns the content of this control horizontally with the specified control. Inherited from dundas.controls.DataControl.
alignVerticallyWith Aligns the content of this control vertically with the specified control. Inherited from dundas.controls.DataControl.
applyDefaultStyle Applies default style of the data grid.
applyStateStyles Applies the state styles.
clearAllSelection Clears all selected rows and columns in the table.
clearColumnSelection Clears previously selected columns in the table.
clearDataGrid Clears the data grid.
clearHorizontallyAligned Removes all controls from horizontal alignment with this instance. Inherited from dundas.controls.DataControl.
clearRowSelection Clears previously selected rows in the table.
clearVerticallyAligned Removes all controls from vertical alignment with this instance. Inherited from dundas.controls.DataControl.
destroy Removes the data control elements from the container. This is called automatically if the container property is changed. Inherited from dundas.controls.DataControl.
displayStyle Applies the table styles.
draw Re-draws the data control immediately if invalidated. This method is normally called automatically when needed. Inherited from dundas.controls.DataControl.
fromJObject Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
getColumnsByElement Gets the table columns displaying the element identified by the specified unique name.
getColumnsByHeaderText Gets the table columns displaying the specified header text.
getHorizontallyAligned Gets an array of controls set to be horizontally aligned with this control. Inherited from dundas.controls.DataControl.
getSelectedColumnOrdinals Returns an array of selected column ordinals.
getSelectedRowOrdinals Returns an array of selected row ordinals.
getTableCellFromTargetElement Returns the table cell.
getTableCellText Returns the text displayed in a table cell.
getVerticallyAligned Gets an array of controls set to be vertically aligned with this control. Inherited from dundas.controls.DataControl.
hitTest Determines what data control element is represented at the specified position. Inherited from dundas.controls.DataControl.
invalidate Ensures the data control is re-drawn using the current data and settings at the next best time made available by the browser. This method is normally called automatically when needed. Inherited from dundas.controls.DataControl.
invalidateSize Notifies the control that its container element size may have changed. Inherited from dundas.controls.DataControl.
isAlignedHorizontallyWith Gets a value indicating whether the specified control has been aligned horizontally with this instance. Inherited from dundas.controls.DataControl.
isAlignedVerticallyWith Gets a value indicating whether the specified control has been aligned vertically with this instance. Inherited from dundas.controls.DataControl.
onDOMDetach Called when the DOM element this control will render to is temporarily detached. Inherited from dundas.controls.DataControl.
onDOMReattach Called when the DOM element this control will render to is re-attached. Inherited from dundas.controls.DataControl.
removeHorizontallyAligned Removes the specified control from the list to be horizontally aligned with this control. Inherited from dundas.controls.DataControl.
removeVerticallyAligned Removes the specified control from the list to be vertically aligned with this control. Inherited from dundas.controls.DataControl.
scroll Scroll this data grid control.
selectBodyCell Select a cell in the table body by given row and column indexes.
selectColumns Select columns currently displayed in the table by their indexes according to their position.
selectColumnsByOrdinals Select columns in the table by column ordinals corresponding to the column tuple ordinals in the cellset.
selectRows Select rows currently displayed in the table by the given row indexes.
selectRowsByOrdinals Select rows in the table by the given row ordinals.
setScroll Scroll this data grid control by given offsets.
toJSON Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.