### handle_dependencies

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Check the module names’ importability and install them if needed.

```APIDOC
## handle_dependencies

### Description
Check the module names’ importability and install them if needed.

### Parameters
- **module_names** (`* module_names: str`) – Variable length module name list.
- **install_missing_modules** (`bool`) – If True then it installs the missing modules else print that the module is missing. Defaults to True.

### Method
```python
archicad.handle_dependencies(_* module_names: str_, _install_missing_modules : bool = True_)
```
```

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

### archicad.handlers.handle_dependencies

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Checks the importability of specified module names and installs any missing modules if requested. This is useful for ensuring all necessary components are available before proceeding with other operations.

```APIDOC
## archicad.handlers.handle_dependencies

`handle_dependencies(_* module_names: str_, _install_missing_modules : bool = True_)`

Check the module names’ importability and install them if needed.

Parameters:
    
  * ***module_names** – Variable length module name list.
  * **install_missing_modules** (`bool`) – If True then it installs the missing modules else print that the module is missing. Defaults to True.
```

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

### _AttributeIndexAndGuidWrapperItem

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents an item containing an attribute index and GUID.

```APIDOC
## _AttributeIndexAndGuidWrapperItem

### Description
Represents an item containing an attribute index and GUID.

### Variables
- **attributeIndexAndGuid** (`AttributeIndexAndGuid`) – The complete identifier of an attribute.
```

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

### GetClassificationSystems

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves the details of classification systems identified by their GUIDs.

```APIDOC
## GetClassificationSystems

### Description
Returns the details of classification systems identified by their GUIDs.

### Parameters
- **classificationSystemIds** (list of ClassificationSystemIdArrayItem) - Required - A list of classification system identifiers.

### Returns
- **list** of **ClassificationSystemOrError** - A list of classification systems or errors.
```

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

### Get2DBoundingBoxes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves the 2D bounding box of elements identified by their GUIDs.

```APIDOC
## Get2DBoundingBoxes

### Description
Get the 2D bounding box of elements identified by their GUIDs. The bounding box is calculated from the global origin on the floor plan view. The output is the array of the bounding boxes respective to the input GUIDs. Only works for elements detailed in <i>Element Information</i>.

### Parameters
* **elements** (`list` of `ElementIdArrayItem`) – A list of elements.

### Returns
* A list of 2D bounding boxes.

### Return type
`list` of `BoundingBox2DOrError`
```

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

### GetCompositeAttributes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the detailed composite attributes identified by their GUIDs.

```APIDOC
## GetCompositeAttributes

### Description
Returns the detailed composite attributes identified by their GUIDs.

### Parameters
- **attributeIds** (list of AttributeIdWrapperItem) - Required - A list of attribute identifiers.

### Returns
- **list** of **CompositeAttributeOrError** - A list of the composite attributes and potential errors.
```

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

### GetBuildingMaterialAttributes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the detailed building material attributes identified by their GUIDs.

```APIDOC
## GetBuildingMaterialAttributes

### Description
Fetches the detailed attributes for building materials, identified by their GUIDs.

### Method
GET (assumed, as it retrieves data)

### Endpoint
Not applicable (Python package function)

### Parameters
#### Query Parameters
- **attributeIds** (list of AttributeIdWrapperItem) - Required - A list of attribute identifiers (GUIDs) for building materials.

### Returns
#### Success Response
- A list of building material attributes and potential errors.

### Response Example
```json
[
  {
    "attribute_id": "guid_1",
    "name": "Material A",
    "properties": { ... }
  },
  {
    "attribute_id": "guid_2",
    "error": "Building material not found"
  }
]
```
```

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

### Get3DBoundingBoxes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves the 3D bounding box of elements identified by their GUIDs.

```APIDOC
## Get3DBoundingBoxes

### Description
Get the 3D bounding box of elements identified by their GUIDs. The bounding box is calculated from the global origin in the 3D view. The output is the array of the bounding boxes respective to the input GUIDs. Only works for elements detailed in <i>Element Information</i>.

### Parameters
* **elements** (`list` of `ElementIdArrayItem`) – A list of elements.

### Returns
* A list of 3D bounding boxes.

### Return type
`list` of `BoundingBox3DOrError`
```

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

### GetProfileAttributes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves detailed profile attributes identified by their GUIDs. It takes a list of attribute identifiers and returns a list of profile attributes and potential errors.

```APIDOC
## GetProfileAttributes _attributeIds : List[AttributeIdWrapperItem]_ 

### Description
Returns the detailed profile attributes identified by their GUIDs.

### Parameters
#### Path Parameters
* **attributeIds** (list of AttributeIdWrapperItem) - Required - A list of attribute identifiers.

### Returns
A list of the profile attributes and potential errors.

### Return Type
list of ProfileAttributeOrError
```

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

### GetZoneCategoryAttributes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Fetches detailed zone category attributes using their GUIDs.

```APIDOC
## GetZoneCategoryAttributes

### Description
Returns the detailed zone category attributes identified by their GUIDs.

### Parameters
#### Path Parameters
- **attributeIds** (list of AttributeIdWrapperItem) - Required - A list of attribute identifiers.

### Returns
- **list** of ZoneCategoryAttributeOrError - A list of zone category attributes and potential errors.
```

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

