VersionGrid
Displays a list of versions and the transactions they contain. For use with the Versions feature.
Configure the VersionGrid with a ProjectModel using the project config.
Configs
163
Configs
163Common
columnsGridBase
dataGridBase
emptyTextGridBase
featuresGridBase
keyMapGridBase
listenersEvents
preserveScrollGridBase
rowHeightGridBase
storeTreeGrid
Other
The id of the version currently being compared, if any.
dateFormat: String
The date format used for displaying date values in change actions.
The ProjectModel whose versions and changes are being observed in this grid.
Whether to show only versions that have been assigned a specific name.
Whether to display transactions not yet associated with a version.
Whether to include version rows in the display.
callOnFunctionsWidget
columnWidget
defaultFocusContainer
drawerPanel
formulaProvidersGridBase
inputFieldAlignContainer
labelPositionContainer
renditionContainer
rtlRTL
spanWidget
stateSettingsGridState
transitionGridBase
Content
bbarPanel
defaultsContainer
footerPanel
headerPanel
itemsContainer
lazyItemsContainer
namedItemsContainer
stripsPanel
tbarPanel
textContentContainer
toolsPanel
trapFocusPanel
CSS
bodyClsPanel
borderContainer
clsWidget
colorWidget
contentElementClsWidget
htmlClsWidget
itemClsContainer
styleWidget
uiPanel
DOM
adoptWidget
appendToWidget
contentWidget
datasetWidget
htmlWidget
idWidget
insertBeforeWidget
insertFirstWidget
tagWidget
Float & align
alignWidget
anchorWidget
centeredWidget
constrainToWidget
draggableWidget
floatingWidget
hideAnimationWidget
maximizeOnMobileWidget
positionedWidget
scrollActionWidget
showAnimationWidget
xWidget
yWidget
Layout
alignSelfWidget
autoHeightGridBase
collapsedPanel
collapsiblePanel
dockWidget
fillLastColumnGridBase
fixedRowHeightGridBase
flexWidget
getRowHeightGridBase
heightWidget
hiddenWidget
hideWhenEmptyContainer
layoutContainer
layoutStyleContainer
marginWidget
maxHeightWidget
maxWidthWidget
minHeightGridBase
minWidthWidget
resizeToFitIncludesHeaderGridBase
textAlignWidget
weightWidget
widthWidget
Masking
loadMaskLoadMaskable
loadMaskDefaultsLoadMaskable
loadMaskErrorLoadMaskable
syncMaskLoadMaskable
misc
tabBarItemsContainer
Misc
animateFilterRemovalsGridBase
animateRemovingRowsGridBase
bubbleEventsEvents
cellEllipsisGridBase
columnLinesGridBase
contextMenuTriggerEventGridBase
dataFieldWidget
defaultBindPropertyWidget
defaultRegionGridBase
destroyStoreGridBase
disabledWidget
disableGridRowModelWarningGridBase
elementAttributesWidget
enableStickyGridBase
enableUndoRedoKeysGridElementEvents
fullRowRefreshGridBase
hideFootersGridBase
hideHeadersGridBase
hideHorizontalScrollbarGridBase
hoverClsGridElementEvents
iconPanel
ignoreParentReadOnlyWidget
localeClassLocalizable
localizableLocalizable
localizablePropertiesLocalizable
longPressTimeGridElementEvents
maskDefaultsGridBase
maskedWidget
monitorResizeGridBase
ownerWidget
pluginsPluggable
preserveFocusOnDatasetChangeGridBase
preserveScrollOnDatasetChangeGridBase
preventTooltipOnTouchWidget
readOnlyGridBase
refWidget
responsiveLevelsGridResponsive
rippleWidget
rootElementWidget
rowLinesGridBase
showDirtyGridBase
showTooltipWhenDisabledWidget
subGridConfigsGridBase
tabWidget
titlePanel
tooltipWidget
transitionDurationGridBase
State
disableGridColumnIdWarningGridBase
statefulState
statefulEventsState
stateIdState
stateProviderState
Tree
animateTreeNodeToggleGridBase
Properties
144
Properties
144Common
columnsGridBase
dataGridBase
emptyTextGridBase
featuresGridFeatures
preserveScrollGridBase
rowHeightGridBase
storeGridBase
subGridsGridSubGrids
Class hierarchy
Identifies an object as an instance of VersionGrid class, or subclass thereof.
Identifies an object as an instance of VersionGrid class, or subclass thereof.
isContainerContainer
isDelayableDelayable
isEventsEvents
isGridGrid
isGridBaseGridBase
isGridElementEventsGridElementEvents
isGridFeaturesGridFeatures
isGridResponsiveGridResponsive
isGridSelectionGridSelection
isGridStateGridState
isGridSubGridsGridSubGrids
isKeyMapKeyMap
isLoadMaskableLoadMaskable
isLocalizableLocalizable
isPanelPanel
isPluggablePluggable
isRTLRTL
isStateState
isToolableToolable
isTreeGridTreeGrid
isWidgetWidget
Other
The id of the version currently being compared, if any.
Whether to show only versions that have been assigned a specific name.
Whether to display transactions not yet associated with a version.
Whether to include version rows in the display.
columnWidget
firstItemContainer
hasChangesContainer
inputFieldAlignContainer
isSettingValuesContainer
isStatefulState
isValidContainer
itemsContainer
labelPositionContainer
lastItemContainer
renditionContainer
rtlRTL
spanWidget
stateSettingsGridState
toolsPanel
transitionGridBase
valuesContainer
CSS
clsWidget
DOM
appendToWidget
contentWidget
contentElementWidget
datasetWidget
elementWidget
focusableElementWidget
focusElementWidget
htmlWidget
idWidget
insertBeforeWidget
insertFirstWidget
overflowElementWidget
styleWidget
Layout
alignSelfWidget
bodyHeightGridBase
collapsedPanel
collapsingPanel
expandingPanel
flexWidget
footerHeightGridBase
headerHeightGridBase
heightWidget
layoutContainer
layoutStyleContainer
marginWidget
maxHeightWidget
maxWidthWidget
minHeightWidget
minWidthWidget
scrollableWidget
widthWidget
Misc
callOnFunctionsEvents
cellEllipsisGridBase
cellInfoWidget
columnLinesGridBase
disabledWidget
enableUndoRedoKeysGridElementEvents
hideFootersGridBase
hideHeadersGridBase
hoveredCellGridElementEvents
localeHelperLocalizable
localeManagerLocalizable
longPressTimeGridElementEvents
pluginsPluggable
readOnlyGridBase
refWidget
responsiveLevelGridResponsive
rowLinesGridBase
tabWidget
titlePanel
tooltipWidget
transitionDurationGridBase
Scrolling
scrollManagerGridBase
Selection
selectedCellGridSelection
selectedCellCSSSelectorGridSelection
selectedCellsGridSelection
selectedRecordGridSelection
selectedRecordsGridSelection
selectedRowsGridSelection
selectionModeGridSelection
State
stateGridState
Tree
animateTreeNodeToggleGridBase
Widget hierarchy
containsFocusWidget
nextSiblingWidget
ownerWidget
parentWidget
previousSiblingWidget
visibleChildCountContainer
widgetMapContainer
Functions
129
Functions
129Other
sortActionRowsstatic
Sorts the actions within a transaction using precedence heuristic to show most "significant" actions first.
| Parameter | Type | Description |
|---|---|---|
actions | ChangeLogAction[] |
addContainer
addListenerEvents
announceAriaLiveWidget
collapsePanelPanel
composeWidget
createOnFrameDelayable
disableWidget
enableWidget
exitFullscreenWidget
expandPanelPanel
focusWidget
getAtContainer
getWidgetByIdContainer
hasListenerEvents
insertContainer
maskWidget
onEvents
processWidgetConfigContainer
recomposeWidget
relayAllEvents
removeContainer
removeAllContainer
removeAllListenersEvents
removeListenerEvents
requestFullscreenWidget
resetValuesContainer
resumeEventsEvents
revertFocusWidget
setValuesContainer
suspendEventsEvents
triggerEvents
unEvents
unmaskWidget
Configuration
Events
detachListenersBase
Getters
getCellGridBase
getColumnFromElementGridBase
getFooterElementGridBase
getHeaderElementGridBase
getRecordFromElementGridBase
Misc
addPluginsPluggable
animatePropertyBase
callbackBase
downloadTestCaseBase
getPluginPluggable
hasFeatureGridFeatures
hasPluginPluggable
highlightCellsGridBase
maskBodyGridBase
resolveCallbackBase
resumeAnimationsGridBase
runWithTransitionGridBase
suspendAnimationsGridBase
toggleCollapsedPanel
unhighlightCellsGridBase
unmaskBodyGridBase
updateLocalizationLocalizable
Rendering
refreshColumnGridBase
refreshHeaderGridBase
refreshHeadersGridBase
refreshRowGridBase
refreshRowsGridBase
renderContentsGridBase
renderRowsGridBase
resumeRefreshGridBase
suspendRefreshGridBase
Rows
getRowForGridBase
Scrolling
disableScrollingCloseToEdgesGridBase
enableScrollingCloseToEdgesGridBase
restoreScrollGridBase
scrollCellIntoViewGridBase
scrollColumnIntoViewGridBase
scrollRowIntoViewGridBase
scrollToBottomGridBase
scrollToTopGridBase
storeScrollGridBase
Selection
deselectAllGridSelection
deselectCellGridSelection
deselectCellsGridSelection
deselectRowGridSelection
deselectRowsGridSelection
isCellSelectedGridSelection
isSelectableGridSelection
isSelectedGridSelection
selectAllGridSelection
selectCellGridSelection
selectCellRangeGridSelection
selectCellsGridSelection
selectRangeGridSelection
selectRowGridSelection
selectRowsGridSelection
spliceSelectedRecordsGridSelection
Widget hierarchy
closestWidget
containsWidget
eachAncestorWidget
eachWidgetWidget
ownsWidget
queryWidget
queryAllWidget
upWidget
Events
49
Events
49Fires when the user chooses to compare a selected version.
// Adding a listener using the "on" method
versionGrid.on('compare', ({ version }) => {
});| Parameter | Type | Description |
|---|---|---|
version | VersionModel | The VersionModel being restored |
Fires when the user chooses to restore a selected version.
// Adding a listener using the "on" method
versionGrid.on('restore', ({ version }) => {
});| Parameter | Type | Description |
|---|---|---|
version | VersionModel | The VersionModel being restored |
Fires when the user chooses to stop comparing a currently compared version.
// Adding a listener using the "on" method
versionGrid.on('stopCompare', ({ }) => {
});beforeDestroyEvents
beforeHideWidget
beforeRenderRowGridBase
beforeRenderRowsGridBase
beforeSelectionChangeGridSelection
beforeSetRecordContainer
beforeShowWidget
beforeStateApplyGridState
beforeStateSaveGridState
catchAllEvents
cellClickGridElementEvents
cellContextMenuGridElementEvents
cellDblClickGridElementEvents
cellMouseEnterGridElementEvents
cellMouseLeaveGridElementEvents
cellMouseOutGridElementEvents
cellMouseOverGridElementEvents
collapsePanel
dataChangeGridBase
destroyEvents
dirtyStateChangeContainer
dragSelectingGridSelection
elementCreatedWidget
expandPanel
focusInWidget
focusOutWidget
headerClickGridElementEvents
hideWidget
mouseOutGridElementEvents
mouseOverGridElementEvents
paintWidget
readOnlyWidget
recomposeWidget
renderRowGridBase
renderRowsGridBase
resizeWidget
responsiveGridResponsive
rowMouseEnterGridElementEvents
rowMouseLeaveGridElementEvents
scrollGridBase
selectionChangeGridSelection
selectionModeChangeGridSelection
showWidget
subGridCollapseGridBase
subGridExpandGridBase
toolClickPanel
Event handlers
49
Event handlers
49Called when the user chooses to compare a selected version.
new VersionGrid({
onCompare({ version }) {
}
});| Parameter | Type | Description |
|---|---|---|
version | VersionModel | The VersionModel being restored |
Called when the user chooses to restore a selected version.
new VersionGrid({
onRestore({ version }) {
}
});| Parameter | Type | Description |
|---|---|---|
version | VersionModel | The VersionModel being restored |
Called when the user chooses to stop comparing a currently compared version.
new VersionGrid({
onStopCompare({ }) {
}
});onBeforeDestroyEvents
onBeforeHideWidget
onBeforeRenderRowGridBase
onBeforeRenderRowsGridBase
onBeforeSelectionChangeGridSelection
onBeforeSetRecordContainer
onBeforeShowWidget
onBeforeStateApplyGridState
onBeforeStateSaveGridState
onCatchAllEvents
onCellClickGridElementEvents
onCellContextMenuGridElementEvents
onCellDblClickGridElementEvents
onCellMouseEnterGridElementEvents
onCellMouseLeaveGridElementEvents
onCellMouseOutGridElementEvents
onCellMouseOverGridElementEvents
onCollapsePanel
onDataChangeGridBase
onDestroyEvents
onDirtyStateChangeContainer
onDragSelectingGridSelection
onElementCreatedWidget
onExpandPanel
onFocusInWidget
onFocusOutWidget
onHeaderClickGridElementEvents
onHideWidget
onMouseOutGridElementEvents
onMouseOverGridElementEvents
onPaintWidget
onReadOnlyWidget
onRecomposeWidget
onRenderRowGridBase
onRenderRowsGridBase
onResizeWidget
onResponsiveGridResponsive
onRowMouseEnterGridElementEvents
onRowMouseLeaveGridElementEvents
onScrollGridBase
onSelectionChangeGridSelection
onSelectionModeChangeGridSelection
onShowWidget
onSubGridCollapseGridBase
onSubGridExpandGridBase
onToolClickPanel
Typedefs
15
Typedefs
15AlignSpecWidget
BryntumListenerConfigEvents
CellWidgetContextWidget
ColorWidget
ColumnStateGridState
DelayableConfigDelayable
EmptyTextDomConfigGridBase
GridScrollOptionsGridBase
GridSelectionModeGridSelection
GridStateInfoGridState
KeyMapConfigKeyMap
PanelHeaderPanel
PreserveScrollOptionsGridBase
ResponsiveLevelConfigGridResponsive
SubGridStateGridState
CSS variables
85
CSS variables
85| Name | Description |
|---|---|
--b-version-grid-property-value-background | Value background |
--b-version-grid-property-font-size | Property font size |