PropertyListProps Interface

Properties of PropertyList React component

Extends

Methods

Name Description
onColumnChanged(ratio: number): void | RatioChangeResult Optional Callback to column ratio changed event  
onEditCancel(): void Optional    
onEditCommit(args: PropertyUpdatedArgs, category: PropertyCategory): void Optional    
onListWidthChanged(width: number): void Optional Callback to list width change event  
onPropertyClicked(property: PropertyRecord, key?: string): void Optional    
onPropertyContextMenu(property: PropertyRecord, e: MouseEvent<Element, MouseEvent>): void Optional    
onPropertyRightClicked(property: PropertyRecord, key?: string): void Optional    
onResizeHandleDragChanged(isDragStarted: boolean): void Optional Callback to drag event change  
onResizeHandleHoverChanged(isHovered: boolean): void Optional Callback to hover event change  

Properties

Name Type Description
actionButtonRenderers undefined | ActionButtonRenderer[] Array of action button renderers  
category undefined | PropertyCategory    
columnInfo undefined | Information for styling property grid columns  
columnRatio undefined | number    
editingPropertyKey undefined | string    
isPropertyHoverEnabled undefined | boolean Enables/disables property hovering effect  
isPropertyRightClickSelectionEnabled undefined | boolean Enables/disables property right click selection  
isPropertySelectionEnabled undefined | boolean Enables/disables property selection  
isResizeHandleBeingDragged undefined | boolean Is resize handle being dragged  
isResizeHandleHovered undefined | boolean Is resize handle hovered  
orientation Orientation    
properties PropertyRecord[]    
propertyValueRendererManager undefined | PropertyValueRendererManager    
selectedPropertyKey undefined | string    

Inherited properties

Name Type Inherited from Description
className undefined | string CommonProps Custom CSS class name
style undefined | CSSProperties CommonProps Custom CSS style properties

Defined in

Last Updated: 11 June, 2024