### GetFillAttributes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves detailed fill attributes based on provided IDs. It takes a list of attribute identifiers (GUIDs) and returns a list of fill attributes along with any potential errors.

```APIDOC
## GetFillAttributes

### Description
Returns the detailed fill attributes identified by their GUIDs.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
(Not specified, assumed to be a Python function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **attributeIds** (`list` of `AttributeIdWrapperItem`) – A list of attribute identifiers.

### Returns
- **List[FillAttributeOrError]**: A list of fill attributes and potential errors.
```

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

### GetPenTableAttributes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves detailed pen table attributes, including their pens, based on provided IDs. It takes a list of attribute identifiers (GUIDs) and returns a list of pen table attributes along with any potential errors.

```APIDOC
## GetPenTableAttributes

### Description
Returns the detailed pen table attributes (including their pens) identified by their GUIDs.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
(Not specified, assumed to be a Python function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **attributeIds** (`list` of `AttributeIdWrapperItem`) – A list of attribute identifiers.

### Returns
- **List[PenTableAttributeOrError]**: A list of pen table attributes and potential errors.
```

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

### GetAttributesIndices

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the requested indices and guids of attributes.

```APIDOC
## GetAttributesIndices

### Description
Retrieves the indices and GUIDs for a given list of attribute identifiers.

### Method
GET (assumed, as it retrieves data)

### Endpoint
Not applicable (Python package function)

### Parameters
#### Query Parameters
- **attributeIds** (list of AttributeIdWrapperItem) - Required - A list of attribute identifiers.

### Returns
#### Success Response
- A list of complete attribute identifiers, including their indices and GUIDs, or errors.

### Response Example
```json
[
  {
    "attribute_id": "attr_1",
    "index": 10,
    "guid": "some-guid-1"
  },
  {
    "attribute_id": "attr_2",
    "error": "Attribute not found"
  }
]
```
```

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

### BasicCommands

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Provides basic commands for interacting with Archicad, such as retrieving product information and checking the application's liveness.

```APIDOC
## BasicCommands

### Description
Provides basic commands for interacting with Archicad, such as retrieving product information and checking the application's liveness.

### Methods
- **GetProductInfo()**: Retrieves information about the Archicad product.
- **IsAlive()**: Checks if the Archicad application is running and responsive.
```

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

### BasicCommands.GetProductInfo

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves the version information (build number, major version, language code) from the running Archicad instance.

```APIDOC
## BasicCommands.GetProductInfo

### Description
Accesses the version information from the running Archicad.

### Method
BasicCommands.GetProductInfo()

### Returns
- **Tuple[int, int, str]** - The version of the running Archicad. int: The build number of the running Archicad. str: The language code of the running Archicad.
```

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

### OpenFile

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Opens the given file with the default application.

```APIDOC
## OpenFile

### Description
Opens the given file with the default application.

### Method
```python
_static _OpenFile(_filepath : str_)
```
```

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

### BasicCommands.IsAlive

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Checks if the connection to the Archicad instance is currently active.

```APIDOC
## BasicCommands.IsAlive

### Description
Checks if the Archicad connection is alive.

### Method
BasicCommands.IsAlive()

### Returns
- **bool** - Returns true if the connection is alive.
```

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

### ExecuteAddOnCommand

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Executes a command registered in an Add-On.

```APIDOC
## ExecuteAddOnCommand

### Description
Executes a command registered in an Add-On.

### Parameters
* **addOnCommandId** (`AddOnCommandId`) – The identifier of an Add-On command.
* **addOnCommandParameters** (`AddOnCommandParameters`, optional) – The input parameters of an Add-On command.

### Returns
* The response returned by an Add-On command.

### Return type
`AddOnCommandResponse`
```

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

### none_constructor

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A constructor that returns None.

```APIDOC
## none_constructor()

### Description
A constructor that returns None.
```

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

### CreateViewMapFolder

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Creates a view folder item at the specified position in the navigator tree.

```APIDOC
## CreateViewMapFolder

### Description
Creates a view folder item at the given position in the navigator tree.

### Parameters
* **folderParameters** (`FolderParameters`) – The parameters of a folder.
* **parentNavigatorItemId** (`NavigatorItemId`, optional) – The identifier of a navigator item.
* **previousNavigatorItemId** (`NavigatorItemId`, optional) – The identifier of a navigator item.

### Returns
* The identifier of a navigator item.

### Return type
`NavigatorItemId`
```

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

### GetProductInfo

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Accesses and returns the version information of the running Archicad instance, including build number, version, and language code.

```APIDOC
## GetProductInfo

### Description
Accesses the version information from the running Archicad.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
(Not specified, assumed to be a Python function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Returns
- **Tuple[int, int, str]**: The version of the running Archicad. `int`: The build number of the running Archicad. `int`: The version number of the running Archicad. `str`: The language code of the running Archicad.
```

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

### ElementId

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents the identifier of an element, using a Globally Unique Identifier (GUID).

```APIDOC
## Class: _ElementId

### Description
The identifier of an element.

### Variables
* **guid** (`UUID`) – A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
```

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

