Item Class

A data structure that represents a single content record.

Methods

Name Description
constructor(primaryKeys: InstanceKey[], label: string | LabelDefinition, imageId: string, classInfo: undefined | ClassInfo, values: ValuesDictionary<Value>, displayValues: ValuesDictionary<DisplayValue>, mergedFieldNames: string[], extendedData?: { T }): Item Creates an instance of Item.  
isFieldMerged(fieldName: string): boolean Is value of field with the specified name merged in this record.  
toJSON(): ItemJSON Serialize this object to JSON  
fromJSON(json: undefined | string | ItemJSON): undefined | Item Static Deserialize Item from JSON  

Properties

Name Type Description
classInfo undefined | ClassInfo For cases when item consists only of same class instances, information about the ECClass  
displayValues ValuesDictionary<DisplayValue> Display values dictionary  
extendedData undefined | { T } Extended data injected into this content item  
imageId string ID of the image associated with this item Deprecated  
inputKeys undefined | InstanceKey[] Keys of input instances that caused this item to be included in content.  
label LabelDefinition Display label of the item  
mergedFieldNames string[] List of field names whose values are merged (see Merging values)  
primaryKeys InstanceKey[] Keys of instances whose data is contained in this item  
values ValuesDictionary<Value> Raw values dictionary  

Defined in

Last Updated: 15 March, 2024