Client-Side API Reference > FlexGrid > wijmo.grid > DataMap Class |
constructor(itemsSource: any, selectedValuePath?: string, displayMemberPath?: string): DataMap
Initializes a new instance of the DataMap class.
An array or ICollectionView that contains the items to map.
The name of the property that contains the keys (data values).
The name of the property to use as the visual representation of the items.
Gets the name of the property to use as the visual representation of the item.
Gets or sets a value that indicates whether users should be allowed to enter values that are not present on the DataMap.
In order for a selectedValuePath and displayMemberPath must be set to the same value.
Gets the name of the property to use as a key for the item (data value).
Gets or sets a value that determines whether to use mapped (display) or raw values when sorting the data.
getDisplayValue(key: any): any
Gets the display value that corresponds to a given key.
The key of the item to retrieve.
getDisplayValues(dataItem?: any): string[]
Gets an array with all of the display values on the map.
Data item for which to get the display items. This parameter is optional. If not provided, all possible display values should be returned.
getKeyValue(displayValue: string): any
Gets the key that corresponds to a given display value.
The display value of the item to retrieve.
getKeyValues(): string[]
Gets an array with all of the keys on the map.
onMapChanged(e?: EventArgs): void
Raises the mapChanged event.
Represents a data map for use with a column's dataMap property.
Data maps provide the grid with automatic look up capabilities. For example, you may want to display a customer name instead of his ID, or a color name instead of its RGB value.
The code below binds a grid to a collection of products, then assigns a DataMap to the grid's 'CategoryID' column so the grid displays the category names rather than the raw IDs.
The grid takes advantage of data maps also for editing. If the wijmo.input module is loaded, then when editing data-mapped columns the grid will show a drop-down list containing the values on the map.
In general, data maps apply to whole columns. However, there are situations where you may want to restrict the options available for a cell based on a value on a different column. For example, if you have "Country" and "City" columns, you will probably want to restrict the cities based on the current country.
There are two ways you can implement these "dynamic" data maps: