SharedRendererProps Interface

Properties shared by all renderers and PropertyView

Methods

Name Description
onClick(property: PropertyRecord, key?: string): void Optional Called when property gets clicked.  
onColumnRatioChanged(ratio: number): void | RatioChangeResult Optional Callback to column ratio changed event  
onContextMenu(property: PropertyRecord, e: MouseEvent<Element, MouseEvent>): void Optional Called to show a context menu for properties  
onResizeHandleDragChanged(isDragStarted: boolean): void Optional Callback to drag event change  
onResizeHandleHoverChanged(isHovered: boolean): void Optional Callback to hover event change  
onRightClick(property: PropertyRecord, key?: string): void Optional Called when property gets right clicked.  

Properties

Name Type Description
actionButtonRenderers undefined | ActionButtonRenderer[] Array of action button renderers @beta  
columnInfo undefined | Information for styling property grid columns  
columnRatio undefined | number Ratio between label and value cells  
isHoverable undefined | boolean Indicates that properties have hover effect  
isResizeHandleBeingDragged undefined | boolean Is resize handle being dragged  
isResizeHandleHovered undefined | boolean Is resize handle hovered  
isSelectable undefined | boolean Indicates that properties can be selected  
isSelected undefined | boolean Controls component selection  
orientation Orientation Orientation to use for displaying the property  
propertyRecord PropertyRecord PropertyRecord to render  
uniqueKey undefined | string Unique string, that identifies this property component.  
width undefined | number Width of the whole property element  

Defined in

Last Updated: 12 June, 2024