### IsAlive

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Verifies if the connection to Archicad is active.

```APIDOC
## IsAlive

### Description
Checks if the Archicad connection is alive.

### Returns
- **bool** - Returns true if the connection is alive.
```

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

### AddOnCommandResponse

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents the response returned by an Add-On command.

```APIDOC
## AddOnCommandResponse

### Description
The response returned by an Add-On command.

### Variables
(No specific variables documented in the source)
```

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

### ACConnection.connect

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Establishes a connection to a running Archicad instance. It can optionally take a port number; otherwise, it attempts to use the command line or default port.

```APIDOC
## ACConnection.connect

### Description
Tries to connect to a running Archicad instance.

### Method
static

### Parameters
#### Path Parameters
None

#### Query Parameters
- **port** (int, optional) - The Archicad’s port. If not given, the command line or the default port will be used.

### Raises
- **ConnectionError** – When the connection is unsuccessful.

### Returns
- **ACConnection** - The living connection.
```

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

### GetLineAttributes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves detailed line attributes based on provided IDs. It takes a list of attribute identifiers (GUIDs) and returns a list of line attributes along with any potential errors.

```APIDOC
## GetLineAttributes

### Description
Returns the detailed line attributes identified by their GUIDs.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
(Not specified, assumed to be a Python function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **attributeIds** (`list` of `AttributeIdWrapperItem`) – A list of attribute identifiers.

### Returns
- **List[LineAttributeOrError]**: A list of line attributes and potential errors.
```

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

### GetLayerAttributes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves detailed layer attributes based on provided IDs. It takes a list of attribute identifiers (GUIDs) and returns a list of layer attributes along with any potential errors.

```APIDOC
## GetLayerAttributes

### Description
Returns the detailed layer attributes identified by their GUIDs.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
(Not specified, assumed to be a Python function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **attributeIds** (`list` of `AttributeIdWrapperItem`) – A list of attribute identifiers.

### Returns
- **List[LayerAttributeOrError]**: A list of layer attributes and potential errors.
```

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

### AttributeFolderCreationParameters

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Parameters used to create a new attribute folder, specifying its type and path.

```APIDOC
## AttributeFolderCreationParameters

### Description
Used to create an attribute folder. The folder type and its path need to be provided.

### Variables
- **attributeType** (str) - The type of an attribute.
- **path** (list of str) - A list of attribute folder names. May be empty.
```

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

### handle_dependencies

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Handles dependencies for Archicad operations.

```APIDOC
## handle_dependencies()

### Description
Handles dependencies for Archicad operations.

### Parameters
- **dependencies**: A list of dependencies to handle.
```

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

### GetLayerCombinationAttributes

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves detailed layer combination attributes based on provided IDs. It takes a list of attribute identifiers (GUIDs) and returns a list of layer combination attributes along with any potential errors.

```APIDOC
## GetLayerCombinationAttributes

### Description
Returns the detailed layer combination attributes identified by their GUIDs.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
(Not specified, assumed to be a Python function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **attributeIds** (`list` of `AttributeIdWrapperItem`) – A list of attribute identifiers.

### Returns
- **List[LayerCombinationAttributeOrError]**: A list of layer combination attributes and potential errors.
```

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

### IsAddOnCommandAvailable

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Checks the availability of an Add-On command.

```APIDOC
## IsAddOnCommandAvailable

### Description
Checks if the command is available or not.

### Parameters
#### Path Parameters
- **addOnCommandId** (AddOnCommandId) - Required - The identifier of an Add-On command.

### Returns
- **bool** - Returns true if the command is available.
```

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

### GetLayoutSettings

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves the parameters (settings) of a given layout. It takes the identifier of a navigator item and returns the layout's parameters.

```APIDOC
## GetLayoutSettings

### Description
Returns the parameters (settings) of the given layout.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
(Not specified, assumed to be a Python function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **layoutNavigatorItemId** (`NavigatorItemId`) – The identifier of a navigator item.

### Returns
- **LayoutParameters**: The parameters of the layout.
```

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

### archicad.versioning.ACConnection.connect

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Attempts to establish a connection to a running Archicad instance. It can optionally take a port number; otherwise, it uses the command line or default port. Raises a ConnectionError if the connection fails.

```APIDOC
## archicad.versioning.ACConnection.connect

`_static_ connect(_port : int | None = None_)`

Tries to connect to a running Archicad instance.

Parameters:
    
**port** (`int`, optional) – The Archicad’s port. If not given, the command line or the default port will be used.

Raises:
    
**ConnectionError** – When the connection is unsuccessful.

Returns:
    
The living connection.

Return type:
    
`ACConnection`
```

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

### SetLayoutSettings

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Configures the settings for a given layout.

```APIDOC
## SetLayoutSettings

### Description
Sets the parameters (settings) of the given layout.

### Parameters
#### Path Parameters
- **layoutParameters** (LayoutParameters) - Required - 
- **layoutNavigatorItemId** (NavigatorItemId) - Required - 
```

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

### _PenArrayItem

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper for a Pen object, representing an item in a pen array.

