DataGrid: компонент

Компонент DataGrid представляет собой таблицу с данными.

Комментарии

Компонент предназначен для визуального представления данных в виде таблицы. Данные в таблицу могут загружаться как синхронно, так и асинхронно. Для работы с ним используется класс DGDataSource. Классы DGRow и DGColumn представляют функции для работы со строками и столбцами таблицы соответственно. Данные таблицы можно форматировать, для этого используется класс DGFormater.

Пример

Конструктор

Свойства

	Имя свойства	Краткое описание
	AdditionalData	Свойство AdditionalData определяет дополнительные данные для асинхронной таблицы.
	AutoSizeType	Свойство AutoSizeType определяет режим автоматического определения размеров ячеек таблицы.
	BackgroundCSS	Свойство BackgroundCSS определяет цвет заливки контейнера таблицы.
	BodyContainer	Свойство BodyContainer определяет контейнер ячеек таблицы.
	BodyTable	Свойство BodyTable определяет DOM-элемент, представляющий ячейки таблицы.
	CalcPercentType	Свойство CalcPercentType определяет тип расчёта ширины столбца таблицы в процентах.
	ChangedCells	Свойство ChangedCells определяет ячейки таблицы с изменёнными значениями.
	DataSource	Свойство DataSource определяет источник данных таблицы.
	DefaultDateFormat	Свойство DefaultDateFormat определяет формат даты в таблице по умолчанию.
	EnableAutoSize	Свойство EnableAutoSize определяет признак автоматического расчета размера элементов таблицы.
	EnableBacklight	Свойство EnableBacklight определяет признак того, применяется ли подсветка строки при наведении на нее курсора мыши.
	EnableColumnMove	Свойство EnableColumnMove определяет признак того, разрешено ли перемещение заголовков столбцов таблицы.
	EnableCopyPaste	Свойство EnableCopyPaste определяет признак того, разрешены ли копирование и вставка строк таблицы.
	EnableEdit	Свойство EnableEdit определяет признак того, разрешено ли редактирование ячеек таблицы.
	EnableHTMLInCells	Свойство EnableHTMLInCells определяет признак того, разрешено ли использование HTML-разметки в ячейках таблицы.
	EnableHyphenationAutoSize	Свойство EnableHyphenationAutoSize определяет способ расчёта максимальной ширины ячейки таблицы в режиме автоопределения их размера.
	EnableRowResize	Свойство EnableRowResize определяет признак того, разрешено ли изменение высоты строк таблицы.
	EnableSelection	Свойство EnableSelection определяет признак того, разрешено ли в таблице выделение строк.
	FireProcessingNodeEvent	Свойство FireProcessingNodeEvent определяет признак того, будет ли генерироваться событие DataGrid.ProcessingNode при обработке DOM-элементов таблицы.
	FirstVisibleRow	Свойство FirstVisibleRow определяет индекс первой видимой строки в таблице.
	Formater	Свойство Formater определяет объект для форматирования данных таблицы.
	GridBorderWidth	Свойство GridBorderWidth определяет ширину сетки таблицы.
	HeaderContainer	Свойство HeaderContainer определяет DOM-элемент, представляющий контейнер заголовка таблицы.
	HeaderTable	Свойство HeaderTable определяет DOM-элемент, представляющий таблицу с ячейками заголовка.
	IsFixedHeader	Свойство IsFixedHeader определяет признак того, является ли заголовок таблицы фиксированным.
	IsNeedToDrawBorders	Свойство IsNeedToDrawBorders определяет признак того, отображаются ли границы ячеек таблицы.
	LastHScrollBarPos	Свойство LastHScrollBarPos определяет позицию ползунка на горизонтальной полосе прокрутки.
	LastVisibleRow	Свойство LastVisibleRow определяет индекс последней видимой строки в таблице.
	LastVScrollBarPos	Свойство LastVScrollBarPos определяет позицию ползунка на вертикальной полосе прокрутки.
	Measures	Свойство Measures определяет измерения таблицы.
	MinColumnWidth	Свойство MinColumnWidth определяет минимальную ширину столбцов таблицы.
	MinRowHeight	Свойство MinRowHeight определяет минимальную высоту строки таблицы.
	MinWidth	Свойство MinWidth определяет минимальную ширину таблицы.
	MinWidthByContent	Свойство MinWidthByContent определяет способ расчета минимальный ширины таблицы.
	MouseWheelScrollStep	Свойство MouseWheelScrollStep определяет шаг прокрутки таблицы в пикселях с помощью колёсика мыши.
	NearLimit	Свойство NearLimit определяет количество непрокрученных строк асинхронной таблицы, при котором в источник будет загружена очередная порция данных.
	PasteMode	Свойство PasteMode определяет режим вставки данных в таблицу.
	RealAdditionalRows	Свойство RealAdditionalRows определяет сопоставление реальных индексов рядам дополнительных данных для асинхронной таблицы.
	RealToGlobalIndexes	Свойство RealToGlobalIndexes определяет сопоставление реальных и глобальных индексов рядов данных таблицы.
	RemoveHtmlWhenSort	Свойство RemoveHtmlWhenSort определяет признак того, будут ли удаляться HTML-теги из значений ячеек при сортировке.
	Rows	Свойство Rows определяет массив строк таблицы.
	RowSelectType	Свойство RowSelectType определяет режим выделения в таблице.
	RowsToBuffer	Свойство RowsToBuffer определяет количество подгружаемых строк данных при прокрутке асинхронной таблицы.
	ScrollingSlowMotionInterval	Свойство ScrollingSlowMotionInterval определяет длительность задержки прокрутки таблицы в миллисекундах.
	SortByValue	Свойство SortByValue определяет значение ячейки, по которому сортируется таблица.
	SortIconAsc	Свойство SortIconAsc определяет путь до пиктограммы, обозначающей сортировку по возрастанию.
	SortIconDesc	Свойство SortIconDesc определяет путь до пиктограммы, обозначающей сортировку по убыванию.
	SortIconHeight	Свойство SortIconHeight определяет высоту пиктограммы сортировки таблицы.
	SortIconWidth	Свойство SortIconWidth определяет ширину пиктограммы сортировки таблицы.
	SortInfo	Свойство SortInfo содержит информацию о сортировке.
	StartRowIndex	Свойство StartRowIndex определяет первый индекс ряда загруженных данных.
	TableContainer	Свойство TableContainer содержит контейнер таблицы.
	VisibleRowsHeight	Свойство VisibleRowsHeight определяет сумму высот всех видимых строк таблицы.

