regenerate the documentation

README.md

@@ -26,7 +26,7 @@ Please refer to our [documentation](https://panintelligence.github.io/pi-embed-a
 ## Examples
 
 ### Basic Usage Examples:
-To embed the Report Editor:
+To embed a Report Editor:
 ```javascript
 const dashboard = PiEmbedActions.createDashboard('iframeId', 'https://pi-dev.uk:8224/pi?lang=en_GB&editorDisplayMode=CONTENT');
 dashboard.reportEditor.open(2);

docs/PiEmbedActions.html

@@ -5,7 +5,7 @@
      |        |       |                       |
   Protocol  Host    Port    List of query parameters in key-value format,
                                          separated by `&`
-</code></pre><p><code>dashboardUrl</code> should include all necessary query parameters to avoid triggering browsers reloads when navigating between different functional areas in the dashboard. Most common query parameters (optional):</p><ul><li><strong><code>locale</code></strong>: Dashboard language and regional settings (e.g., <code>lang=en_GB</code>).</li><li><strong><code>token</code></strong>: Secure access token for authentication (e.g., <code>token=xxx</code>).</li><li><strong><code>editorDisplayMode</code></strong>: Editor display mode (e.g., editorDisplayMode=CONTENT). See <a href="EditorDisplayMode.html">EditorDisplayMode</a> for more details.</li></ul></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type"><a href="PiEmbedActions.html">PiEmbedActions</a></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// Basic example of how to create a dashboard instance and embed a Report Editor:
+</code></pre><p><code>dashboardUrl</code> should include all necessary query parameters to prevent browser reloads when navigating between different functional areas in the dashboard. Most common query parameters (optional):</p><ul><li><strong><code>locale</code></strong>: Dashboard language and regional settings (e.g., <code>lang=en_GB</code>).</li><li><strong><code>token</code></strong>: Secure access token for authentication (e.g., <code>token=xxx</code>).</li><li><strong><code>editorDisplayMode</code></strong>: Editor display mode (e.g., <code>editorDisplayMode=CONTENT</code>). See <a href="EditorDisplayMode.html">EditorDisplayMode</a> for more details.</li></ul></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type"><a href="PiEmbedActions.html">PiEmbedActions</a></span></dd></dl></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Example</strong><div class="rel"><pre class="prettyprint"><code>// Basic example of how to create a dashboard instance and embed a Report Editor:
 // 1. Create a dashboard instance, providing a valid iframeId and dashboardUrl.
 const dashboard = PiEmbedActions.createDashboard('iframeId', 'https://pi-dev.uk:8224/pi?lang=en_GB&amp;editorDisplayMode=CONTENT');
 // 2. Open a specific report in the editor, providing a valid report id.