When rendering related instances' content as array items, include their labels next to array item index

[Bordoloi123]

For example, while displaying cant station point properties in the property pane, indexis displayed for each point and not the actual name as seen in OpenRail.

We want the points to be displayed as

[grigasp]

Hi @Bordoloi123, thanks for filing the issue. Got some questions about this:

1. Your proposed image has the category block labeled "Cant Station Points" in plural. Ours just shows class label, which is singular. Is that a problem?

2. We'll need to know which is property of the related class to use for display label. Is it identified in your schema somehow?

3. Do you expect that property to be hidden from property list when you expand the instance properties list?

4. You're proposing to show instance label instead of index when the label is not null.

   • I'm worried there could be duplicate instance labels, resulting in duplicate groups.
   • In case some related instances have labels and some don't, we could end up with a weird list where some blocks have proper labels and some have [123] ones.

   To fix the above, I suggest always showing an index and then appending the label, if there is one, e.g. [123] My label. What do you think?

[grigasp]

Related: https://github.com/iTwin/itwinjs-core/issues/3790

[Bordoloi123]

Hi @grigasp

1 .Your proposed image has the category block labeled "Cant Station Points" in plural. Ours just shows class label, which is singular. Is that a problem?

You can ignore this. That was typo in the image.If required in plurals, we will make the changes in our schema.

2.We'll need to know which is property of the related class to use for display label. Is it identified in your schema somehow?

We have decided to set the display label through IECInstance::SetDisplayLabel , on our side. So if the display label is available, you have to just render that in property pane.

3.Do you expect that property to be hidden from property list when you expand the instance properties list? Answered in point 2.

4.You're proposing to show instance label instead of index when the label is not null. Yes

I'm worried there could be duplicate instance labels, resulting in duplicate groups. In case some related instances have labels and some don't, we could end up with a weird list where some blocks have proper labels and some have [123] ones.

This is a valid concern and it wont hamper us if the index is also displayed along the display label.

Thank you for detailed questions.

[grigasp]

2. We'll need to know which is property of the related class to use for display label. Is it identified in your schema somehow?

We have decided to set the display label through IECInstance::SetDisplayLabel , on our side. So if the display label is available, you have to just render that in property pane.

3. Do you expect that property to be hidden from property list when you expand the instance properties list?

Answered in point 2.

An ECInstance doesn't have a special label property. When you use IECInstance::SetDisplayLabel, it attempts to find a regular property that should be used as the label (using class custom attributes or property name as the means to identify it). So question 3 remains unanswered, since the property used as a label will also appear in the properties list.

[Bordoloi123]

2. We'll need to know which is property of the related class to use for display label. Is it identified in your schema somehow?

We have decided to set the display label through IECInstance::SetDisplayLabel , on our side. So if the display label is available, you have to just render that in property pane.

3. Do you expect that property to be hidden from property list when you expand the instance properties list?

Answered in point 2.

An ECInstance doesn't have a special label property. When you use IECInstance::SetDisplayLabel, it attempts to find a regular property that should be used as the label (using class custom attributes or property name as the means to identify it). So question 3 remains unanswered, since the property used as a label will also appear in the properties list.

In that case, we will set (int the cited example) "Station" property as the display label and the property will also appear in the properties list.

[grigasp]

Sounds good. Here's what needs to be done:

• [x] imodel-native: When creating content for related instances, also read their labels and include them in resulting nested content values.
• [x] itwinjs-core: Add an optional label attribute to NestedContentValue.
• [x] presentation-components: When creating PropertyRecord from NestedContentValue ensure the label attribute is carried over.
• [x] components-react: Ensure that array items' (of type PropertyRecord) labels are rendered next to the index, when rendering the property grid.

[grigasp]

We should be able to implement this in itwinjs-core@4.8 timeframe.

[Bordoloi123]

We should be able to implement this in itwinjs-core@4.8 timeframe.

Thank you!

[grigasp]

On hold till itwinjs-core 4.8 release. Then we'll need:

• [x] bump itwinjs-core dev dependencies of presentation-components to 4.8,
• [x] complete https://github.com/iTwin/presentation/pull/664
• [x] release presentation-components

[grigasp]

Required appui changes are released with @itwin/components-react@4.16.0

[grigasp]

@Bordoloi123, FYI the last missing piece was just released. You should start seeing the labels after updating the following dependencies:

• itwinjs-core 4.8
• appui 4.16
• presentation-components 5.4.2

Please note that the label will not be visible if we can't find a label for the related instance. One of the ways to attach label property to instances of specific class is to use a instance label override rule the ruleset you use to get the properties. With it, you can say that instance label should be set to some specific property value (through property value specification).

I'll keep this issue open until you confirm that everything works as expected - please let us know.