Методы

	Имя метода	Краткое описание
	addRow	Метод addRow добавляет строку в таблицу.
	calcCoordUnderMouse	Метод calcCoordUnderMouse возвращает объект с информацией о текущей позиции курсора мыши.
	clearAllDgRows	Метод clearAllDgRows удаляет все строки в массиве строк таблицы.
	clearSelection	Метод clearSelection удаляет выделение ячеек таблицы.
	closeCellEditor	Метод closeCellEditor закрывает текущий редактор ячеек.
	compare	Метод compare сравнивает два значения между собой.
	copy	Метод copy копирует содержимое диапазонов рядов данных таблицы во внутренний буфер.
	createDgRow	Метод createDgRow создаёт ряд данных для таблицы.
	createDgRowAndRender	Метод createDgRowAndRender создаёт и добавляет ряд данных в таблицу.
	deleteRows	Метод deleteRows удаляет строки из таблицы.
	eachRowInSource	Метод eachRowInSource выполняет указанную функцию для каждого ряда данных таблицы.
	edit	Метод edit запускает режим редактирования ячейки таблицы.
	findDgRowByRealIndex	Метод findDgRowByRealIndex возвращает ряд данных таблицы по его реальному индексу.
	findRowByIndex	Метод findRowByIndex возвращает строку таблицы по индексу.
	getActiveSelectedRange	Метод getActiveSelectedRange возвращает активный (последний выделенный) диапазон таблицы.
	getAdjustmentMgr	Метод getAdjustmentMgr возвращает менеджер для изменения высоты строк и ширины столбцов таблицы.
	getCellInSource	Метод getCellInSource возвращает значение ячейки таблицы.
	getCellValueInSource	Метод getCellValueInSource возвращает значение ячейки из источника данных таблицы.
	getChangedMeasures	Метод getChangedMeasures возвращает изменённые элементы измерений таблицы.
	getClipboardContainsData	Метод getClipboardContainsData возвращает содержимое буфера обмена.
	getColumnMoveMgr	Метод getColumnMoveMgr возвращает менеджер для управления перемещением столбцов таблицы.
	getColumnVisibility	Метод getColumnVisibility возвращает признак видимости указанного столбца.
	getCoordInfo	Метод getCoordInfo возвращает объект с информацией о ячейке таблицы, в которой находится курсор мыши.
	getCoordUnderMouse	Метод getCoordUnderMouse возвращает объект с координатами, где находится курсор мыши.
	getCurrentCellEditor	Метод getCurrentCellEditor возвращает текущий редактор ячейки.
	getCurrentHorizontalScrollValue	Метод getCurrentHorizontalScrollValue возвращает текущее положение горизонтальной полосы прокрутки.
	getEnableAutoSizeAtColumn	Метод getEnableAutoSizeAtColumn возвращает признак того, разрешено ли автоопределение ширины для указанного столбца таблицы.
	getFirstVisibleTr	Метод getFirstVisibleTr возвращает DOM-элемент, представляющий первую видимую строку таблицы.
	getHeaderHeight	Метод getHeaderHeight возвращает высоту заголовка таблицы.
	getHeaderWidth	Метод getHeaderWidth возвращает ширину заголовка таблицы.
	getHorizontalScrollContainer	Метод getHorizontalScrollContainer возвращает контейнер таблицы, которым управляет горизонтальная полоса прокрутка.
	getHScrollBar	Метод getHScrollBar возвращает горизонтальную полосу прокрутки.
	getHScrollBarContainer	Метод getHScrollBarContainer возвращает контейнер горизонтальной полосы прокрутки.
	getHScrollbarHeight	Метод getHScrollbarHeight возвращает высоту горизонтальной полосы прокрутки.
	getHScrollBarId	Метод getHScrollBarId возвращает идентификатор горизонтальной полосы прокрутки.
	getPrevColumnOnYCoord	Метод getPrevColumnOnYCoord возвращает DOM-элемент, представляющий предыдущую ячейку строки.
	getPrevCoordUnderMouse	Метод getPrevCoordUnderMouse возвращает сохраненный объект с информацией о позиции курсора мыши.
	getPrevTrOnXCoord	Метод getPrevTrOnXCoord возвращает DOM-элемент, представляющий предыдущую ячейку столбца.
	getRenderedRowIndexes	Метод getRenderedRowIndexes возвращает индексы всех отрисованных в данный момент рядов данных таблицы.
	getScrollContainer	Метод getScrollContainer возвращает контейнер таблицы, которым управляют элементы прокрутки.
	getScrollContainerIndent	Метод getScrollContainerIndent возвращает верхний отступ контейнера для прокрутки таблицы.
	getScrollObject	Метод getScrollObject возвращает DOM-вершину, предназначенную для плавной прокрутки таблицы.
	getSelectedCoord	Метод getSelectedCoord возвращает объект со стартовыми координатами выделения строк таблицы.
	getSelectedRanges	Метод getSelectedRanges возвращает выделенные диапазоны таблицы.
	getSelection	Метод getSelection возвращает объект выделения таблицы.
	getStylesContainer	Метод getStylesContainer возвращает стили таблицы.
	getTableContainerId	Метод getTableContainerId возвращает идентификатор контейнера таблицы.
	getVisibleHeight	Метод getVisibleHeight возвращает видимую высоту таблицы.
	getVisibleWidth	Метод getVisibleWidth возвращает видимую ширину таблицы.
	getVScrollBar	Метод getVScrollBar возвращает вертикальную полосу прокрутки.
	getVScrollBarContainer	Метод getVScrollBarContainer возвращает контейнер вертикальной полосы прокрутки.
	getVScrollBarId	Метод getVScrollBarId возвращает идентификатор вертикальной полосы прокрутки.
	getVScrollbarWidth	Метод getVScrollbarWidth возвращает ширину вертикальной полосы прокрутки.
	insertRows	Метод insertRows добавляет строки в объект с данными таблицы.
	loadMeasuresFromDataSource	Метод loadMeasuresFromDataSource загружает измерения из источника данных таблицы.
	loadRangesFromDataSource	Метод loadRangesFromDataSource загружает диапазоны рядов данных таблицы из источника.
	loadVisibleRanges	Метод loadVisibleRanges загружает незагруженные видимые диапазоны рядов данных таблицы из источника.
	mask	Метод mask делает таблицу недоступной для изменений.
	refresh	Метод refresh обновляет таблицу.
	renderVisibleRows	Метод renderVisibleRows отрисовывает видимые строки таблицы, начиная с заданного индекса.
	reset	Метод reset повторно загружает данные таблицы из источника.
	selectAll	Метод selectAll выделяет все строки таблицы.
	setCellStyleIndex	Метод setCellStyleIndex устанавливает стиль с указанным индексом для ячейки таблицы.
	setCellValueInSource	Метод setCellValueInSource устанавливает новое значение ячейки в источнике данных таблицы.
	setColumnVisibility	Метод setColumnVisibility устанавливает признак видимости указанного столбца.
	setEmptyColumnStyleIndex	Метод setEmptyColumnStyleIndex устанавливает индекс стиля у столбца для вертикальной полосы прокрутки.
	sort	Метод sort сортирует строки таблицы.
	sortAsc	Метод sortAsc сравнивает два значения между собой в прямом порядке.
	sortDesc	Свойство SortIconDesc определяет путь до пиктограммы, обозначающей сортировку по убыванию.
	unmask	Метод unmask делает таблицу доступной для изменений.

