Skip to content

Commit b4fb9f6

Browse files
authored
Merge pull request #146 from brYch97/users/dominik.brych/DocsLatestVirtualDataset
Updated docs for Virtual Dataset
2 parents 678a755 + 2d84668 commit b4fb9f6

File tree

2 files changed

+23
-0
lines changed
  • src
    • .vuepress/public/.attachments/applications/Controls/VirtualDataset
    • en/developer-guide/applications/controls/VirtualDataset

2 files changed

+23
-0
lines changed
Loading

src/en/developer-guide/applications/controls/VirtualDataset/general.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,6 +340,20 @@ FetchXml Provider offers support for virtual columns, which are columns that do
340340

341341
Entity Metadata binding allows you to define/override any [Xrm Entity Metadata](https://learn.microsoft.com/en-us/dotnet/api/microsoft.xrm.sdk.metadata.entitymetadata?view=dataverse-sdk-latest). For example, you can change the `DisplayCollectionName`, so the UI can better describe your dataset. For Memory Provider, it is **required** to specify the `PrimaryIdAttribute` prop. The binding accepts a stringified JSON object that corresponts to the [Xrm Entity Metadata](https://learn.microsoft.com/en-us/dotnet/api/microsoft.xrm.sdk.metadata.entitymetadata?view=dataverse-sdk-latest) interface.
342342

343+
## Height
344+
345+
There are multiple ways to set the height of the control. By default, the control height will stretch to fit a maximum of 15 rows. If this limit is reached, a scrollbar will appear automatically. This is due to performance reasons, since row virtualization relies on control container being at fixed height. If the container gets too large, the performance degrades significantly. You can change the size of the container in three ways:
346+
347+
1. **Limit the page size**: If you reduce the number of records per page, the control will automatically adjust its height to fit the specified number of rows (up to 15). This is the recommended way to set the height of the control. You can limit the page size either through fetchXml (FetchXml Provider) or client API.
348+
349+
2. **Height property**: If your usecase requires displaying a lot of rows and you do not want to force the user to paginate through records, you can set the height of the control to a fixed value. This will force the control to always stay at this height, regardless of the number of rows. Keep in mind that the performance may degrade if you keep this container too large. This value should **always** be in fixed pixels (e.g. `500px`).
350+
351+
2. **Expand to full tab**: The control supports the native `Expand to full tab` feature. This will stretch the control to fit the entire tab, regardless of the number of rows. This is the **recommended way** to set the height of the control if you want to display a lot of rows. In order for this feature to work, you also need to set the `Height` property to `100%`.
352+
353+
![Control at Full Height](/.attachments/applications/Controls/VirtualDataset/full_height.png)
354+
*Control with Expand to full tab feature on.*
355+
356+
343357
## Bindings Summary
344358

345359
<table>
@@ -499,6 +513,15 @@ Entity Metadata binding allows you to define/override any [Xrm Entity Metadata](
499513
<td><code>input</code></td>
500514
<td><code>false</code></td>
501515
</tr>
516+
<tr>
517+
<td>EnablePageSizeSwitcher</td>
518+
<td>Whether the user should be allowed to change number of rows per page.</td>
519+
<td><code>Enum ("Yes" | "No")</code></td>
520+
<td><code>"Yes"</code></td>
521+
<td><code>N/A</code></td>
522+
<td><code>input</code></td>
523+
<td><code>false</code></td>
524+
</tr>
502525

503526
</tbody>
504527
</table>

0 commit comments

Comments
 (0)