```APIDOC
## _PenArrayItem

### Description
Represents an item in a pen array.

### Variables
- **pen** (Pen) – A pen attribute.
```

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

### AddOnCommandParameters

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents the input parameters for an Add-On command.

```APIDOC
## AddOnCommandParameters

### Description
The input parameters of an Add-On command.

### Variables
(No specific variables documented in the source)
```

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

### _InteriorElevationNavigatorItemWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper class for InteriorElevationNavigatorItem.

```APIDOC
## _InteriorElevationNavigatorItemWrapper

### Description
A wrapper for the InteriorElevationNavigatorItem.

### Variables
- **interiorElevationNavigatorItem** (InteriorElevationNavigatorItem) – The details of an interior elevation navigator item.
```

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

### GetAllClassificationSystems

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns a list of all available classification systems.

```APIDOC
## GetAllClassificationSystems

### Description
Returns the list of available classification systems.

### Returns
* A list of classification systems.

### Return type
`list` of `ClassificationSystem`
```

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

### _GeneralNavigatorItemData

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Contains common data for a navigator item, including its ID, prefix, and name.

```APIDOC
## _GeneralNavigatorItemData

### Description
The common data of a navigator item.

### Variables
- **navigatorItemId** (NavigatorItemId) - The identifier of a navigator item.
- **prefix** (str) - The prefix of the navigator item’s name.
- **name** (str) - The name of the navigator item.
```

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

### handle_dependencies

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Handles dependencies for the Archicad Python Package.

```APIDOC
## handle_dependencies()

### Description
This function is responsible for managing and handling the dependencies required by the Archicad Python Package.

### Method
`handle_dependencies()`

### Parameters
None

### Response
None explicitly defined, likely performs setup or validation.

```

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

### archicad.Commands.CreateLayoutSubset

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Creates a new subset for layouts within Archicad. It requires subset parameters, which are used to assign IDs to the layouts within the subset, and the navigator item ID of the parent subset.

```APIDOC
## archicad.Commands.CreateLayoutSubset

`CreateLayoutSubset(_subsetParameters : Subset_, _parentNavigatorItemId : NavigatorItemId_)`

Creates a new layout subset.

Parameters:
    
  * **subsetParameters** (`Subset`) – A set of options used to assign IDs to the layouts contained in the subset.
  * **parentNavigatorItemId** (`NavigatorItemId`) – The identifier of a navigator item.

Returns:
    
The identifier of a navigator item.

Return type:
    
`NavigatorItemId`
```

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

### GetAllPropertyNames

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the human-readable names of available Property definitions for debug and development purposes.

```APIDOC
## GetAllPropertyNames

### Description
Retrieves the human-readable names of all available property definitions. Primarily for debugging and development.

### Method
GET (assumed, as it retrieves data)

### Endpoint
Not applicable (Python package function)

### Parameters
None

### Returns
#### Success Response
- A list of PropertyUserId objects, each containing a property name.

### Response Example
```json
[
  {"id": "prop_name_1"},
  {"id": "prop_name_2"}
]
```
```

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

### archicad.Commands.CreateAttributeFolders

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Creates attribute folders within Archicad. The function requires a list of `AttributeFolderCreationParameters`, where each parameter specifies the full path for a folder to be created. If any part of the path does not exist, it will be created.

```APIDOC
## archicad.Commands.CreateAttributeFolders

`CreateAttributeFolders(_attributeFolders : List[AttributeFolderCreationParameters]_)`

Creates attribute folders. To create a folder, its full path has to be provided. The command will create all folders along the path, if they do not exist.

Parameters:
    
**attributeFolders** (`list` of `AttributeFolderCreationParameters`) – EMPTY STRING

Returns:
    
A list of execution results.

Return type:
    
`list` of `ExecutionResult`
```

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

### _InteriorElevationNavigatorItemOrError

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Contains either an interior elevation navigator item or an error.

```APIDOC
## _InteriorElevationNavigatorItemOrError

### Description
Contains an interior elevation navigator item or an error.

### Variables
- **interiorElevationNavigatorItem** (InteriorElevationNavigatorItem, optional) – The details of an interior elevation navigator item.
- **error** (Error, optional) – The details of an error.
```

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

### _Pen

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Defines a pen attribute, including its index, color, weight, and description.

```APIDOC
## _Pen

### Description
A pen attribute.

### Variables
- **index** (int) – The index number of a pen.
- **color** (RGBColor) – A color model represented via its red, green and blue components.
- **weight** (float) – The thickness of the pen defined in millimeters.
- **description** (str) – The description of the pen.
```

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

### acbasetype_constructor_wrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper for constructors of base types in Archicad.

```APIDOC
## acbasetype_constructor_wrapper()

### Description
A wrapper for constructors of base types in Archicad.

### Parameters
- **args**: Arguments for the constructor.
- **type**: The type to construct.
```

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

### Commands

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A comprehensive collection of commands for various Archicad operations, including attribute management, element manipulation, and data retrieval.