События

	Имя события	Краткое описание
	AdditionalRangesLoaded	Событие AdditionalRangesLoaded наступает при загрузке дополнительных диапазонов рядов данных таблицы.
	BeforeProcessResize	Событие BeforeProcessResize наступает перед изменением ширины столбца таблицы.
	Buffering	Событие Buffering наступает при загрузке диапазонов рядов данных таблицы из источника.
	ColumnResized	Событие ColumnResized наступает после изменения ширины столбца таблицы.
	ContainerRendered	Событие ContainerRendered наступает при повторной загрузке данных таблицы из источника.
	ControlRendered	Событие ControlRendered наступает при отрисовке редактора значений для ячейки таблицы.
	CoordUnderMouseChanged	Событие CoordUnderMouseChanged наступает при перемещении позиции курсора из одной области отрисовки ячейки в другую.
	Copied	Событие Copied наступает при завершении копирования строк таблицы.
	Copying	Событие Copying наступает при начале копирования строк таблицы.
	DataLoaded	Событие DataLoaded наступает после загрузки данных в таблицу.
	DeletingRows	Событие DeletingRows наступает перед удалением строк таблицы.
	HeaderDblClick	Событие HeaderDblClick наступает при двойном щелчке по заголовку таблицы.
	HorizontalScrollChanged	Событие HorizontalScrollChanged наступает после изменения положения горизонтальной полосы прокрутки.
	InsertingRows	Событие InsertingRows наступает при начале вставки строк в таблицу в асинхронном режиме.
	MeasuresParsed	Событие MeasuresParsed наступает при получении измерений источника данных таблицы.
	MouseMove	Событие MouseMove наступает при движении курсора по таблице.
	Pasted	Событие Pasted наступает при завершении вставки строк таблицы.
	Pasting	Событие Pasting наступает при начале вставки строк таблицы.
	ProcessingNode	Событие ProcessingNode наступает при обработке DOM-элементов таблицы.
	Rendered	Событие Rendered наступает после завершения отрисовки таблицы.
	Rendering	Событие Rendering наступает при начале отрисовки таблицы.
	Resizing	Событие Resizing наступает при начале изменения размеров заголовка таблицы.
	RowDblClick	Событие RowDblClick наступает после двойного нажатия на строку таблицы.
	RowResized	Событие RowResized наступает после изменения высоты строки таблицы.
	RowsDeleted	Событие RowsDeleted наступает после удаления строк таблицы.
	RowsInserted	Событие RowsInserted наступает при завершении вставки строк в таблицу в асинхронном режиме.
	SavedMeasures	Событие SavedMeasures наступает при завершении сохранения изменений в измерениях источника данных таблицы.
	SavedRanges	Событие SavedRanges наступает при завершении сохранения диапазонов рядов данных таблицы.
	SavingMeasures	Событие SavingMeasures наступает при начале сохранения изменений в измерениях источника данных таблицы.
	SavingRanges	Событие SavingRanges наступает при начале сохранения диапазонов рядов данных таблицы.
	ScrollChanged	Событие ScrollChanged наступает после изменения положения полос прокрутки.
	Sorted	Событие Sorted наступает после сортировки данных таблицы.
	Sorting	Событие Sorting наступает перед сортировкой данных таблицы.
	VerticalScrollChanged	Событие VerticalScrollChanged наступает после изменения положения вертикальной полосы прокрутки.

