### addStartWorkflowActivity

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Workflows.Flow.html

Adds a Start Workflow Activity to the workflow. This activity marks the beginning of the workflow execution.

```APIDOC
## addStartWorkflowActivity

### Description
Adds a Start Workflow Activity to the workflow.

### Method
addStartWorkflowActivity

### Returns
Promise<StartWorkflowActivity>
```

--------------------------------

### Accessing and Using the Extensibility API

Source: https://apidocs.rnd.mendix.com/11/extensions-api/index.html

Demonstrates how to obtain a reference to the Studio Pro API object using `getStudioProApi` and interact with its functionalities, such as showing a message box.

```APIDOC
## Accessing the Studio Pro API

### Description
Obtain a reference to the Studio Pro API object to interact with its functionalities.

### Method
`getStudioProApi(componentContext)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```javascript
import { getStudioProApi } from "@mendix/extensions-api";

const studioPro = getStudioProApi(componentContext);
```

### Response
#### Success Response
- **studioPro** (object) - An object representing the Studio Pro API.

### Example Usage
```javascript
import { getStudioProApi, IComponent } from "@mendix/extensions-api";

export const component: IComponent = {
    async loaded(componentContext) {
        const studioPro = getStudioProApi(componentContext);
        await studioPro.ui.messageBoxes.show("info", "Hello World from my extension!");
    }
};
```
```

--------------------------------

### addNonInterruptingNotificationEventSubProcessStartActivity

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Workflows.Flow.html

Adds a Non-Interrupting Notification Event Sub-Process Start Activity to the workflow. This starts a sub-process that does not interrupt the main workflow upon notification.

```APIDOC
## addNonInterruptingNotificationEventSubProcessStartActivity

### Description
Adds a Non-Interrupting Notification Event Sub-Process Start Activity to the workflow.

### Method
addNonInterruptingNotificationEventSubProcessStartActivity

### Returns
Promise<NonInterruptingNotificationEventSubProcessStartActivity>
```

--------------------------------

### open

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IDockablePaneApi.html

Opens a dockable pane using its handle.

```APIDOC
## open

### Description
Opens a dockable pane by passing a pane handle received from the register method.

### Method
N/A (SDK Method)

### Signature
open(handle: DockablePaneHandle): Promise<void>

### Parameters
#### Parameters
- **handle** (DockablePaneHandle) - Required - A handle to the pane that was registered.

### Returns
Promise<void>
```

--------------------------------

### addInterruptingNotificationEventSubProcessStartActivity

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Workflows.Flow.html

Adds an Interrupting Notification Event Sub-Process Start Activity to the workflow. This starts a sub-process that interrupts the main workflow upon notification.

```APIDOC
## addInterruptingNotificationEventSubProcessStartActivity

### Description
Adds an Interrupting Notification Event Sub-Process Start Activity to the workflow.

### Method
addInterruptingNotificationEventSubProcessStartActivity

### Returns
Promise<InterruptingNotificationEventSubProcessStartActivity>
```

--------------------------------

### StartEventCreationOptions Interface

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Microflows.StartEventCreationOptions.html

This documentation describes the StartEventCreationOptions interface, which is used to configure options for creating start events in microflows. It includes an optional property for specifying the relative middle point.

```APIDOC
## Interface StartEventCreationOptions

This interface defines optional configurations for creating start events within microflows.

### Properties

#### `relativeMiddlePoint` (Location) - Optional

Specifies the relative middle point for the start event. The type is `Location`.
```

--------------------------------

### Get All Documents of a Specific Type

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/ICustomBlobDocumentApi.html

Retrieves metadata for all custom blob documents of a specified type. To get the actual content of each document, you must call getDocumentById for each one.

```typescript
getDocumentsOfType(type: string): Promise<DocumentsOfTypeResult>
```

--------------------------------

### open

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/ITabApi.html

Opens a new tab in the Studio Pro working area with the specified tab information and UI specification.

```APIDOC
## open

### Description
Opens a new tab in the working area of Studio Pro.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **TabHandle** - A handle to the tab that can be used to close it.

#### Response Example
None
```

--------------------------------

### Get Units Info

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/ICustomIconCollectionApi.html

Retrieves information about all available units.

```typescript
getUnitsInfo(): Promise<UnitInfo[]>
```

--------------------------------

### show (options)

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IMessageBoxApi.html

Shows a message box with the provided options object. Returns a promise that resolves when the message box is closed.

```APIDOC
## show (options)

### Description
Shows a message box with the given options.