```APIDOC
## Commands

### Description
A comprehensive collection of commands for various Archicad operations, including attribute management, element manipulation, and data retrieval.

### Methods
- **CloneProjectMapItemToViewMap()**: Clones a project map item to the view map.
- **CreateAttributeFolders()**: Creates attribute folders.
- **CreateLayout()**: Creates a new layout.
- **CreateLayoutSubset()**: Creates a subset for layouts.
- **CreateViewMapFolder()**: Creates a folder in the view map.
- **DeleteAttributeFolders()**: Deletes attribute folders.
- **DeleteAttributes()**: Deletes attributes.
- **DeleteNavigatorItems()**: Deletes items from the navigator.
- **ExecuteAddOnCommand()**: Executes a command from an add-on.
- **Get2DBoundingBoxes()**: Retrieves 2D bounding boxes of elements.
- **Get3DBoundingBoxes()**: Retrieves 3D bounding boxes of elements.
- **GetActivePenTables()**: Gets all active pen tables.
- **GetAllClassificationSystems()**: Retrieves all classification systems.
- **GetAllClassificationsInSystem()**: Retrieves all classifications within a system.
- **GetAllElements()**: Retrieves all elements in the project.
- **GetAllPropertyGroupIds()**: Retrieves all property group IDs.
- **GetAllPropertyIds()**: Retrieves all property IDs.
- **GetAllPropertyIdsOfElements()**: Retrieves property IDs for specified elements.
- **GetAllPropertyNames()**: Retrieves all property names.
- **GetAttributeFolderStructure()**: Gets the structure of attribute folders.
- **GetAttributeFolders()**: Retrieves attribute folders.
- **GetAttributesByType()**: Retrieves attributes by their type.
- **GetAttributesIndices()**: Retrieves indices of attributes.
- **GetBuildingMaterialAttributes()**: Retrieves building material attributes.
- **GetBuiltInContainerNavigatorItems()**: Gets built-in navigator items.
- **GetClassificationItemAvailability()**: Checks the availability of classification items.
- **GetClassificationSystemIds()**: Retrieves classification system IDs.
- **GetClassificationSystems()**: Retrieves classification systems.
- **GetClassificationsOfElements()**: Retrieves classifications associated with elements.
- **GetComponentsOfElements()**: Retrieves components of elements.
- **GetCompositeAttributes()**: Retrieves composite attributes.
- **GetDetailNavigatorItems()**: Gets detail navigator items.
- **GetDetailsOfClassificationItems()**: Retrieves details of classification items.
- **GetDetailsOfProperties()**: Retrieves details of properties.
- **GetDocument3DNavigatorItems()**: Gets 3D document navigator items.
- **GetElementsByClassification()**: Retrieves elements by classification.
- **GetElementsByType()**: Retrieves elements by type.
- **GetElementsRelatedToZones()**: Retrieves elements related to zones.
- **GetElevationNavigatorItems()**: Gets elevation navigator items.
- **GetFillAttributes()**: Retrieves fill attributes.
- **GetInteriorElevationNavigatorItems()**: Gets interior elevation navigator items.
- **GetLayerAttributes()**: Retrieves layer attributes.
- **GetLayerCombinationAttributes()**: Retrieves layer combination attributes.
- **GetLayoutSettings()**: Retrieves layout settings.
- **GetLineAttributes()**: Retrieves line attributes.
- **GetNavigatorItemTree()**: Gets the navigator item tree.
- **GetNavigatorItemsType()**: Retrieves the type of navigator items.
- **GetPenTableAttributes()**: Retrieves pen table attributes.
- **GetProfileAttributePreview()**: Gets a preview of profile attributes.
- **GetProfileAttributes()**: Retrieves profile attributes.
- **GetPropertyDefinitionAvailability()**: Checks the availability of property definitions.
- **GetPropertyGroups()**: Retrieves property groups.
- **GetPropertyIds()**: Retrieves property IDs.
- **GetPropertyValuesOfElementComponents()**: Retrieves property values for element components.
- **GetPropertyValuesOfElements()**: Retrieves property values for elements.
- **GetPublisherSetNames()**: Retrieves publisher set names.
- **GetSectionNavigatorItems()**: Gets section navigator items.
- **GetSelectedElements()**: Retrieves the currently selected elements.
- **GetStoryNavigatorItems()**: Gets story navigator items.
- **GetSurfaceAttributes()**: Retrieves surface attributes.
- **GetTypesOfElements()**: Retrieves the types of elements.
- **GetWorksheetNavigatorItems()**: Gets worksheet navigator items.
- **GetZoneCategoryAttributes()**: Retrieves zone category attributes.
- **IsAddOnCommandAvailable()**: Checks if an add-on command is available.
- **IsAlive()**: Checks if the Archicad application is running and responsive.
```

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

### _PropertyDefinitionAvailabilityWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper class for PropertyDefinitionAvailability.

```APIDOC
## Class: _PropertyDefinitionAvailabilityWrapper

### Description
A wrapper class for PropertyDefinitionAvailability.

### Variables
* **propertyDefinitionAvailability** (`PropertyDefinitionAvailability`) – Contains the ids of classification items the given property definition is available for.
```

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

### archicad.Commands.CreateLayout

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Creates a new layout in Archicad. This function requires the desired layout name, layout parameters, and the navigator item IDs for both the master layout and its parent.