Свойства, унаследованные от класса Control

	Имя свойства	Краткое описание
	Anchors	Свойство Anchors определяет позицию компонента, размещенного внутри контейнера.
	Animation	Свойство Animation определяет параметры анимации для компонента.
	Bottom	Свойство Bottom определяет отступ снизу при размещении компонента внутри LayoutPanel.
	Content	Свойство Content определяет содержимое компонента.
	ContextMenu	Свойство ContextMenu определяет контекстное меню для компонента.
	Data	Свойство Data предназначено для хранения любых пользовательских данных.
	Enabled	Свойство Enabled определяет признак доступности компонента для использования.
	Height	Свойство Height определяет высоту компонента.
	IsRTL	Свойство IsRTL определяет признак расположения элементов компонента по правому краю.
	IsVisible	Свойство IsVisible определяет признак отображения компонента.
	Left	Свойство Left определяет отступ слева при размещении компонента внутри GridPanel.
	Opacity	Свойство Opacity определяет прозрачность компонента.
	Parent	Свойство Parent определяет родительский компонент элемента управления.
	ParentNode	Свойство ParentNode определяет родительскую DOM-вершину.
	ResourceKey	Свойство ResourceKey определяет ресурсный ключ для компонента.
	Right	Свойство Right определяет отступ справа при размещении компонента внутри LayoutPanel.
	Rotate	Свойство Rotate определяет угол поворота компонента.
	ShowToolTip	Свойство ShowToolTip определяет признак возможности отображения всплывающей подсказки компонента.
	Style	Свойство Style определяет стиль для компонента.
	TabIndex	Свойство TabIndex определяет последовательность перехода элемента управления внутри контейнера.
	Tag	Свойство Tag определяет JSON-объект, ассоциированный с компонентом.
	ToolTip	Свойство ToolTip определяет текст всплывающей подсказки компонента.
	Top	Свойство Top определяет отступ сверху при размещении компонента внутри GridPanel.
	Value	Свойство Value определяет значение компонента.
	Width	Свойство Width определяет ширину компонента.

