PropertyGrid
Classes and components for working with a PropertyGrid.
Classes
Name | Description | |
---|---|---|
CompositePropertyDataFilterer | Composite PropertyData filter which can join two filters using logic operators | |
DisplayValuePropertyDataFilterer | Property data filterer which matches on Primitive Property Record display value text. | |
FilteringPropertyDataProvider | IPropertyDataProvider implementation which filters wrapped provider PropertyData using passed IPropertyDataFilterer. | |
LabelPropertyDataFilterer | PropertyData filter which matches on any record type label and includes descendant nodes on match | |
MutableCategorizedArrayProperty | Mutable wrapper object for PropertyRecord with array valueFormat which provides methods for working with and managing record children hierarchies. | Beta |
MutableCategorizedPrimitiveProperty | Mutable wrapper object for PropertyRecord with primitive valueFormat. | Beta |
MutableCategorizedProperty | Base class for all Mutable CategorizedProperties | Beta |
MutableCategorizedStructProperty | Mutable wrapper object for PropertyRecord with struct valueFormat which provides methods for working with and managing record children hierarchies. | Beta |
MutableFlatPropertyGridItem | Base class for all FlatPropertyGrid items | Beta |
MutableGridCategory | Mutable wrapper object for PropertyCategory which provides methods for working with and managing category and record children hierarchies | Beta |
MutableGridItemFactory | Implementation of IMutableGridItemFactory for creating MutableGridItem objects. | Beta |
MutablePropertyGridModel | Implementation of PropertyGridModel for working with and converting PropertyData to mutable FlatGridItems | Beta |
PropertyCategoryBlock | PropertyCategoryBlock React component | |
PropertyCategoryDataFiltererBase | An abstract implementation of IPropertyDataFilterer that can be used as base for all | |
PropertyCategoryLabelFilterer | PropertyData filterer which matches on PropertyCategory's label. | |
PropertyCategoryRendererManager | Keeps a record of currently registered property category renderers and determines which renderers get invoked for | Beta |
PropertyDataChangeEvent | An event broadcasted on property data changes | |
PropertyDataFiltererBase | An abstract implementation of IPropertyDataFilterer to share common behavior between different implementations. | |
PropertyFilterChangeEvent | An event broadcasted when property filter changes | |
PropertyGrid | PropertyGrid React component. | |
PropertyGridEventHandler | Handles events and changes on PropertyGridModel data. | Beta |
PropertyGridModelChangeEvent | An event broadcasted on property grid model changes | Beta |
PropertyGridModelSource | Controls property grid model. | Beta |
PropertyList | A React component that renders multiple properties within a category as a list. | |
PropertyRecordDataFiltererBase | An abstract implementation of IPropertyDataFilterer that can be used as base for all | |
SimplePropertyDataProvider | Implementation of [IPropertyDataProvider] that uses an associative array. | |
VirtualizedPropertyGrid | VirtualizedPropertyGrid React component. | Beta |
Enumerations
Name | Description | |
---|---|---|
CompositeFilterType | Logical operator for composite filterer. | |
FilteredType | Enumeration of possible component filtered types | |
FlatGridItemType | Types of FlatGridItems for differentiating what property FlatGridItem is wrapping. | Beta |
Global Functions
Name | Description | |
---|---|---|
usePropertyData | Custom hook that gets PropertyData from given IPropertyDataProvider and subscribes to further data changes. | |
usePropertyGridEventHandler | Custom hook that creates memoized version of PropertyGridEventHandler that modifies given modelSource | Beta |
usePropertyGridModel | Custom hook that automatically listens and retrieves latest model from model source | Beta |
usePropertyGridModelSource | Custom hook that creates a PropertyGridModelSource and subscribes it to data updates from the data provider. | Beta |
VirtualizedPropertyGridWithDataProvider | VirtualizedPropertyGrid React Component which takes dataProvider and | Beta |
Interfaces
Name | Description | |
---|---|---|
CategorizedPropertyItem | Data structure which describes methods and properties present on immutable CategorizedPropertyItem objects | Beta |
CategoryRecordsDict | Category name to PropertyRecord[] key pair interface used to describe which records belong to which category. | Beta |
CommonPropertyGridProps | Common Property Grid Props to be used by Property Grid Variants | |
FilteredPropertyData | Data returned by FilteringPropertyDataProvider | |
FlatGridItemBase | Base immutable data structure defining common methods and properties for categories and categorized properties | Beta |
GridCategoryItem | Data structure which describes methods and properties present on immutable GridCategoryItem | Beta |
IMutableCategorizedPropertyItem | Data structure which describes methods and properties to be held by Mutable CategorizedPropertyItems | Beta |
IMutableFlatPropertyGridItem | Base mutable data structure defining common methods and properties for both CategorizedProperties and GridCategoryItems | Beta |
IMutableGridCategoryItem | Data structure which describes methods and properties to be held by Mutable GridCategoryItems | Beta |
IMutableGridItemFactory | IMutableGridItemFactory interface for creating MutableGridItem objects | Beta |
IMutablePropertyGridModel | PropertyGridModel interface for working with mutable FlatGridItems | Beta |
IPropertyDataFilterer | An interface for a filterer that filters PropertyData based on content of PropertyRecord | |
IPropertyDataProvider | An interface for property data provider which returns | |
IPropertyGridEventHandler | Handles events and changes on PropertyGridModel data. | Beta |
IPropertyGridModel | PropertyGridModel interface for working with immutable FlatGridItems | Beta |
IPropertyGridModelSource | Beta | |
PropertyCategory | Contains metadata about a group of Properties. | |
PropertyCategoryBlockProps | Properties for the PropertyCategoryBlock React component | |
PropertyCategoryRendererProps | Props that property category renderer receives. | Beta |
PropertyData | Interface for property data provided to the PropertyGrid React component. | |
PropertyDataFilterResult | Data structure for storing IPropertyDataFilterer matching results | |
PropertyEditingArgs | Arguments for the Property Editing event callback | |
PropertyGridCategory | Property Category in the PropertyGrid state | Deprecated |
PropertyGridContextMenuArgs | Arguments for PropertyGridProps.onPropertyContextMenu callback |
|
PropertyGridProps | Properties for PropertyGrid React component | |
PropertyListProps | Properties of PropertyList React component | |
VirtualizedPropertyGridContext | Context of the surrounding VirtualizedPropertyGrid component. | Beta |
VirtualizedPropertyGridProps | Properties for VirtualizedPropertyGrid React component | Beta |
VirtualizedPropertyGridWithDataProviderProps | Properties for VirtualizedPropertyGridWithDataProvider React component | Beta |
Type Aliases
Name | Description | |
---|---|---|
CategorizedPropertyTypes | Type which extracts FlatGridItemTypes relevant for working with CategorizedProperties | Beta |
FlatGridItem | Type which describes immutable GridCategoryItem or CategorizedPropertyItem | Beta |
IMutableFlatGridItem | Type which describes mutable GridCategoryItem or CategorizedProperty | Beta |
PropertyCategoryRenderer | ||
PropertyDataChangesListener | ||
PropertyFilterChangesListener | ||
PropertyGridModelChangeListener |
Last Updated: 03 February, 2023