```APIDOC
## archicad.Commands.CreateLayout

`CreateLayout(_layoutName : str_, _layoutParameters : LayoutParameters_, _masterNavigatorItemId : NavigatorItemId_, _parentNavigatorItemId : NavigatorItemId_)`

Creates a new layout.

Parameters:
    
  * **layoutName** (`str`) – The name of the layout.
  * **layoutParameters** (`LayoutParameters`) – The parameters of the layout.
  * **masterNavigatorItemId** (`NavigatorItemId`) – The identifier of a navigator item.
  * **parentNavigatorItemId** (`NavigatorItemId`) – The identifier of a navigator item.

Returns:
    
The identifier of a navigator item.

Return type:
    
`NavigatorItemId`
```

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

### GetProfileAttributePreview

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Generates and returns preview images for requested profile attributes in base64 format. It takes a list of attribute IDs, desired image dimensions, and an optional background color.

```APIDOC
## GetProfileAttributePreview

### Description
Returns the preview image of each requested profile attribute in a base64 string format.

### Method
GET (Assumed, as it retrieves data)

### Endpoint
(Not specified, assumed to be a Python function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **attributeIds** (`list` of `AttributeIdWrapperItem`) – A list of attribute identifiers.
- **imageWidth** (`int`) – The desired width of the preview image.
- **imageHeight** (`int`) – The desired height of the preview image.
- **backgroundColor** (`RGBColor | None`, optional) – The background color for the preview image. Defaults to None.

### Returns
- **List[ImageOrError]**: A list of preview images or errors.
```

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

### archicad.Commands.CloneProjectMapItemToViewMap

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Clones a specified project map item to the view map. This operation requires the identifiers for both the source project map item and its intended parent in the view map.

```APIDOC
## archicad.Commands.CloneProjectMapItemToViewMap

`CloneProjectMapItemToViewMap(_projectMapNavigatorItemId : NavigatorItemId_, _parentNavigatorItemId : NavigatorItemId_)`

Clones a project map item to the view map.

Parameters:
    
  * **projectMapNavigatorItemId** (`NavigatorItemId`) – The identifier of a navigator item.
  * **parentNavigatorItemId** (`NavigatorItemId`) – The identifier of a navigator item.

Returns:
    
The identifier of a navigator item.

Return type:
    
`NavigatorItemId`
```

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

### create_request

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Creates a request object for interacting with Archicad.

```APIDOC
## create_request

### Description
Creates a request object for interacting with Archicad.

### Method
POST

### Endpoint
`/requests`

### Parameters
#### Request Body
- **request_data** (object) - Required - The data for the request.
```

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

### GetDetailsOfProperties

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the details of property definitions.

```APIDOC
## GetDetailsOfProperties

### Description
Returns the details of property definitions.

### Parameters
- **properties** (list of PropertyIdArrayItem) - Required - A list of property identifiers.

### Returns
- **list** of **PropertyDefinitionOrError** - A list of property definitions or errors.
```

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

### _ImageWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper class for Image.

```APIDOC
## _ImageWrapper

### Description
A wrapper for Image.

### Variables
- **image** (Image) - An image encoded as a Base64 string.
```

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

### post_command

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Posts a command to be executed by Archicad.

```APIDOC
## post_command

### Description
Posts a command to be executed by Archicad.

### Method
POST

### Endpoint
`/commands`

### Parameters
#### Request Body
- **command** (object) - Required - The command to be executed.
```

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

### _PropertyDefinitionWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper class for PropertyDefinition.

```APIDOC
## Class: _PropertyDefinitionWrapper

### Description
A wrapper class for PropertyDefinition.

### Variables
* **propertyDefinition** (`PropertyDefinition`) – A property definition. The default value of a property appears if and only if it is a custom property and is not an expression type property. (This may change in the future.)
```

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

### GetActivePenTables

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the model view and layout book pen table identifiers.

```APIDOC
## GetActivePenTables

### Description
Returns the model view and layout book pen table identifiers.

### Returns
* The attribute’s identifier or an error. `AttributeIdOrError`: The attribute’s identifier or an error.

### Return type
`AttributeIdOrError`
```

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

### _BoundingBox3DWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper for a 3D bounding box.

```APIDOC
## _BoundingBox3DWrapper

### Description
A wrapper for a 3D bounding box.

### Variables
- **boundingBox3D** (`BoundingBox3D`) – A 3D bounding box of an element.
```

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

### _FolderParameters

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Defines the parameters for a folder, specifically its name.

```APIDOC
## _FolderParameters

### Description
The parameters of a folder.

### Variables
- **name** (str) - The name of the folder.
```

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

### _BoundingBox3D

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents a 3D bounding box with minimum and maximum X, Y, and Z values.

```APIDOC
## _BoundingBox3D

### Description
A 3D bounding box of an element.

### Variables
- **xMin** (`float`) – The minimum X value of the bounding box.
- **yMin** (`float`) – The minimum Y value of the bounding box.
- **zMin** (`float`) – The minimum Z value of the bounding box.
- **xMax** (`float`) – The maximum X value of the bounding box.
- **yMax** (`float`) – The maximum Y value of the bounding box.
- **zMax** (`float`) – The maximum Z value of the bounding box.
```

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