Методы, унаследованные от класса Control

	Имя метода	Краткое описание
	addClass	Метод addClass добавляет CSS-класс к компоненту.
	addEventHandler	Метод addEventHandler добавляет обработчик события на DOM-вершину.
	addStateClass	Метод addStateClass добавляет CSS-класс к компоненту и удаляет прежний CSS-класс.
	addToNode	Метод addToNode добавляет компонент в указанную вершину.
	bindEvents	Метод bindEvents подписывает элемент на все стандартные события.
	getAnchorFlags	Метод getAnchorFlags возвращает JSON-объект с настройками текущей позиции компонента.
	getClass	Метод getClass возвращает текущие css-классы компонента.
	getCssStyle	Метод getCssStyle возвращает стили для указанной вершины.
	getDomNode	Метод getDomNode возвращает главную DOM-вершину компонента.
	getFocused	Метод getFocused определяет наличие фокуса у компонента.
	getIsBinded	Метод getIsBinded возвращает признак подписи элемента на события DOM-вершины.
	hide	Метод hide скрывает элемент управления.
	hideToolTip	Метод hideToolTip очищает таймаут появления подсказки и скрывает её, если она был показана.
	refreshStyle	Метод refreshStyle обновляет CSS-стили элемента.
	removeClass	Метод removeClass удаляет CSS-класс из компонента.
	removeEventHandler	Метод removeEventHandler удаляет обработчик события DOM-вершины.
	removeFromDOM	Метод removeFromDOM удаляет вершину из DOM-структуры.
	removeStateClasses	Метод removeStateClasses удаляет CSS-классы компонента.
	setDraggable	Метод setDraggable устанавливает возможность перетаскивания компонента на HTML-странице.
	setFocus	Метод setFocus устанавливает фокус компонента.
	setIsHovered	Метод setIsHovered настраивает отображение компонента только при наведении на него курсора.
	setSize	Метод setSize устанавливает размеры компонента.
	show	Метод show отображает элемент управления.
	unBindEvents	Метод unBindEvents отписывает элемент от всех стандартных событий.
	updatePosition	Метод updatePosition корректирует размер и положение при абсолютном позиционировании на основе текущих параметров.
	updateSize	Метод updateSize обновляет размеры компонента подгонке размеров контейнера, в котором находится компонент.

	Имя события	Краткое описание
	Drag	Событие Drag наступает при нажатии и удерживании клавиши мыши.
	DragEnd	Событие DragEnd наступает при окончании перетаскивания компонента.
	DragStart	Событие DragStart наступает, когда начинается перетаскивание компонента.
	OnContextMenu	Событие OnContextMenu наступает при вызове контекстного меню компонента.
	SizeChanged	Событие SizeChanged наступает после изменения размеров компонента.
	SizeChanging	Событие SizeChanging наступает во время изменения размеров компонента.

	Имя метода	Краткое описание
	clone	Метод clone создает копию объекта.
	dispose	Метод dispose уничтожает компонент.
	getHashCode	Метод getHashCode возвращает хэш-код объекта репозитория.
	getId	Метод getId возвращает идентификатор объекта репозитория.
	getSettings	Метод getSettings возвращает настройки объекта репозитория.
	getTypeName	Метод getTypeName возвращает имя типа объекта без пространства имен, к которому он принадлежит.
	isEqual	Метод isEqual определяет, равен ли заданный объект текущему объекту репозитория.
	isLive	Метод isLive определяет действительность объекта репозитория.
	removeAllEvents	Метод removeAllEvents удаляет все обработчики событий объекта по заданному контексту.
	setId	Метод setId определяет идентификатор объекта репозитория.
	setSettings	Метод setSettings задает настройки объекта репозитория.
	defineProps	Метод defineProps создает методы get и set из массива имен для указанного класса.
	keys	Метод keys возвращает массив названий методов и свойств для указанного объекта.

DataGrid

Описание