### Method
N/A (SDK Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **options** (showOptions) - Required - The options for the message box.

### Returns
Promise<void> - A promise that resolves when the message box is closed.
```

--------------------------------

### Get Parent TabContainer

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.TabPage.html

Retrieves the parent TabContainer of the current TabPage.

```typescript
getContainer(): TabContainer
```

--------------------------------

### StartEvent Interface

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Microflows.StartEvent.html

Provides details about the properties and methods available for the StartEvent interface.

```APIDOC
## Interface StartEvent

An element is part of a Mendix model and all elements together form the logic of the model. Elements may contain other elements. An element always has a container element, which is its parent. The root of an element tree is always a unit.

interface StartEvent {
  $CreationOptions?: StartEventCreationOptions;
  $ID: string;
  $Type: "Microflows$StartEvent";
  $UnitID?: string;
  relativeMiddlePoint: Location;
  size: Size;
  delete(): void;
  getContainer(): MicroflowObjectCollection;
}

#### Hierarchy (View Summary, Expand)
  * MicroflowObjectBase
    * StartEvent

##### Index
### Properties
$CreationOptions? $ID $Type $UnitID? relativeMiddlePoint size
### Methods
delete getContainer

## Properties
### `Optional`$CreationOptions
$CreationOptions?: StartEventCreationOptions
Options to pass during the element creation

### $ID
$ID: string
The unique id of the element.

### $Type
$Type: "Microflows$StartEvent"
The type of the element.

### `Optional`$UnitID
$UnitID?: string

### relativeMiddlePoint
relativeMiddlePoint: Location

### size
size: Size

## Methods
### delete
  * delete(): void
#### Returns void


### getContainer
  * getContainer(): MicroflowObjectCollection
#### Returns MicroflowObjectCollection
```

--------------------------------

### Get Container of ListViewTemplate

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.ListViewTemplate.html

Retrieves the parent ListView container of this ListViewTemplate.

```typescript
getContainer(): ListView;
```

--------------------------------

### register

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IDockablePaneApi.html

Registers a new dockable pane with Studio Pro, returning a handle for interaction.

```APIDOC
## register

### Description
Registers a new dockable pane with Studio Pro.

### Method
N/A (SDK Method)

### Signature
register(paneInfo: DockablePaneInfo, uiSpec: UISpec): Promise<DockablePaneHandle>

### Parameters
#### Parameters
- **paneInfo** (DockablePaneInfo) - Required - Information like title and initial position required by Studio Pro to register the pane.
- **uiSpec** (UISpec) - Required - UI specification of the UI to show inside the pane.

### Returns
Promise<DockablePaneHandle> - A pane handle which can be used to interact with the pane via IDockablePaneApi.open and IDockablePaneApi.close methods.
```

--------------------------------

### Get Element Metadata

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/ICustomIconCollectionApi.html

Retrieves metadata for all elements managed by the API.

```typescript
getElementMetadata(): Promise<ElementMetadataMap>
```

--------------------------------

### ListViewTemplate Methods

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.ListViewTemplate.html

This section details the methods available on the ListViewTemplate interface for adding various UI components. Each method takes specific creation options and returns a Promise of the created component.

```APIDOC
## ListViewTemplate Methods

This section details the methods available on the ListViewTemplate interface for adding various UI components. Each method takes specific creation options and returns a Promise of the created component.

### addActionButton

Adds an action button to the ListViewTemplate.

#### Parameters
* **options** (ActionButtonCreationOptions) - Required - Options for creating the action button.

#### Returns
* Promise<ActionButton>

### addCheckBox

Adds a checkbox to the ListViewTemplate.

#### Parameters
* **options** (CheckBoxCreationOptions) - Required - Options for creating the checkbox.

#### Returns
* Promise<CheckBox>

### addDataGrid

Adds a data grid to the ListViewTemplate.

#### Parameters
* **options** (DataGridCreationOptions) - Required - Options for creating the data grid.

#### Returns
* Promise<Pages.DataGrid>

### addDataView

Adds a data view to the ListViewTemplate.

#### Parameters
* **options** (DataViewCreationOptions) - Required - Options for creating the data view.

#### Returns
* Promise<Pages.DataView>

### addDatePicker

Adds a date picker to the ListViewTemplate.

#### Parameters
* **options** (DatePickerCreationOptions) - Required - Options for creating the date picker.

#### Returns
* Promise<DatePicker>

### addDivContainer

Adds a div container to the ListViewTemplate.

#### Parameters
* **options** (DivContainerCreationOptions) - Required - Options for creating the div container.

#### Returns
* Promise<DivContainer>

### addDropDown

Adds a drop-down list to the ListViewTemplate.

#### Parameters
* **options** (DropDownCreationOptions) - Required - Options for creating the drop-down list.

#### Returns
* Promise<DropDown>

### addDropDownButton

Adds a drop-down button to the ListViewTemplate.

#### Parameters
* **options** (DropDownButtonCreationOptions) - Required - Options for creating the drop-down button.

#### Returns
* Promise<DropDownButton>

### addDynamicImageViewer

Adds a dynamic image viewer to the ListViewTemplate.

#### Parameters
* **options** (DynamicImageViewerCreationOptions) - Required - Options for creating the dynamic image viewer.

#### Returns
* Promise<Pages.DynamicImageViewer>

### addDynamicText

Adds dynamic text to the ListViewTemplate.

#### Parameters
* **options** (DynamicTextCreationOptions) - Required - Options for creating the dynamic text.

#### Returns
* Promise<DynamicText>

### addFileManager

Adds a file manager to the ListViewTemplate.

#### Parameters
* **options** (FileManagerCreationOptions) - Required - Options for creating the file manager.

#### Returns
* Promise<FileManager>

### addGroupBox

Adds a group box to the ListViewTemplate.

#### Parameters
* **options** (GroupBoxCreationOptions) - Required - Options for creating the group box.

#### Returns
* Promise<GroupBox>

### addHeader

Adds a header to the ListViewTemplate.

#### Parameters
* **options** (HeaderCreationOptions) - Required - Options for creating the header.

#### Returns
* Promise<Pages.Header>

### addImageUploader

Adds an image uploader to the ListViewTemplate.

#### Parameters
* **options** (ImageUploaderCreationOptions) - Required - Options for creating the image uploader.

#### Returns
* Promise<ImageUploader>

### addInputReferenceSetSelector

Adds an input reference set selector to the ListViewTemplate.

#### Parameters
* **options** (InputReferenceSetSelectorCreationOptions) - Required - Options for creating the input reference set selector.

#### Returns
* Promise<InputReferenceSetSelector>

### addLabel

Adds a label to the ListViewTemplate.

#### Parameters
* **options** (LabelCreationOptions) - Required - Options for creating the label.

#### Returns
* Promise<Label>
```

--------------------------------

### Get Proxy URL

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IHttpProxyApi.html

Gets a proxy URL for the given target URL. This API allows components to request a proxy URL for a given target URL. The proxy URL can be used to make requests to the target endpoint through the Studio Pro backend, which can be useful for bypassing CORS restrictions.

```typescript
getProxyUrl(targetUrl: string): Promise<string>
```

--------------------------------

### getNonInterruptingNotificationEventSubProcessStartActivity

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Workflows.Flow.html

Retrieves a NonInterruptingNotificationEventSubProcessStartActivity by its name. This activity starts a subprocess that is not interrupted by notifications.

```APIDOC
## getNonInterruptingNotificationEventSubProcessStartActivity

### Description
Retrieves a NonInterruptingNotificationEventSubProcessStartActivity by its name.

### Method
Not applicable (SDK method)

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the NonInterruptingNotificationEventSubProcessStartActivity to retrieve.

### Returns
- undefined | NonInterruptingNotificationEventSubProcessStartActivity - Returns the NonInterruptingNotificationEventSubProcessStartActivity if found, otherwise undefined.
```

--------------------------------

### createUnit

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IAuthenticationApi.html

Creates a new authentication unit.

```APIDOC
## createUnit

### Description
Creates a new authentication unit.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
* **type** ("Authentication$Authentication") - Required - The type of the unit to create, must be "Authentication$Authentication".
* **containerId** (string) - Required - The ID of the container for the new unit.
* **options** (unknown) - Optional - Additional options for creating the unit.

### Returns
Promise<Authentication.Authentication>
```

--------------------------------

### Get SequenceFlow Container

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Microflows.SequenceFlow.html

Retrieves the parent MicroflowBase element that contains this SequenceFlow.

```typescript
getContainer(): MicroflowBase
```

--------------------------------

### createUnit

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IDatabaseConnectionApi.html

Creates a new database connection unit.

```APIDOC
## createUnit

### Description
Creates a new database connection unit.

### Method
N/A (SDK Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **type** ("DatabaseConnector$DatabaseConnection") - Required - The type of the unit to create.
* **containerId** (string) - Required - The ID of the container for the new unit.
* **options** (unknown) - Optional - Additional options for creating the unit.

### Returns
Promise<DatabaseConnection> - A promise that resolves with the created database connection.
```

--------------------------------

### Get GroupBox by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves a GroupBox from the DivContainer by its name. Returns undefined if not found.

```typescript
getGroupBox(name: string): undefined | GroupBox
```

--------------------------------

### registerCommand

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/ICommandRegistrationApi.html

Registers a new command with a unique ID, an action to perform, and an optional description. This command can then be invoked within Studio Pro.

```APIDOC
## registerCommand

### Description
Registers a command with a unique identifier and an associated action.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **id** (string) - Required - The unique identifier for the command.
* **action** ((arg: T) => void) - Required - The function to execute when the command is invoked.
* **description** (string) - Optional - A description of the command.

### Returns
Promise<void>
```

--------------------------------

### add

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IExtensionsMenuApi.html

Adds a menu item to the Extensions menu in the main menu bar of Studio Pro.

```APIDOC
## add

### Description
Adds a menu item to the Extensions menu in the main menu bar of Studio Pro.

### Method
add

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **menuItem** (Menu) - Required - The menu item to add.

### Request Example
```json
{
  "menuItem": { ... }
}
```

### Response
#### Success Response (200)
- **void** - Indicates the operation was successful.

#### Response Example
```json
null
```
```

--------------------------------

### Get DynamicImageViewer by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves a DynamicImageViewer from the DivContainer by its name. Returns undefined if not found.

```typescript
getDynamicImageViewer(name: string): undefined | Pages.DynamicImageViewer
```

--------------------------------

### loaded Method

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IComponent.html

Called when the component is initially loaded. It receives the component's context and input parameters.

```APIDOC
## `Optional`loaded

### Description
Called when the component is initially loaded.

### Method
loaded

### Parameters
#### Parameters
- **componentContext** (ComponentContext) - Required - Object that uniquely identifies the component that is being loaded.
- **componentInput** (Readonly<Record<string, unknown>>) - Required - Input parameters passed to the component (such as dialogId or currently open document.)

### Returns
Promise<void>
```

--------------------------------

### Get DropDownButton by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves a DropDownButton from the DivContainer by its name. Returns undefined if not found.

```typescript
getDropDownButton(name: string): undefined | DropDownButton
```

--------------------------------

### Registering a Command

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/ICommandRegistrationApi.html

Demonstrates how to register a new command with a unique ID, an action to be executed, and an optional description. This method returns a Promise that resolves when the command is successfully registered.

```typescript
registerCommand<T extends object>(
id: string,
action: (arg: T) => void,
description?: string,
): Promise<void>
```

--------------------------------

### Get DropDown by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves a DropDown from the DivContainer by its name. Returns undefined if not found.

```typescript
getDropDown(name: string): undefined | DropDown
```

--------------------------------

### LoginIdTextBoxCreationOptions Interface

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.LoginIdTextBoxCreationOptions.html

Defines the structure for options when creating a LoginIdTextBox. It includes an optional 'name' property.

```APIDOC
## Interface LoginIdTextBoxCreationOptions

### Description
This interface represents the configuration options available when creating a LoginIdTextBox. It allows for an optional string property named 'name'.

### Properties

#### name
- **name** (string) - Optional - The name for the LoginIdTextBox.
```

--------------------------------

### Get DivContainer by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves a DivContainer from the DivContainer by its name. Returns undefined if not found.

```typescript
getDivContainer(name: string): undefined | DivContainer
```

--------------------------------

### TextBoxCreationOptions Interface

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.TextBoxCreationOptions.html

Defines the configuration options for creating a text box, including whether it should be a password box, its label caption, its name, and whether the label should be shown.

```APIDOC
## Interface TextBoxCreationOptions

### Description
Defines the configuration options for creating a text box. This interface allows for customization of properties such as whether the text box should function as a password input, the caption text for its label, a unique name for identification, and a flag to control the visibility of the label.

### Properties

*   **isPasswordBox** (boolean) - Optional - If true, the text box will obscure input, suitable for password fields.
*   **labelCaption** (string) - Optional - The text to be displayed as the label for the text box.
*   **name** (string) - Optional - A unique identifier for the text box.
*   **showLabel** (boolean) - Optional - Determines whether the label associated with the text box is visible.
```

--------------------------------

### Get DatePicker by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves a DatePicker from the DivContainer by its name. Returns undefined if not found.

```typescript
getDatePicker(name: string): undefined | DatePicker
```

--------------------------------

### PlaceholderCreationOptions

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.PlaceholderCreationOptions.html

Defines the options available when creating a placeholder. Currently, only the `name` property is supported.

```APIDOC
## Interface PlaceholderCreationOptions
interface PlaceholderCreationOptions {
  name?: string;
}

### Properties
#### `Optional` name
name?: string

**Description:**
The name of the placeholder. This property is optional.
```

--------------------------------

### Get DataView by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves a DataView from the DivContainer by its name. Returns undefined if not found.

```typescript
getDataView(name: string): undefined | Pages.DataView
```

--------------------------------

### createUnit

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IModuleSettingsApi.html

Creates a new module settings unit within a specified container.

```APIDOC
## createUnit

### Description
Creates a new module settings unit within a specified container.

### Method
POST

### Endpoint
/IModuleSettingsApi/createUnit

### Parameters
#### Request Body
- **type** (string) - Required - Must be 'Projects$ModuleSettings'.
- **containerId** (string) - Required - The ID of the container for the new unit.
- **options** (unknown) - Optional - Additional options for unit creation.

### Response
#### Success Response (200)
- **ModuleSettings** (object) - The newly created module settings unit.

### Response Example
```json
{
  "moduleSettings": { ... }
}
```
```

--------------------------------

### Get DataGrid by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves a DataGrid from the DivContainer by its name. Returns undefined if not found.

```typescript
getDataGrid(name: string): undefined | Pages.DataGrid
```

--------------------------------

### Get CheckBox by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves a CheckBox from the DivContainer by its name. Returns undefined if not found.

```typescript
getCheckBox(name: string): undefined | CheckBox
```

--------------------------------

### getPreferences

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IPreferencesApi.html

Retrieves the preferences of Studio Pro. This method returns a Promise that resolves with the user's preferences.

```APIDOC
## getPreferences

### Description
Retrieves the preferences of Studio pro.

### Method
GET

### Endpoint
/api/preferences

### Returns
Promise<Preferences>

#### Response Example
{
  "example": "Preferences object"
}
```

--------------------------------

### ParameterTypeBase Methods

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/CodeActions.ParameterTypeBase.html

Lists the methods available on the ParameterTypeBase interface.

```text
delete getContainer
```

--------------------------------

### Get ActionButton by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.DivContainer.html

Retrieves an ActionButton from the DivContainer by its name. Returns undefined if not found.

```typescript
getActionButton(name: string): undefined | ActionButton
```

--------------------------------

### getActiveDocument

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IEditorApi.html

Gets information about the document the user is currently editing, or null if no document is open.

```APIDOC
## getActiveDocument

### Description
Gets information about the document the user is currently editing, or `null` if no document is currently opened.

### Method
Not applicable (SDK method)

### Endpoint
Not applicable (SDK method)

### Parameters
None

### Returns
Promise<null | DocumentInfo>

### Example
```typescript
// Example usage (assuming editorApi is an instance of IEditorApi)
const activeDoc = await editorApi.getActiveDocument();
if (activeDoc) {
  console.log('Active document:', activeDoc.name);
} else {
  console.log('No document is active.');
}
```
```

--------------------------------

### Adding UI Elements

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.NativeLayoutContent.html

Methods for adding various UI elements to the native layout. Each method takes specific creation options and returns a Promise resolving to the created element.

```APIDOC
## Adding UI Elements

This section details the methods available for adding various UI components to the native layout.

### Methods

- **addReferenceSelector(options: ReferenceSelectorCreationOptions): Promise<ReferenceSelector>**
- **addReferenceSetSelector(options: ReferenceSetSelectorCreationOptions): Promise<ReferenceSetSelector>**
- **addScrollContainer(options: ScrollContainerCreationOptions): Promise<ScrollContainer>**
- **addSidebarToggleButton(options: SidebarToggleButtonCreationOptions): Promise<SidebarToggleButton>**
- **addSimpleMenuBar(options: SimpleMenuBarCreationOptions): Promise<SimpleMenuBar>**
- **addSnippetCallWidget(options: SnippetCallWidgetCreationOptions): Promise<SnippetCallWidget>**
- **addStaticImageViewer(options: StaticImageViewerCreationOptions): Promise<Pages.StaticImageViewer>**
- **addTabContainer(options: TabContainerCreationOptions): Promise<TabContainer>**
- **addTable(options: TableCreationOptions): Promise<Pages.Table>**
- **addTemplateGrid(options: TemplateGridCreationOptions): Promise<Pages.TemplateGrid>**
- **addTemplatePlaceholder(options: TemplatePlaceholderCreationOptions): Promise<TemplatePlaceholder>**
- **addTextArea(options: TextAreaCreationOptions): Promise<TextArea>**
- **addTextBox(options: TextBoxCreationOptions): Promise<TextBox>**
- **addTitle(options: TitleCreationOptions): Promise<Pages.Title>**
- **addValidationMessage(options: ValidationMessageCreationOptions): Promise<ValidationMessage>**
```

--------------------------------

### ImportMappingCreationOptions

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/ImportMappings.ImportMappingCreationOptions.html

Defines the options available when creating a new import mapping. Currently, only an optional name can be specified.

```APIDOC
## Interface ImportMappingCreationOptions

### Description
This interface defines the configuration options for creating an import mapping. It allows for an optional name to be provided for the mapping.

### Properties
#### name
- **name** (string) - Optional - The name for the import mapping.
```

--------------------------------

### getModuleSettings

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IModuleSettingsApi.html

Retrieves the module settings for a given module name.

```APIDOC
## getModuleSettings

### Description
Retrieves the module settings for a given module name.

### Method
GET

### Endpoint
/IModuleSettingsApi/getModuleSettings?moduleName={moduleName}

### Parameters
#### Query Parameters
- **moduleName** (string) - Required - The name of the module.

### Response
#### Success Response (200)
- **ModuleSettings | null** - The module settings object or null if not found.

### Response Example
```json
{
  "moduleSettings": { ... } | null
}
```
```

--------------------------------

### Get Component Framework

Source: https://apidocs.rnd.mendix.com/11/extensions-api/modules.html

Retrieves the Component Framework, which allows for the creation and management of Mendix components.

```APIDOC
## getComponentFramework

### Description
Retrieves the Component Framework, which allows for the creation and management of Mendix components.

### Function Signature
getComponentFramework(): IComponentFramework

### Returns
- IComponentFramework: An object representing the Mendix Component Framework.
```

--------------------------------

### Get InputReferenceSetSelector by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.TabPage.html

Retrieves an InputReferenceSetSelector widget from the TabPage by its name. Returns undefined if not found.

```typescript
getInputReferenceSetSelector(name: string): undefined | InputReferenceSetSelector
```

--------------------------------

### createUnit

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IBusinessEventServiceApi.html

Creates a new business event service unit.

```APIDOC
## createUnit

### Description
Creates a new business event service unit.

### Method
createUnit(type: "BusinessEvents$BusinessEventService", containerId: string, options?: unknown): Promise<BusinessEventService>

### Parameters
#### Path Parameters
- **type** ("BusinessEvents$BusinessEventService") - Required - The type of the unit to create.
- **containerId** (string) - Required - The ID of the container for the new unit.
- **options** (unknown) - Optional - Additional options for creating the unit.

### Returns
Promise<BusinessEventService>
```

--------------------------------

### LayoutParameterCreationOptions Interface

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.LayoutParameterCreationOptions.html

Defines the options available for creating layout parameters. This interface includes an optional 'name' property.

```APIDOC
## Interface LayoutParameterCreationOptions

### Description
Represents the options that can be provided when creating a layout parameter. It allows for an optional name to be specified.

### Properties
#### name
- **name** (string) - Optional - The name of the layout parameter.
```

--------------------------------

### Get ImageUploader by Name

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.TabPage.html

Retrieves an ImageUploader widget from the TabPage by its name. Returns undefined if not found.

```typescript
getImageUploader(name: string): undefined | ImageUploader
```

--------------------------------

### LayoutCreationOptions Interface

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.LayoutCreationOptions.html

Defines the options available for creating layouts, including an optional name property.

```APIDOC
## Interface LayoutCreationOptions

### Description
This interface defines the configuration options for creating layouts. It includes an optional `name` property to specify the layout's name.

### Properties
#### `Optional` name
- **name** (string) - Optional - The name of the layout.
```

--------------------------------

### Get Container of PublishedRestServiceOperation

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Rest.PublishedRestServiceOperation.html

Retrieves the parent resource that contains this published REST service operation.

```typescript
getContainer(): PublishedRestServiceResource
```

--------------------------------

### createUnit

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IMenuDocumentApi.html

Creates a new menu document unit within a specified container.

```APIDOC
## createUnit

### Description
Creates a new menu document unit. Requires a container ID and can accept additional options.

### Method
N/A (SDK Method)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
- **type** ("Menus$MenuDocument") - The type of the unit to create, must be "Menus$MenuDocument".
- **containerId** (string) - The ID of the container where the unit will be created.
- **options** (unknown) - Optional. Additional options for unit creation.

### Request Example
N/A

### Response
#### Success Response
- **MenuDocument** - The newly created menu document unit.

#### Response Example
N/A
```

--------------------------------

### Get ImageUploader from GroupBox

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.GroupBox.html

Retrieves an ImageUploader widget by its name from the GroupBox. Returns undefined if not found.

```typescript
GroupBox.getImageUploader(name: string): undefined | ImageUploader
```

--------------------------------

### BuildingBlock Methods

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.BuildingBlock.html

This section details the methods available on the BuildingBlock interface, which allow for the programmatic addition of various UI elements to a page.

```APIDOC
## addActionButton

### Description
Adds an action button to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/actionButton

### Parameters
#### Request Body
- **options** (ActionButtonCreationOptions) - Required - Options for creating the action button.

### Response
#### Success Response (200)
- **ActionButton** (ActionButton) - The created action button.

### Response Example
```json
{
  "actionButton": {
    "id": "some-id",
    "caption": "Click Me"
  }
}
```

## addCheckBox

### Description
Adds a checkbox to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/checkBox

### Parameters
#### Request Body
- **options** (CheckBoxCreationOptions) - Required - Options for creating the checkbox.

### Response
#### Success Response (200)
- **CheckBox** (CheckBox) - The created checkbox.

### Response Example
```json
{
  "checkBox": {
    "id": "some-id",
    "caption": "Agree"
  }
}
```

## addDataGrid

### Description
Adds a data grid to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/dataGrid

### Parameters
#### Request Body
- **options** (DataGridCreationOptions) - Required - Options for creating the data grid.

### Response
#### Success Response (200)
- **DataGrid** (Pages.DataGrid) - The created data grid.

### Response Example
```json
{
  "dataGrid": {
    "id": "some-id",
    "dataSource": "some-data-source"
  }
}
```

## addDataView

### Description
Adds a data view to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/dataView

### Parameters
#### Request Body
- **options** (DataViewCreationOptions) - Required - Options for creating the data view.

### Response
#### Success Response (200)
- **DataView** (Pages.DataView) - The created data view.

### Response Example
```json
{
  "dataView": {
    "id": "some-id",
    "dataSource": "some-data-source"
  }
}
```

## addDatePicker

### Description
Adds a date picker to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/datePicker

### Parameters
#### Request Body
- **options** (DatePickerCreationOptions) - Required - Options for creating the date picker.

### Response
#### Success Response (200)
- **DatePicker** (DatePicker) - The created date picker.

### Response Example
```json
{
  "datePicker": {
    "id": "some-id",
    "format": "yyyy-MM-dd"
  }
}
```

## addDivContainer

### Description
Adds a div container to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/divContainer

### Parameters
#### Request Body
- **options** (DivContainerCreationOptions) - Required - Options for creating the div container.

### Response
#### Success Response (200)
- **DivContainer** (DivContainer) - The created div container.

### Response Example
```json
{
  "divContainer": {
    "id": "some-id"
  }
}
```

## addDropDown

### Description
Adds a drop-down list to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/dropDown

### Parameters
#### Request Body
- **options** (DropDownCreationOptions) - Required - Options for creating the drop-down list.

### Response
#### Success Response (200)
- **DropDown** (DropDown) - The created drop-down list.

### Response Example
```json
{
  "dropDown": {
    "id": "some-id",
    "caption": "Select Option"
  }
}
```

## addDropDownButton

### Description
Adds a drop-down button to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/dropDownButton

### Parameters
#### Request Body
- **options** (DropDownButtonCreationOptions) - Required - Options for creating the drop-down button.

### Response
#### Success Response (200)
- **DropDownButton** (DropDownButton) - The created drop-down button.

### Response Example
```json
{
  "dropDownButton": {
    "id": "some-id",
    "caption": "Actions"
  }
}
```

## addDynamicImageViewer

### Description
Adds a dynamic image viewer to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/dynamicImageViewer

### Parameters
#### Request Body
- **options** (DynamicImageViewerCreationOptions) - Required - Options for creating the dynamic image viewer.

### Response
#### Success Response (200)
- **DynamicImageViewer** (Pages.DynamicImageViewer) - The created dynamic image viewer.

### Response Example
```json
{
  "dynamicImageViewer": {
    "id": "some-id",
    "imageUrl": "/img/default.png"
  }
}
```

## addDynamicText

### Description
Adds dynamic text to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/dynamicText

### Parameters
#### Request Body
- **options** (DynamicTextCreationOptions) - Required - Options for creating the dynamic text.

### Response
#### Success Response (200)
- **DynamicText** (DynamicText) - The created dynamic text element.

### Response Example
```json
{
  "dynamicText": {
    "id": "some-id",
    "content": "Dynamic Content"
  }
}
```

## addFileManager

### Description
Adds a file manager to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/fileManager

### Parameters
#### Request Body
- **options** (FileManagerCreationOptions) - Required - Options for creating the file manager.

### Response
#### Success Response (200)
- **FileManager** (FileManager) - The created file manager.

### Response Example
```json
{
  "fileManager": {
    "id": "some-id",
    "caption": "Upload File"
  }
}
```

## addGroupBox

### Description
Adds a group box to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/groupBox

### Parameters
#### Request Body
- **options** (GroupBoxCreationOptions) - Required - Options for creating the group box.

### Response
#### Success Response (200)
- **GroupBox** (GroupBox) - The created group box.

### Response Example
```json
{
  "groupBox": {
    "id": "some-id",
    "caption": "Group Box Title"
  }
}
```

## addHeader

### Description
Adds a header to the BuildingBlock.

### Method
POST

### Endpoint
/BuildingBlock/{id}/header

### Parameters
#### Request Body
- **options** (HeaderCreationOptions) - Required - Options for creating the header.

### Response
#### Success Response (200)
- **Header** (Pages.Header) - The created header.

### Response Example
```json
{
  "header": {
    "id": "some-id",
    "caption": "Page Header"
  }
}
```
```

--------------------------------

### Get Header from GroupBox

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.GroupBox.html

Retrieves a Header widget by its name from the GroupBox. Returns undefined if not found.

```typescript
GroupBox.getHeader(name: string): undefined | Pages.Header
```

--------------------------------

### Get FileManager from GroupBox

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.GroupBox.html

Retrieves a FileManager widget by its name from the GroupBox. Returns undefined if not found.

```typescript
GroupBox.getFileManager(name: string): undefined | FileManager
```

--------------------------------

### Registering a Dockable Pane

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IDockablePaneApi.html

Registers a new dockable pane with Studio Pro. Requires pane information and UI specifications. Returns a handle for future interactions.

```typescript
register(
  paneInfo: DockablePaneInfo,
  uiSpec: UISpec,
): Promise<DockablePaneHandle>
```

--------------------------------

### Get DynamicText from GroupBox

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.GroupBox.html

Retrieves a DynamicText widget by its name from the GroupBox. Returns undefined if not found.

```typescript
GroupBox.getDynamicText(name: string): undefined | DynamicText
```

--------------------------------

### $CreationOptions Property

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/CodeActions.TypeBase.html

Represents optional parameters that can be provided when creating a Mendix element.

```plaintext
$CreationOptions?: unknown
Options to pass during the element creation
```

--------------------------------

### Pages Header Interface Methods

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.Header.html

This section details the methods available on the Header interface for adding different types of widgets to the header. Each method takes specific creation options and returns a Promise of the created widget.

```APIDOC
## Interface Header

### Description
Represents a header element in a Mendix page.

### Methods

#### addActionButton
Adds an ActionButton to the header.
- **options** (ActionButtonCreationOptions) - Required - Options for creating the ActionButton.
- Returns: Promise<ActionButton>

#### addCheckBox
Adds a CheckBox to the header.
- **options** (CheckBoxCreationOptions) - Required - Options for creating the CheckBox.
- Returns: Promise<CheckBox>

#### addDataGrid
Adds a DataGrid to the header.
- **options** (DataGridCreationOptions) - Required - Options for creating the DataGrid.
- Returns: Promise<Pages.DataGrid>

#### addDataView
Adds a DataView to the header.
- **options** (DataViewCreationOptions) - Required - Options for creating the DataView.
- Returns: Promise<Pages.DataView>

#### addDatePicker
Adds a DatePicker to the header.
- **options** (DatePickerCreationOptions) - Required - Options for creating the DatePicker.
- Returns: Promise<DatePicker>

#### addDivContainer
Adds a DivContainer to the header.
- **options** (DivContainerCreationOptions) - Required - Options for creating the DivContainer.
- Returns: Promise<DivContainer>

#### addDropDown
Adds a DropDown to the header.
- **options** (DropDownCreationOptions) - Required - Options for creating the DropDown.
- Returns: Promise<DropDown>

#### addDropDownButton
Adds a DropDownButton to the header.
- **options** (DropDownButtonCreationOptions) - Required - Options for creating the DropDownButton.
- Returns: Promise<DropDownButton>

#### addDynamicImageViewer
Adds a DynamicImageViewer to the header.
- **options** (DynamicImageViewerCreationOptions) - Required - Options for creating the DynamicImageViewer.
- Returns: Promise<Pages.DynamicImageViewer>

#### addDynamicText
Adds a DynamicText to the header.
- **options** (DynamicTextCreationOptions) - Required - Options for creating the DynamicText.
- Returns: Promise<DynamicText>

#### addFileManager
Adds a FileManager to the header.
- **options** (FileManagerCreationOptions) - Required - Options for creating the FileManager.
- Returns: Promise<FileManager>

#### addGroupBox
Adds a GroupBox to the header.
- **options** (GroupBoxCreationOptions) - Required - Options for creating the GroupBox.
- Returns: Promise<GroupBox>

#### addHeader
Adds a Header to the header.
- **options** (HeaderCreationOptions) - Required - Options for creating the Header.
- Returns: Promise<Pages.Header>

#### addImageUploader
Adds an ImageUploader to the header.
- **options** (ImageUploaderCreationOptions) - Required - Options for creating the ImageUploader.
- Returns: Promise<ImageUploader>

#### addInputReferenceSetSelector
Adds an InputReferenceSetSelector to the header.
- **options** (InputReferenceSetSelectorCreationOptions) - Required - Options for creating the InputReferenceSetSelector.
- Returns: Promise<InputReferenceSetSelector>

#### addLabel
Adds a Label to the header.
- **options** (LabelCreationOptions) - Required - Options for creating the Label.
- Returns: Promise<Label>

#### addLayoutGrid
Adds a LayoutGrid to the header.
- **options** (LayoutGridCreationOptions) - Required - Options for creating the LayoutGrid.
- Returns: Promise<LayoutGrid>

#### addListView
Adds a ListView to the header.
- **options** (ListViewCreationOptions) - Required - Options for creating the ListView.
- Returns: Promise<ListView>

#### addLoginButton
Adds a LoginButton to the header.
- **options** (LoginButtonCreationOptions) - Required - Options for creating the LoginButton.
- Returns: Promise<LoginButton>

#### addLoginIdTextBox
Adds a LoginIdTextBox to the header.
- **options** (LoginIdTextBoxCreationOptions) - Required - Options for creating the LoginIdTextBox.
- Returns: Promise<LoginIdTextBox>

#### addMenuBar
Adds a MenuBar to the header.
- **options** (MenuBarCreationOptions) - Required - Options for creating the MenuBar.
- Returns: Promise<MenuBar>

#### addNavigationList
Adds a NavigationList to the header.
- **options** (NavigationListCreationOptions) - Required - Options for creating the NavigationList.
- Returns: Promise<NavigationList>

#### addNavigationTree
Adds a NavigationTree to the header.
- **options** (NavigationTreeCreationOptions) - Required - Options for creating the NavigationTree.
- Returns: Promise<NavigationTree>

#### addPasswordTextBox
Adds a PasswordTextBox to the header.
- **options** (PasswordTextBoxCreationOptions) - Required - Options for creating the PasswordTextBox.
- Returns: Promise<PasswordTextBox>

#### addPlaceholder
Adds a Placeholder to the header.
- **options** (PlaceholderCreationOptions) - Required - Options for creating the Placeholder.
- Returns: Promise<Placeholder>

#### addRadioButtonGroup
Adds a RadioButtonGroup to the header.
- **options** (RadioButtonGroupCreationOptions) - Required - Options for creating the RadioButtonGroup.
- Returns: Promise<RadioButtonGroup>

#### addReferenceSelector
Adds a ReferenceSelector to the header.
- **options** (ReferenceSelectorCreationOptions) - Required - Options for creating the ReferenceSelector.
- Returns: Promise<ReferenceSelector>
```

--------------------------------

### Get DynamicImageViewer from GroupBox

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.GroupBox.html

Retrieves a DynamicImageViewer widget by its name from the GroupBox. Returns undefined if not found.

```typescript
GroupBox.getDynamicImageViewer(name: string): undefined | Pages.DynamicImageViewer
```

--------------------------------

### StartWorkflowActivity Interface

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Workflows.StartWorkflowActivity.html

Provides details about the properties of the StartWorkflowActivity interface, which is a type of WorkflowActivityBase.

```APIDOC
## Interface StartWorkflowActivity

An element is part of a Mendix model and all elements together form the logic of the model. Elements may contain other elements. An element always has a container element, which is its parent. The root of an element tree is always a unit.

### Properties

*   **$CreationOptions?** (unknown) - Optional. Options to pass during the element creation.
*   **$ID** (string) - The unique id of the element.
*   **$Type** (string) - The type of the element. Expected value: "Workflows$StartWorkflowActivity".
*   **$UnitID?** (string) - Optional. The ID of the unit containing this element.
*   **annotation** (null | Workflows.Annotation) - Annotation associated with the activity.
*   **caption** (string) - The display caption for the activity.
*   **name** (string) - The internal name of the activity.
*   **persistentId** (string) - A persistent identifier for the activity.
*   **relativeMiddlePoint** (Location) - The relative middle point coordinates of the activity.
*   **size** (Size) - The size dimensions of the activity.
```

--------------------------------

### Get DropDownButton from GroupBox

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.GroupBox.html

Retrieves a DropDownButton widget by its name from the GroupBox. Returns undefined if not found.

```typescript
GroupBox.getDropDownButton(name: string): undefined | DropDownButton
```

--------------------------------

### addFolder

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/IProjectApi.html

Creates a new folder within a given container. Returns the created folder.

```APIDOC
## addFolder

### Description
Creates a new folder within a given container.

### Method
N/A (SDK Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **containerId** (string) - Required - The ID of the container to add the folder to.
- **name** (string) - Required - The name of the new folder.

### Request Example
None

### Response
#### Success Response (200)
- **Folder** (Readonly<Folder>) - The created folder.

#### Response Example
None
```

--------------------------------

### Get DropDown from GroupBox

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.GroupBox.html

Retrieves a DropDown widget by its name from the GroupBox. Returns undefined if not found.

```typescript
GroupBox.getDropDown(name: string): undefined | DropDown
```

--------------------------------

### HeaderCreationOptions

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.HeaderCreationOptions.html

Defines the options available for creating headers. This interface allows for an optional name to be specified.

```APIDOC
## Interface HeaderCreationOptions

### Description
This interface defines the configuration options for creating headers. It includes an optional `name` property.

### Properties
#### `Optional` name
- **name** (string) - Optional - The name of the header.
```

--------------------------------

### Get DivContainer from GroupBox

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.GroupBox.html

Retrieves a DivContainer widget by its name from the GroupBox. Returns undefined if not found.

```typescript
GroupBox.getDivContainer(name: string): undefined | DivContainer
```

--------------------------------

### LayoutGridCreationOptions Interface

Source: https://apidocs.rnd.mendix.com/11/extensions-api/interfaces/Pages.LayoutGridCreationOptions.html

Defines the structure for creating or configuring layout grids, specifying column configurations, a name, and width.

```APIDOC
## Interface LayoutGridCreationOptions

This interface defines the options available for creating or configuring a layout grid.

### Properties

*   **columns** (array of objects with `weight` property) - Optional - An array defining the weight of each column in the grid.
*   **name** (string) - Optional - The name of the layout grid.
*   **width** (ContainerWidth) - Optional - The width configuration for the layout grid.
```