### GetPublisherSetNames

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the names of all available publisher sets. This function takes no parameters and returns a list of strings.

```APIDOC
## GetPublisherSetNames() 

### Description
Returns the names of available publisher sets.

### Returns
The names of available publisher sets.

### Return Type
list of str
```

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

### _BoundingBox2DWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper for a 2D bounding box.

```APIDOC
## _BoundingBox2DWrapper

### Description
A wrapper for a 2D bounding box.

### Variables
- **boundingBox2D** (`BoundingBox2D`) – The 2D bounding box of an element.
```

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

### GetClassificationSystemIds

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the list of available classification systems.

```APIDOC
## GetClassificationSystemIds

### Description
Retrieves a list of all available classification systems within the Archicad project.

### Method
GET (assumed, as it retrieves data)

### Endpoint
Not applicable (Python package function)

### Parameters
None

### Returns
#### Success Response
- A list of classification system identifiers.

### Response Example
```json
[
  {"id": "system_1"},
  {"id": "system_2"}
]
```
```

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

### _Image

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents an image encoded as a Base64 string.

```APIDOC
## _Image

### Description
An image encoded as a Base64 string.

### Variables
- **content** (str) - The image content as a string.
```

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

### GetBuiltInContainerNavigatorItems

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the details of the built-in container navigator items identified by their Ids.

```APIDOC
## GetBuiltInContainerNavigatorItems

### Description
Retrieves the details for built-in container navigator items, specified by their unique IDs.

### Method
GET (assumed, as it retrieves data)

### Endpoint
Not applicable (Python package function)

### Parameters
#### Query Parameters
- **navigatorItemIds** (list of NavigatorItemIdWrapper) - Required - A list of navigator item identifiers.

### Returns
#### Success Response
- A list of built-in container navigator items, potentially including errors.

### Response Example
```json
[
  {
    "navigator_item_id": "nav_item_1",
    "name": "Project Structure"
  },
  {
    "navigator_item_id": "nav_item_2",
    "error": "Navigator item not found"
  }
]
```
```

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

### Utilities Functions

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

This section covers the utility functions provided by the Archicad Python Package. These functions offer helpful operations for finding items in classification and navigator trees, retrieving property values, and managing files.

```APIDOC
## Utilities Functions

### Description
Provides utility functions for common operations within the Archicad Python Package.

### Functions

*   **`Utilities.FindClassificationItemInSystem()`**
    Finds a classification item within the Archicad system.

*   **`Utilities.FindClassificationSystem()`**
    Retrieves the classification system.

*   **`Utilities.FindInClassificationItemTree(item_id)`**
    Finds an item within the classification item tree.
    *   **item_id** (Types.ClassificationItemId) - The ID of the classification item to find.

*   **`Utilities.FindInNavigatorItemTree(item_id)`**
    Finds an item within the navigator item tree.
    *   **item_id** (Types.NavigatorItemId) - The ID of the navigator item to find.

*   **`Utilities.GetBuiltInPropertyId(property_name)`**
    Gets the ID of a built-in Archicad property.
    *   **property_name** (string) - The name of the property.

*   **`Utilities.GetDisplayValueFromPropertyEnumValueId(enum_value_id)`**
    Gets the display value for a given property enum value ID.
    *   **enum_value_id** (Types.PropertyEnumValueId) - The ID of the enum value.

*   **`Utilities.GetPropertyValuesDictionary(element)`**
    Retrieves a dictionary of property values for a given Archicad element.
    *   **element** (object) - The Archicad element for which to get property values.

*   **`Utilities.GetUserDefinedPropertyId(property_name)`**
    Gets the ID of a user-defined Archicad property.
    *   **property_name** (string) - The name of the property.

*   **`Utilities.GetValueFromPropertyValue(property_value)`**
    Extracts the actual value from a property value object.
    *   **property_value** (Types.PropertyValue) - The property value object.

*   **`Utilities.OpenFile(file_path)`**
    Opens a file in Archicad.
    *   **file_path** (string) - The path to the file to open.

```

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

### AddOnCommandId

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents the identifier of an Add-On command, including its namespace and command name.

```APIDOC
## AddOnCommandId

### Description
The identifier of an Add-On command.

### Variables
- **commandNamespace** (str) - The namespace of the Add-On command.
- **commandName** (str) - The name of the Add-On command.
```

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

### GetAllElements

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Retrieves the identifiers of all elements in the current plan.

```APIDOC
## GetAllElements

### Description
Returns the identifier of every element in the current plan.

### Returns
* A list of elements.

### Return type
`list` of `ElementIdArrayItem`
```

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

### _BoundingBox2D

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents a 2D bounding box with minimum and maximum X and Y values.

```APIDOC
## _BoundingBox2D

### Description
The 2D bounding box of an element.

### Variables
- **xMin** (`float`) – The minimum X value of the bounding box.
- **yMin** (`float`) – The minimum Y value of the bounding box.
- **xMax** (`float`) – The maximum X value of the bounding box.
- **yMax** (`float`) – The maximum Y value of the bounding box.
```

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

### _InteriorElevationNavigatorItem

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents the details of an interior elevation navigator item.

```APIDOC
## _InteriorElevationNavigatorItem

### Description
The details of an interior elevation navigator item.

### Variables
- **navigatorItemId** (NavigatorItemId) – The identifier of a navigator item.
- **prefix** (str) – The prefix of the navigator item’s name.
- **name** (str) – The name of the navigator item.
```

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

### MoveAttributesAndFolders

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Moves specified attributes and attribute folders to a target folder.

```APIDOC
## MoveAttributesAndFolders

### Description
Moves attributes and attribute folders.

### Parameters
#### Path Parameters
- **attributeFolderIds** (list of AttributeFolderIdWrapperItem) - Required - A list of attribute folder identifiers.
- **attributeIds** (list of AttributeIdWrapperItem) - Required - A list of attribute identifiers.
- **targetFolderId** (AttributeFolderId) - Required - The identifier of an attribute folder.
```

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

### GetDetailNavigatorItems

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Returns the details of the detail navigator items identified by their Ids.

```APIDOC
## GetDetailNavigatorItems

### Description
Returns the details of the detail navigator items identified by their Ids.

### Parameters
- **navigatorItemIds** (list of NavigatorItemIdWrapper) - Required - A list of navigator item identifiers.

### Returns
- **list** of **DetailNavigatorItemOrError** - A list of detail navigator items.
```

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

### _LayoutParameters

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents the parameters of a layout in Archicad, including its dimensions, margins, numbering, and revision information.

```APIDOC
## Class _LayoutParameters

### Description
The parameters of the layout.

### Variables:

* **horizontalSize** (`float`) – The horizontal size of the layout in millimeters.
* **verticalSize** (`float`) – The vertical size of the layout in millimeters.
* **leftMargin** (`float`) – The layout margin from the left side of the paper.
* **topMargin** (`float`) – The layout margin from the top side of the paper.
* **rightMargin** (`float`) – The layout margin from the right side of the paper.
* **bottomMargin** (`float`) – The layout margin from the bottom side of the paper.
* **customLayoutNumber** (`str`) – The custom ID.
* **customLayoutNumbering** (`bool`) – Defines whether a unique ID is used for the current layout or not.
* **doNotIncludeInNumbering** (`bool`) – Defines whether this layout is included in automatic ID assignment or not.
* **displayMasterLayoutBelow** (`bool`) – Defines whether to display the master layout above or below the layout.
* **layoutPageNumber** (`int`) – The page number of layout when this layout contains multi-page drawings.
* **actPageIndex** (`int`) – The actual index of layout inside the multi-page layout.
* **currentRevisionId** (`str`) – The ID of the current document revision of the layout.
* **currentFinalRevisionId** (`str`) – The ID with optional suffix of the current document revision of the layout.
* **hasIssuedRevision** (`bool`) – Defines whether one or more issued document revisions have already been created for the layout or not.
* **hasActualRevision** (`bool`) – Defines whether an open document revision exists for the layout or not.
```

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

### _PenTableAttributeWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper class for a PenTableAttribute.

```APIDOC
## _PenTableAttributeWrapper

### Description
A wrapper for a pen table attribute.

### Variables
- **penTableAttribute** (PenTableAttribute) – A pen table attribute.
```

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

### ElevationNavigatorItem

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Contains details for an elevation navigator item, including its ID, prefix, and name.

```APIDOC
## Class: _ElevationNavigatorItem

### Description
The details of an elevation navigator item.

### Variables
* **navigatorItemId** (`NavigatorItemId`) – The identifier of a navigator item.
* **prefix** (`str`) – The prefix of the navigator item’s name.
* **name** (`str`) – The name of the navigator item.
```

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

### _ClassificationSystemWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper class for ClassificationSystem, providing a base type for Archicad elements.

```APIDOC
## _ClassificationSystemWrapper

### Description
A wrapper class for ClassificationSystem.

### Variables
* **classificationSystem** (`ClassificationSystem`) - The details of a classification system.
```

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

### _BuildingMaterialAttributeWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper for a building material attribute.

```APIDOC
## _BuildingMaterialAttributeWrapper

### Description
A wrapper for a building material attribute.

### Variables
- **buildingMaterialAttribute** (`BuildingMaterialAttribute`) – A building material attribute.
```

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

### _BoundingBox3DOrError

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Represents either a 3D bounding box or an error.

```APIDOC
## _BoundingBox3DOrError

### Description
A 3D bounding box or an error.

### Variables
- **boundingBox3D** (`BoundingBox3D`, optional) – A 3D bounding box of an element.
- **error** (`Error`, optional) – The details of an error.
```

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

### ElementsWrapper

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

A wrapper class for a list of elements.

```APIDOC
## Class: _ElementsWrapper

### Description
A wrapper for a list of elements.

### Variables
* **elements** (`list` of `ElementIdArrayItem`) – A list of elements.
```

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

### matches

Source: https://archicadapi.graphisoft.com/archicadPythonPackage/archicad.html

Checks if a value matches a given pattern.

```APIDOC
## matches()

### Description
Checks if a value matches a given pattern.

### Parameters
- **value**: The value to check.
- **pattern**: The pattern to match against.
```