archicad package

Subpackages

Submodules

archicad.acbasetype module

Typing framework for the Archicad JSON interface

archicad.acbasetype.acbasetype_constructor_wrapper(acbasetyp: type)
archicad.acbasetype.is_class(typ) → bool

Returns True if the parameter is a class type

archicad.acbasetype.is_generic_list(typ) → bool

Returns True if the parameter is a generic list

archicad.acbasetype.is_union(typ) → bool

Returns True if the parameter is originated from typing.Union

archicad.acbasetype.none_constructor(*args, **kwargs) → None

archicad.commands module

Graphisoft

class archicad.commands.BasicCommands(req: Request)

Bases: object

Collection of the Archicad JSON interface commands

GetProductInfo() → Tuple[int, int, str]

Accesses the version information from the running Archicad.

Returns:

The version of the running Archicad. int: The build number of the running Archicad. str: The language code of the running Archicad.

Return type:

int

IsAlive() → bool

Checks if the Archicad connection is alive.

Returns:

Returns true if the connection is alive.

Return type:

bool

exception archicad.commands.UnsucceededCommandCall

Bases: Exception

archicad.commands.post_command(req: Request, jsonStr: str) → Dict[str, Any]

archicad.connection module

Graphisoft

class archicad.connection.ACConnection(port: int)

Bases: object

Represents a living connection to an existing Archicad instance

Variables:

  • version (int) – The version of the current Archicad instance.

  • build (int) – The build number of the current Archicad instance.

  • lang (str) – The language code of the current Archicad instance.

  • commands – The commands can be called through this object.

  • types – The data types of commands can be access through this object.

  • utilities – Some other useful commands can be called through this object.

build
commands
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

static connect_from_args()
static find_first_port() → int
static find_ports(ports: slice) → List[int]
lang
port
static port_from_args() → int | None

Tries to extract hostname and port number from command line arguments Returns the tuple of the hostame and port number or None

request
types
utilities
version
archicad.connection.create_request(port: int) → Request

Creates request

archicad.handlers module

archicad.handlers.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.

archicad.validators module

archicad.validators.listitem_validator(*validators: Callable[[Any], bool])
archicad.validators.matches(pattern: str)
archicad.validators.max_items(max_items: int)
archicad.validators.max_length(max_length: int)
archicad.validators.maximum(maximum: int | float, exclusive_maximum: bool)
archicad.validators.min_items(min_items: int)
archicad.validators.min_length(min_length: int)
archicad.validators.minimum(minimum: int | float, exclusive_minimum: bool)
archicad.validators.multiple_of(multiple_of: int | float)
archicad.validators.unique_items()
archicad.validators.value_set(values)

archicad.versioning module

Module contents

The archicad package from Graphisoft

class archicad.ACConnection(port: int)

Bases: object

Represents a living connection to an existing Archicad instance

Variables:

  • version (int) – The version of the current Archicad instance.

  • build (int) – The build number of the current Archicad instance.

  • lang (str) – The language code of the current Archicad instance.

  • commands – The commands can be called through this object.

  • types – The data types of commands can be access through this object.

  • utilities – Some other useful commands can be called through this object.

build
commands
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

static connect_from_args()
static find_first_port() → int
static find_ports(ports: slice) → List[int]
lang
port
static port_from_args() → int | None

Tries to extract hostname and port number from command line arguments Returns the tuple of the hostame and port number or None

request
types
utilities
version
class archicad.Commands(req: Request)

Bases: object

Collection of the Archicad JSON interface commands

CloneProjectMapItemToViewMap(projectMapNavigatorItemId: NavigatorItemId, parentNavigatorItemId: NavigatorItemId) → 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

CreateAttributeFolders(attributeFolders: List[AttributeFolderCreationParameters]) → List[ExecutionResult]

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

CreateLayout(layoutName: str, layoutParameters: LayoutParameters, masterNavigatorItemId: NavigatorItemId, parentNavigatorItemId: NavigatorItemId) → 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

CreateLayoutSubset(subsetParameters: Subset, parentNavigatorItemId: NavigatorItemId) → 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

CreateViewMapFolder(folderParameters: FolderParameters, parentNavigatorItemId: NavigatorItemId | None = None, previousNavigatorItemId: NavigatorItemId | None = None) → NavigatorItemId

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

DeleteAttributeFolders(attributeFolderIds: List[AttributeFolderIdWrapperItem]) → List[ExecutionResult]

Deletes attribute folders and all the deletable attributes and folders it contains. To delete a folder, its identifier has to be provided.

Parameters:

attributeFolderIds (list of AttributeFolderIdWrapperItem) – A list of attribute folder identifiers.

Returns:

A list of execution results.

Return type:

list of ExecutionResult

DeleteAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[ExecutionResult]

Deletes attributes.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of execution results.

Return type:

list of ExecutionResult

DeleteNavigatorItems(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[ExecutionResult]

Deletes items from navigator tree.

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of execution results.

Return type:

list of ExecutionResult

ExecuteAddOnCommand(addOnCommandId: AddOnCommandId, addOnCommandParameters: AddOnCommandParameters | None = None) → AddOnCommandResponse

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

Get2DBoundingBoxes(elements: List[ElementIdArrayItem]) → List[BoundingBox2DOrError]

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

Get3DBoundingBoxes(elements: List[ElementIdArrayItem]) → List[BoundingBox3DOrError]

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

GetActivePenTables() → Tuple[AttributeIdOrError, AttributeIdOrError]

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

GetAllClassificationSystems() → List[ClassificationSystem]

Returns the list of available classification systems.

Returns:

A list of classification systems.

Return type:

list of ClassificationSystem

GetAllClassificationsInSystem(classificationSystemId: ClassificationSystemId) → List[ClassificationItemArrayItem]

Returns the tree of classifications in the given classification system.

Parameters:

classificationSystemId (ClassificationSystemId) – The identifier of a classification system.

Returns:

A list of classification items.

Return type:

list of ClassificationItemArrayItem

GetAllElements() → List[ElementIdArrayItem]

Returns the identifier of every element in the current plan.

Returns:

A list of elements.

Return type:

list of ElementIdArrayItem

GetAllPropertyGroupIds(propertyType: str | None = None) → List[PropertyGroupIdArrayItem]

Returns the identifier of every property group in the current plan. The optional propertyType parameter can be used to filter the results based on the type of the property group (Built-in or User Defined).

Parameters:

propertyType (str, optional) – The type of a property group or a property definition.

Returns:

A list of property group identifiers.

Return type:

list of PropertyGroupIdArrayItem

GetAllPropertyIds(propertyType: str | None = None) → List[PropertyIdArrayItem]

Returns the identifier of every property in the current plan. The optional propertyType parameter can be used to filter the results based on the type of the property (Built-in or User Defined).

Parameters:

propertyType (str, optional) – The type of a property group or a property definition.

Returns:

A list of property identifiers.

Return type:

list of PropertyIdArrayItem

GetAllPropertyIdsOfElements(elements: List[ElementIdArrayItem], propertyType: str | None = None) → List[PropertyIdsOfElementOrError]

Returns all property identifiers of the given elements. The optional propertyType parameter can be used to filter the results based on the type of the property (Built-in or User Defined).

Parameters:

  • elements (list of ElementIdArrayItem) – A list of elements.

  • propertyType (str, optional) – The type of a property group or a property definition.

Returns:

A list of property identifiers of elements or errors.

Return type:

list of PropertyIdsOfElementOrError

GetAllPropertyNames() → List[PropertyUserId]

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

Returns:

A list of PropertyUserId objects.

Return type:

list of PropertyUserId

GetAttributeFolderStructure(attributeType: str, path: List[str] | None = None) → AttributeFolderStructure

Returns the detailed folder structure for the attributes of a given type. If the path is not given, the root folder will be returned

Parameters:

  • attributeType (str) – The type of an attribute.

  • path (list of str, optional) – A list of attribute folder names. May be empty.

Returns:

The details of an attribute folder structure.

Return type:

AttributeFolderStructure

GetAttributeFolders(attributeFolderIds: List[AttributeFolderIdWrapperItem]) → List[AttributeFolderOrError]

Returns the detailed attribute folders identified by their Ids.

Parameters:

attributeFolderIds (list of AttributeFolderIdWrapperItem) – A list of attribute folder identifiers.

Returns:

A list of attribute folders.

Return type:

list of AttributeFolderOrError

GetAttributesByType(attributeType: str) → List[AttributeIdWrapperItem]

Returns the identifier of every attribute of the given type.

Parameters:

attributeType (str) – The type of an attribute.

Returns:

A list of attribute identifiers.

Return type:

list of AttributeIdWrapperItem

GetAttributesIndices(attributeIds: List[AttributeIdWrapperItem]) → List[AttributeIndexAndGuidOrError]

Returns the requested indices and guids of attributes.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of complete attribute identifiers.

Return type:

list of AttributeIndexAndGuidOrError

GetBuildingMaterialAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[BuildingMaterialAttributeOrError]

Returns the detailed building material attributes identified by their GUIDs.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of building material attributes and potential errors.

Return type:

list of BuildingMaterialAttributeOrError

GetBuiltInContainerNavigatorItems(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[BuiltInContainerNavigatorItemOrError]

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

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of built-in container navigator items.

Return type:

list of BuiltInContainerNavigatorItemOrError

GetClassificationItemAvailability(classificationItemIds: List[ClassificationItemIdArrayItem]) → List[ClassificationItemAvailabilityOrError]

Returns the ids of property definitions available for a given classification item.

Parameters:

classificationItemIds (list of ClassificationItemIdArrayItem) – A list of classification item identifiers.

Returns:

A list of classification item avalabilities.

Return type:

list of ClassificationItemAvailabilityOrError

GetClassificationSystemIds() → List[ClassificationSystemIdArrayItem]

Returns the list of available classification systems.

Returns:

A list of classification system identifiers.

Return type:

list of ClassificationSystemIdArrayItem

GetClassificationSystems(classificationSystemIds: List[ClassificationSystemIdArrayItem]) → List[ClassificationSystemOrError]

Returns the details of classification systems identified by their GUIDs.

Parameters:

classificationSystemIds (list of ClassificationSystemIdArrayItem) – A list of classification system identifiers.

Returns:

A list of classification systems or errors.

Return type:

list of ClassificationSystemOrError

GetClassificationsOfElements(elements: List[ElementIdArrayItem], classificationSystemIds: List[ClassificationSystemIdArrayItem]) → List[ElementClassificationOrError]

Returns the classification of the given elements in the given classification systems.

Parameters:

  • elements (list of ElementIdArrayItem) – A list of elements.

  • classificationSystemIds (list of ClassificationSystemIdArrayItem) – A list of classification system identifiers.

Returns:

A list of element classification identifiers or errors.

Return type:

list of ElementClassificationOrError

GetComponentsOfElements(elements: List[ElementIdArrayItem]) → List[ElementComponentsOrError]

Returns the identifier of every component for a list of elements. The order of the returned list is the same as the given elements.

Parameters:

elements (list of ElementIdArrayItem) – A list of elements.

Returns:

Array of component list or error.

Return type:

list of ElementComponentsOrError

GetCompositeAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[CompositeAttributeOrError]

Returns the detailed composite attributes identified by their GUIDs.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of the composite attributes and potential errors.

Return type:

list of CompositeAttributeOrError

GetDetailNavigatorItems(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[DetailNavigatorItemOrError]

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

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of detail navigator items.

Return type:

list of DetailNavigatorItemOrError

GetDetailsOfClassificationItems(classificationItemIds: List[ClassificationItemIdArrayItem]) → List[ClassificationItemOrError]

Returns the details of classification items.

Parameters:

classificationItemIds (list of ClassificationItemIdArrayItem) – A list of classification item identifiers.

Returns:

A list of classification items or errors.

Return type:

list of ClassificationItemOrError

GetDetailsOfProperties(properties: List[PropertyIdArrayItem]) → List[PropertyDefinitionOrError]

Returns the details of property definitions.

Parameters:

properties (list of PropertyIdArrayItem) – A list of property identifiers.

Returns:

A list of property definitions or errors.

Return type:

list of PropertyDefinitionOrError

GetDocument3DNavigatorItems(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[Document3DNavigatorItemOrError]

Returns the details of the 3D document navigator items identified by their Ids.

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of 3D document navigator items.

Return type:

list of Document3DNavigatorItemOrError

GetElementsByClassification(classificationItemId: ClassificationItemId) → List[ElementIdArrayItem]

Returns the identifier of every element with the given classification identifier.

Parameters:

classificationItemId (ClassificationItemId) – The identifier of a classification item.

Returns:

A list of elements.

Return type:

list of ElementIdArrayItem

GetElementsByType(elementType: str) → List[ElementIdArrayItem]

Returns the identifier of every element of the given type on the plan.

Parameters:

elementType (str) – The type of an element.

Returns:

A list of elements.

Return type:

list of ElementIdArrayItem

GetElementsRelatedToZones(zones: List[ElementIdArrayItem], elementTypes: List[str] | None = None) → List[ElementsOrError]

Returns related elements of the given zones. The related elements will be grouped by type. If multiple zones was given, then the order of the returned list is that of the given zones.

Parameters:

  • zones (list of ElementIdArrayItem) – A list of elements.

  • elementTypes (list of str, optional) – A list of element types.

Returns:

A list of ElementsOrError items.

Return type:

list of ElementsOrError

GetElevationNavigatorItems(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[ElevationNavigatorItemOrError]

Returns the detailed elevation navigator items identified by their Ids.

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of elevation navigator items.

Return type:

list of ElevationNavigatorItemOrError

GetFillAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[FillAttributeOrError]

Returns the detailed fill attributes identified by their GUIDs.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of fill attributes and potential errors.

Return type:

list of FillAttributeOrError

GetInteriorElevationNavigatorItems(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[InteriorElevationNavigatorItemOrError]

Returns the details of the interior elevation navigator items identified by their Ids.

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of interior elevation navigator items.

Return type:

list of InteriorElevationNavigatorItemOrError

GetLayerAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[LayerAttributeOrError]

Returns the detailed layer attributes identified by their GUIDs.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of layer attributes and potential errors.

Return type:

list of LayerAttributeOrError

GetLayerCombinationAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[LayerCombinationAttributeOrError]

Returns the detailed layer combination attributes identified by their GUIDs.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of layer combination attributes and potential errors.

Return type:

list of LayerCombinationAttributeOrError

GetLayoutSettings(layoutNavigatorItemId: NavigatorItemId) → LayoutParameters

Returns the parameters (settings) of the given layout.

Parameters:

layoutNavigatorItemId (NavigatorItemId) – The identifier of a navigator item.

Returns:

The parameters of the layout.

Return type:

LayoutParameters

GetLineAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[LineAttributeOrError]

Returns the detailed line attributes identified by their GUIDs.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of line attributes and potential errors.

Return type:

list of LineAttributeOrError

GetNavigatorItemTree(navigatorTreeId: NavigatorTreeId) → NavigatorTree

Returns the tree of navigator items.

Parameters:

navigatorTreeId (NavigatorTreeId) – The identifier of a navigator item tree.

Returns:

A tree of navigator items.

Return type:

NavigatorTree

GetNavigatorItemsType(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[NavigatorItemIdAndTypeOrError]

Returns all navigator item types based on the navigator item identifiers given. An error is returned for each identifier that is not found.

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of objects that consist of a navigator item identifier and a type.

Return type:

list of NavigatorItemIdAndTypeOrError

GetPenTableAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[PenTableAttributeOrError]

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

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of pen table attributes and potential errors.

Return type:

list of PenTableAttributeOrError

GetProductInfo() → Tuple[int, int, str]

Accesses the version information from the running Archicad.

Returns:

The version of the running Archicad. int: The build number of the running Archicad. str: The language code of the running Archicad.

Return type:

int

GetProfileAttributePreview(attributeIds: List[AttributeIdWrapperItem], imageWidth: int, imageHeight: int, backgroundColor: RGBColor | None = None) → List[ImageOrError]

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

Parameters:

  • attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

  • imageWidth (int) – The width of the preview image.

  • imageHeight (int) – The height of the preview image.

  • backgroundColor (RGBColor, optional) – A color model represented via its red, green and blue components.

Returns:

A list of images and potential errors.

Return type:

list of ImageOrError

GetProfileAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[ProfileAttributeOrError]

Returns the detailed profile attributes identified by their GUIDs.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of the profile attributes and potential errors.

Return type:

list of ProfileAttributeOrError

GetPropertyDefinitionAvailability(propertyIds: List[PropertyIdArrayItem]) → List[PropertyDefinitionAvailabilityOrError]

Returns the ids of classification items a given property definition is available for.

Parameters:

propertyIds (list of PropertyIdArrayItem) – A list of property identifiers.

Returns:

A list of classification item avalabilities.

Return type:

list of PropertyDefinitionAvailabilityOrError

GetPropertyGroups(propertyGroupIds: List[PropertyGroupIdArrayItem]) → List[PropertyGroupOrError]

Returns the details of property groups.

Parameters:

propertyGroupIds (list of PropertyGroupIdArrayItem) – A list of property group identifiers.

Returns:

A list of property groups or errors.

Return type:

list of PropertyGroupOrError

GetPropertyIds(properties: List[PropertyUserId]) → List[PropertyIdOrError]

Returns the identifiers of property definitions for the requested property names.

Parameters:

properties (list of PropertyUserId) – A list of PropertyUserId objects.

Returns:

A list of property identifiers or errors.

Return type:

list of PropertyIdOrError

GetPropertyValuesOfElementComponents(elementComponents: List[ElementComponentIdArrayItem], properties: List[PropertyIdArrayItem]) → List[PropertyValuesOrError]

Returns the property values of the components for the given property.

Parameters:

  • elementComponents (list of ElementComponentIdArrayItem) – List of components of elements.

  • properties (list of PropertyIdArrayItem) – A list of property identifiers.

Returns:

A list of property value lists.

Return type:

list of PropertyValuesOrError

GetPropertyValuesOfElements(elements: List[ElementIdArrayItem], properties: List[PropertyIdArrayItem]) → List[PropertyValuesOrError]

Returns the property values of the elements for the given property.

Parameters:

  • elements (list of ElementIdArrayItem) – A list of elements.

  • properties (list of PropertyIdArrayItem) – A list of property identifiers.

Returns:

A list of property value lists.

Return type:

list of PropertyValuesOrError

GetPublisherSetNames() → List[str]

Returns the names of available publisher sets.

Returns:

The names of available publisher sets.

Return type:

list of str

GetSectionNavigatorItems(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[SectionNavigatorItemOrError]

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

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of section navigator items.

Return type:

list of SectionNavigatorItemOrError

GetSelectedElements(onlyEditable: bool | None = None, onlySupportedTypes: bool | None = None) → List[ElementIdArrayItem]

Returns the identifiers of selected elements in the current plan.

Parameters:

  • onlyEditable (bool, optional) – Optional parameter that defines whether the selection list should include only the editable elements or all of them. The default value is FALSE

  • onlySupportedTypes (bool, optional) – Optional parameter. When it is set to true, only elements with types that are supported by any other JSON API command will be returned.

Returns:

A list of elements.

Return type:

list of ElementIdArrayItem

GetStoryNavigatorItems(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[StoryNavigatorItemOrError]

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

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of story navigator items.

Return type:

list of StoryNavigatorItemOrError

GetSurfaceAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[SurfaceAttributeOrError]

Returns the detailed surface attributes identified by their GUIDs.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of surface attributes and potential errors.

Return type:

list of SurfaceAttributeOrError

GetTypesOfElements(elements: List[ElementIdArrayItem]) → List[TypeOfElementOrError]

Returns the types of the given elements.

Parameters:

elements (list of ElementIdArrayItem) – A list of elements.

Returns:

A list of element types or errors.

Return type:

list of TypeOfElementOrError

GetWorksheetNavigatorItems(navigatorItemIds: List[NavigatorItemIdWrapper]) → List[WorksheetNavigatorItemOrError]

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

Parameters:

navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

Returns:

A list of worksheet navigator items.

Return type:

list of WorksheetNavigatorItemOrError

GetZoneCategoryAttributes(attributeIds: List[AttributeIdWrapperItem]) → List[ZoneCategoryAttributeOrError]

Returns the detailed zone category attributes identified by their GUIDs.

Parameters:

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

Returns:

A list of zone category attributes and potential errors.

Return type:

list of ZoneCategoryAttributeOrError

IsAddOnCommandAvailable(addOnCommandId: AddOnCommandId) → bool

Checks if the command is available or not.

Parameters:

addOnCommandId (AddOnCommandId) – The identifier of an Add-On command.

Returns:

Returns true if the command is available.

Return type:

bool

IsAlive() → bool

Checks if the Archicad connection is alive.

Returns:

Returns true if the connection is alive.

Return type:

bool

MoveAttributesAndFolders(attributeFolderIds: List[AttributeFolderIdWrapperItem], attributeIds: List[AttributeIdWrapperItem], targetFolderId: AttributeFolderId)

Moves attributes and attribute folders.

Parameters:

  • attributeFolderIds (list of AttributeFolderIdWrapperItem) – A list of attribute folder identifiers.

  • attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

  • targetFolderId (AttributeFolderId) – The identifier of an attribute folder.

MoveNavigatorItem(navigatorItemIdToMove: NavigatorItemId, parentNavigatorItemId: NavigatorItemId, previousNavigatorItemId: NavigatorItemId | None = None)

Moves the given navigator item under the <i>parentNavigatorItemId</i> in the navigator tree. If <i>previousNavigatorItemId</i> is not given then inserts it at the first place under the new parent. If it is given then inserts it after this navigator item.

Parameters:

  • navigatorItemIdToMove (NavigatorItemId) – The identifier of a navigator item.

  • parentNavigatorItemId (NavigatorItemId) – The identifier of a navigator item.

  • previousNavigatorItemId (NavigatorItemId, optional) – The identifier of a navigator item.

RenameAttributeFolders(attributeFolderParametersList: List[AttributeFolderRenameParameters]) → List[ExecutionResult]

Rename attribute folder.

Parameters:

attributeFolderParametersList (list of AttributeFolderRenameParameters) – EMPTY STRING

Returns:

A list of execution results.

Return type:

list of ExecutionResult

RenameNavigatorItem(navigatorItemId: NavigatorItemId, newName: str | None = None, newId: str | None = None)

Renames an existing navigator item by specifying either the name or the ID, or both.

Parameters:

  • navigatorItemId (NavigatorItemId) – The identifier of a navigator item.

  • newName (str, optional) – New name of the navigator item.

  • newId (str, optional) – New ID of the navigator item.

SetClassificationsOfElements(elementClassifications: List[ElementClassification]) → List[ExecutionResult]

Sets the classifications of elements. In order to set the classification of an element to unclassified, omit the classificationItemId field.

Parameters:

elementClassifications (list of ElementClassification) – A list of element classification identifiers.

Returns:

A list of execution results.

Return type:

list of ExecutionResult

SetLayoutSettings(layoutParameters: LayoutParameters, layoutNavigatorItemId: NavigatorItemId)

Sets the parameters (settings) of the given layout.

Parameters:

  • layoutParameters (LayoutParameters) – The parameters of the layout.

  • layoutNavigatorItemId (NavigatorItemId) – The identifier of a navigator item.

SetPropertyValuesOfElements(elementPropertyValues: List[ElementPropertyValue]) → List[ExecutionResult]

Sets the property values of elements.

Parameters:

elementPropertyValues (list of ElementPropertyValue) – A list of element property values.

Returns:

A list of execution results.

Return type:

list of ExecutionResult

class archicad.Types

Bases: object

class AddOnCommandId(commandNamespace: str, commandName: str)

Bases: _ACBaseType

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.

commandName: str
commandNamespace: str
class AddOnCommandIdArrayItem(addOnCommandId: AddOnCommandId)

Bases: _ACBaseType

EMPTY STRING

Variables:

addOnCommandId (AddOnCommandId) – The identifier of an Add-On command.

addOnCommandId: AddOnCommandId
class AddOnCommandParameters

Bases: _ACBaseType

The input parameters of an Add-On command.

class AddOnCommandResponse

Bases: _ACBaseType

The response returned by an Add-On command.

class AttributeFolder(attributeType: str, path: List[str], attributeFolderId: AttributeFolderId, attributeIds: List[AttributeIdWrapperItem], attributeFolderIds: List[AttributeFolderIdWrapperItem])

Bases: _ACBaseType

Identifies an attribute folder. The path of the root folder is repesented by empty array.

Variables:

  • attributeType (str) – The type of an attribute.

  • path (list of str) – A list of attribute folder names. May be empty.

  • attributeFolderId (AttributeFolderId) – The identifier of an attribute folder.

  • attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

  • attributeFolderIds (list of AttributeFolderIdWrapperItem) – A list of attribute folder identifiers.

attributeFolderId: AttributeFolderId
attributeFolderIds: List[AttributeFolderIdWrapperItem]
attributeIds: List[AttributeIdWrapperItem]
attributeType: str
path: List[str]
class AttributeFolderCreationParameters(attributeType: str, path: List[str])

Bases: _ACBaseType

Used to create an attribute folder. The folder type and it’s path needs to be provided.

Variables:

  • attributeType (str) – The type of an attribute.

  • path (list of str) – A list of attribute folder names. May be empty.

attributeType: str
path: List[str]
class AttributeFolderId(guid: UUID)

Bases: _ACBaseType

The identifier of an attribute folder.

Variables:

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

guid: UUID
class AttributeFolderIdWrapperItem(attributeFolderId: AttributeFolderId)

Bases: _ACBaseType

EMPTY STRING

Variables:

attributeFolderId (AttributeFolderId) – The identifier of an attribute folder.

attributeFolderId: AttributeFolderId
class AttributeFolderOrError(attributeFolder: AttributeFolder | None = None, error: Error | None = None)

Bases: _ACUnionType

An attribute folder or an error.

Variables:

  • attributeFolder (AttributeFolder, optional) – Identifies an attribute folder. The path of the root folder is repesented by empty array.

  • error (Error, optional) – The details of an error.

attributeFolder: AttributeFolder | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class AttributeFolderRenameParameters(attributeFolderId: AttributeFolderId, newName: str)

Bases: _ACBaseType

Used to rename an attribute folder. The folder is identified by it’s Id.

Variables:

  • attributeFolderId (AttributeFolderId) – The identifier of an attribute folder.

  • newName (str) – The name of an attribute folder. Legal names are not empty, and do not begin or end with whitespace.

attributeFolderId: AttributeFolderId
newName: str
class AttributeFolderStructure(attributeFolderId: AttributeFolderId, name: str, attributes: List[AttributeHeaderArrayItem] | None = None, subfolders: List[AttributeFolderStructureArrayItem] | None = None)

Bases: _ACBaseType

The details of an attribute folder structure.

Variables:

  • attributeFolderId (AttributeFolderId) – The identifier of an attribute folder.

  • name (str) – The name of an attribute folder. Legal names are not empty, and do not begin or end with whitespace.

  • attributes (list of AttributeHeaderArrayItem, optional) – A list of attribute headers.

  • subfolders (list of AttributeFolderStructureArrayItem, optional) – A list of attribute folder structures.

attributeFolderId: AttributeFolderId
attributes: List[AttributeHeaderArrayItem] | None
name: str
subfolders: List[AttributeFolderStructureArrayItem] | None
class AttributeFolderStructureArrayItem(attributeFolder: AttributeFolderStructure_)

Bases: _ACBaseType

EMPTY STRING

Variables:

attributeFolder (AttributeFolderStructure_) – The details of an attribute folder structure.

attributeFolder: AttributeFolderStructure_
class AttributeFolderStructureOrError(attributeFolderId: AttributeFolderId | None = None, name: str | None = None, attributes: List[AttributeHeaderArrayItem] | None = None, subfolders: List[AttributeFolderStructureArrayItem] | None = None, error: Error | None = None)

Bases: _ACUnionType

An attribute folder structure or an error.

Variables:

  • attributeFolderId (AttributeFolderId, optional) – The identifier of an attribute folder.

  • name (str, optional) – The name of an attribute folder. Legal names are not empty, and do not begin or end with whitespace.

  • attributes (list of AttributeHeaderArrayItem, optional) – A list of attribute headers.

  • subfolders (list of AttributeFolderStructureArrayItem, optional) – A list of attribute folder structures.

  • error (Error, optional) – The details of an error.

attributeFolderId: AttributeFolderId | None
attributes: List[AttributeHeaderArrayItem] | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
name: str | None
subfolders: List[AttributeFolderStructureArrayItem] | None
class AttributeFolderWrapper(attributeFolder: AttributeFolder)

Bases: _ACBaseType

Variables:

attributeFolder (AttributeFolder) – Identifies an attribute folder. The path of the root folder is repesented by empty array.

attributeFolder: AttributeFolder
class AttributeHeader(attributeId: AttributeId, name: str)

Bases: _ACBaseType

The header object of an attribute.

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

attributeId: AttributeId
name: str
class AttributeHeaderArrayItem(attribute: AttributeHeader)

Bases: _ACBaseType

EMPTY STRING

Variables:

attribute (AttributeHeader) – The header object of an attribute.

attribute: AttributeHeader
class AttributeId(guid: UUID)

Bases: _ACBaseType

The identifier of an attribute.

Variables:

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

guid: UUID
class AttributeIdOrError(attributeId: AttributeId | None = None, error: Error | None = None)

Bases: _ACUnionType

The attribute’s identifier or an error.

Variables:

  • attributeId (AttributeId, optional) – The identifier of an attribute.

  • error (Error, optional) – The details of an error.

attributeId: AttributeId | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class AttributeIdWrapperItem(attributeId: AttributeId)

Bases: _ACBaseType

EMPTY STRING

Variables:

attributeId (AttributeId) – The identifier of an attribute.

attributeId: AttributeId
class AttributeIndexAndGuid(guid: UUID, index: float)

Bases: _ACBaseType

The complete identifier of an attribute.

Variables:

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

  • index (float) – The index of an attribute.

guid: UUID
index: float
class AttributeIndexAndGuidOrError(attributeIndexAndGuid: AttributeIndexAndGuid | None = None, error: Error | None = None)

Bases: _ACUnionType

The attribute’s identifier or an error.

Variables:

  • attributeIndexAndGuid (AttributeIndexAndGuid, optional) – The complete identifier of an attribute.

  • error (Error, optional) – The details of an error.

attributeIndexAndGuid: AttributeIndexAndGuid | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class AttributeIndexAndGuidWrapperItem(attributeIndexAndGuid: AttributeIndexAndGuid)

Bases: _ACBaseType

EMPTY STRING

Variables:

attributeIndexAndGuid (AttributeIndexAndGuid) – The complete identifier of an attribute.

attributeIndexAndGuid: AttributeIndexAndGuid
class BoundingBox2D(xMin: float, yMin: float, xMax: float, yMax: float)

Bases: _ACBaseType

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.

xMax: float
xMin: float
yMax: float
yMin: float
class BoundingBox2DOrError(boundingBox2D: BoundingBox2D | None = None, error: Error | None = None)

Bases: _ACUnionType

A 2D bounding box or an error.

Variables:

  • boundingBox2D (BoundingBox2D, optional) – The 2D bounding box of an element.

  • error (Error, optional) – The details of an error.

boundingBox2D: BoundingBox2D | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class BoundingBox2DWrapper(boundingBox2D: BoundingBox2D)

Bases: _ACBaseType

Variables:

boundingBox2D (BoundingBox2D) – The 2D bounding box of an element.

boundingBox2D: BoundingBox2D
class BoundingBox3D(xMin: float, yMin: float, zMin: float, xMax: float, yMax: float, zMax: float)

Bases: _ACBaseType

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.

xMax: float
xMin: float
yMax: float
yMin: float
zMax: float
zMin: float
class BoundingBox3DOrError(boundingBox3D: BoundingBox3D | None = None, error: Error | None = None)

Bases: _ACUnionType

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.

boundingBox3D: BoundingBox3D | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class BoundingBox3DWrapper(boundingBox3D: BoundingBox3D)

Bases: _ACBaseType

Variables:

boundingBox3D (BoundingBox3D) – A 3D bounding box of an element.

boundingBox3D: BoundingBox3D
class BuildingMaterialAttribute(attributeId: AttributeId, name: str, id: str, connectionPriority: int, cutFillId: AttributeIdOrError, cutFillPenIndex: int, cutSurfaceId: AttributeIdOrError)

Bases: _ACBaseType

A building material attribute

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • id (str) – The id of the building material.

  • connectionPriority (int) – The connection priority of the building material.

  • cutFillId (AttributeIdOrError) – The attribute’s identifier or an error.

  • cutFillPenIndex (int) – The index number of a pen.

  • cutSurfaceId (AttributeIdOrError) – The attribute’s identifier or an error.

attributeId: AttributeId
connectionPriority: int
cutFillId: AttributeIdOrError
cutFillPenIndex: int
cutSurfaceId: AttributeIdOrError
id: str
name: str
class BuildingMaterialAttributeOrError(buildingMaterialAttribute: BuildingMaterialAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A building material attribute or an error.

Variables:

  • buildingMaterialAttribute (BuildingMaterialAttribute, optional) – A building material attribute

  • error (Error, optional) – The details of an error.

buildingMaterialAttribute: BuildingMaterialAttribute | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class BuildingMaterialAttributeWrapper(buildingMaterialAttribute: BuildingMaterialAttribute)

Bases: _ACBaseType

Variables:

buildingMaterialAttribute (BuildingMaterialAttribute) – A building material attribute

buildingMaterialAttribute: BuildingMaterialAttribute
class BuiltInContainerNavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str, contentIds: List[NavigatorItemIdWrapper])

Bases: _ACBaseType

The details of a built-in container 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.

  • contentIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.

contentIds: List[NavigatorItemIdWrapper]
name: str
navigatorItemId: NavigatorItemId
prefix: str
class BuiltInContainerNavigatorItemOrError(builtInContainerNavigatorItem: BuiltInContainerNavigatorItem | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains a built-in container navigator item or an error.

Variables:

  • builtInContainerNavigatorItem (BuiltInContainerNavigatorItem, optional) – The details of a built-in container navigator item.

  • error (Error, optional) – The details of an error.

builtInContainerNavigatorItem: BuiltInContainerNavigatorItem | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class BuiltInContainerNavigatorItemWrapper(builtInContainerNavigatorItem: BuiltInContainerNavigatorItem)

Bases: _ACBaseType

Variables:

builtInContainerNavigatorItem (BuiltInContainerNavigatorItem) – The details of a built-in container navigator item.

builtInContainerNavigatorItem: BuiltInContainerNavigatorItem
class BuiltInPropertyUserId(nonLocalizedName: str, type: str = 'BuiltIn')

Bases: _ACBaseType

The unique identifier of a Built-In Property, identified by its name.

Variables:

  • nonLocalizedName (str) – The non-localized name of the Built-In Property.

  • type (str) – EMPTY STRING

nonLocalizedName: str
type: str
class ClassificationId(classificationSystemId: ClassificationSystemId, classificationItemId: ClassificationItemId | None = None)

Bases: _ACBaseType

The element classification identifier.

Variables:

  • classificationSystemId (ClassificationSystemId) – The identifier of a classification system.

  • classificationItemId (ClassificationItemId, optional) – The identifier of a classification item.

classificationItemId: ClassificationItemId | None
classificationSystemId: ClassificationSystemId
class ClassificationIdOrError(classificationId: ClassificationId | None = None, error: Error | None = None)

Bases: _ACUnionType

A classification identifier or an error.

Variables:

  • classificationId (ClassificationId, optional) – The element classification identifier.

  • error (Error, optional) – The details of an error.

classificationId: ClassificationId | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class ClassificationIdWrapper(classificationId: ClassificationId)

Bases: _ACBaseType

Variables:

classificationId (ClassificationId) – The element classification identifier.

classificationId: ClassificationId
class ClassificationIdsOrErrorsWrapper(classificationIds: List[ClassificationIdOrError])

Bases: _ACBaseType

Variables:

classificationIds (list of ClassificationIdOrError) – A list of element classification identifiers or errors.

classificationIds: List[ClassificationIdOrError]
class ClassificationItemArrayItem(classificationItem: ClassificationItemInTree_)

Bases: _ACBaseType

EMPTY STRING

Variables:

classificationItem (ClassificationItemInTree_) – The details of a classification item.

classificationItem: ClassificationItemInTree_
class ClassificationItemAvailability(classificationItemId: ClassificationItemId, availableProperties: List[PropertyIdArrayItem])

Bases: _ACBaseType

Contains the ids of property definitions available for the given classification item.

Variables:

  • classificationItemId (ClassificationItemId) – The identifier of a classification item.

  • availableProperties (list of PropertyIdArrayItem) – A list of property identifiers.

availableProperties: List[PropertyIdArrayItem]
classificationItemId: ClassificationItemId
class ClassificationItemAvailabilityOrError(classificationItemAvailability: ClassificationItemAvailability | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains the ids of property definitions available for the given classification item or error.

Variables:

  • classificationItemAvailability (ClassificationItemAvailability, optional) – Contains the ids of property definitions available for the given classification item.

  • error (Error, optional) – The details of an error.

classificationItemAvailability: ClassificationItemAvailability | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class ClassificationItemAvailabilityWrapper(classificationItemAvailability: ClassificationItemAvailability)

Bases: _ACBaseType

Variables:

classificationItemAvailability (ClassificationItemAvailability) – Contains the ids of property definitions available for the given classification item.

classificationItemAvailability: ClassificationItemAvailability
class ClassificationItemDetails(classificationItemId: ClassificationItemId, id: str, name: str, description: str)

Bases: _ACBaseType

The details of a classification item.

Variables:

  • classificationItemId (ClassificationItemId) – The identifier of a classification item.

  • id (str) – The unique identifier of the classification item as specified by the user.

  • name (str) – The display name of the classification item.

  • description (str) – The description of the classification item.

classificationItemId: ClassificationItemId
description: str
id: str
name: str
class ClassificationItemDetailsWrapper(classificationItem: ClassificationItemDetails)

Bases: _ACBaseType

Variables:

classificationItem (ClassificationItemDetails) – The details of a classification item.

classificationItem: ClassificationItemDetails
class ClassificationItemId(guid: UUID)

Bases: _ACBaseType

The identifier of a classification item.

Variables:

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

guid: UUID
class ClassificationItemIdArrayItem(classificationItemId: ClassificationItemId)

Bases: _ACBaseType

EMPTY STRING

Variables:

classificationItemId (ClassificationItemId) – The identifier of a classification item.

classificationItemId: ClassificationItemId
class ClassificationItemInTree(classificationItemId: ClassificationItemId, id: str, name: str, description: str, children: List[ClassificationItemArrayItem] | None = None)

Bases: _ACBaseType

The details of a classification item.

Variables:

  • classificationItemId (ClassificationItemId) – The identifier of a classification item.

  • id (str) – The unique identifier of the classification item as specified by the user.

  • name (str) – The display name of the classification item.

  • description (str) – The description of the classification item.

  • children (list of ClassificationItemArrayItem, optional) – A list of classification items.

children: List[ClassificationItemArrayItem] | None
classificationItemId: ClassificationItemId
description: str
id: str
name: str
class ClassificationItemOrError(classificationItem: ClassificationItemDetails | None = None, error: Error | None = None)

Bases: _ACUnionType

A classification item or an error.

Variables:

  • classificationItem (ClassificationItemDetails, optional) – The details of a classification item.

  • error (Error, optional) – The details of an error.

classificationItem: ClassificationItemDetails | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class ClassificationSystem(classificationSystemId: ClassificationSystemId, name: str, description: str, source: str, version: str, date: str)

Bases: _ACBaseType

The details of a classification system.

Variables:

  • classificationSystemId (ClassificationSystemId) – The identifier of a classification system.

  • name (str) – The display name of the classification system.

  • description (str) – The description of the classification system.

  • source (str) – The source of the classification system (e.g. URL to a classification system standard).

  • version (str) – The version of the classification system.

  • date (str) – A date in its string representation as defined in ISO 8601: YYYY-MM-DD.

classificationSystemId: ClassificationSystemId
date: str
description: str
name: str
source: str
version: str
class ClassificationSystemId(guid: UUID)

Bases: _ACBaseType

The identifier of a classification system.

Variables:

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

guid: UUID
class ClassificationSystemIdArrayItem(classificationSystemId: ClassificationSystemId)

Bases: _ACBaseType

EMPTY STRING

Variables:

classificationSystemId (ClassificationSystemId) – The identifier of a classification system.

classificationSystemId: ClassificationSystemId
class ClassificationSystemOrError(classificationSystem: ClassificationSystem | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains a classification system or error.

Variables:

  • classificationSystem (ClassificationSystem, optional) – The details of a classification system.

  • error (Error, optional) – The details of an error.

classificationSystem: ClassificationSystem | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class ClassificationSystemWrapper(classificationSystem: ClassificationSystem)

Bases: _ACBaseType

Variables:

classificationSystem (ClassificationSystem) – The details of a classification system.

classificationSystem: ClassificationSystem
class ComponentId(guid: UUID)

Bases: _ACBaseType

The identifier of a component.

Variables:

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

guid: UUID
class CompositeAttribute(attributeId: AttributeId, name: str, totalThickness: float, compositeSkins: List[CompositeSkinListItem], compositeLines: List[CompositeLineListItem], useWith: List[str])

Bases: _ACBaseType

A composite attribute.

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • totalThickness (float) – The total thickness of the composite.

  • compositeSkins (list of CompositeSkinListItem) – A list of composite skins.

  • compositeLines (list of CompositeLineListItem) – A list of contour/separator lines for the composite.

  • useWith (list of str) – A list of element types.

attributeId: AttributeId
compositeLines: List[CompositeLineListItem]
compositeSkins: List[CompositeSkinListItem]
name: str
totalThickness: float
useWith: List[str]
class CompositeAttributeOrError(compositeAttribute: CompositeAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A composite attribute or an error.

Variables:

  • compositeAttribute (CompositeAttribute, optional) – A composite attribute.

  • error (Error, optional) – The details of an error.

compositeAttribute: CompositeAttribute | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class CompositeAttributeWrapper(compositeAttribute: CompositeAttribute)

Bases: _ACBaseType

Variables:

compositeAttribute (CompositeAttribute) – A composite attribute.

compositeAttribute: CompositeAttribute
class CompositeLine(lineId: AttributeIdOrError, linePenIndex: int | None = None)

Bases: _ACBaseType

A contour or separator line component for a composite attribute.

Variables:

  • lineId (AttributeIdOrError) – The attribute’s identifier or an error.

  • linePenIndex (int, optional) – The index number of a pen.

lineId: AttributeIdOrError
linePenIndex: int | None
class CompositeLineListItem(compositeLine: CompositeLine)

Bases: _ACBaseType

EMPTY STRING

Variables:

compositeLine (CompositeLine) – A contour or separator line component for a composite attribute.

compositeLine: CompositeLine
class CompositeSkin(buildingMaterialId: AttributeIdOrError, thickness: float, isCore: bool, isFinish: bool, framePenIndex: int | None = None)

Bases: _ACBaseType

A skin component for a composite attribute.

Variables:

  • buildingMaterialId (AttributeIdOrError) – The attribute’s identifier or an error.

  • thickness (float) – The thickness of the composite skin.

  • isCore (bool) – Defines whether the composite skin is part of the core or not.

  • isFinish (bool) – Defines whether the composite skin is part of the finish or not.

  • framePenIndex (int, optional) – The index number of a pen.

buildingMaterialId: AttributeIdOrError
framePenIndex: int | None
isCore: bool
isFinish: bool
thickness: float
class CompositeSkinListItem(compositeSkin: CompositeSkin)

Bases: _ACBaseType

EMPTY STRING

Variables:

compositeSkin (CompositeSkin) – A skin component for a composite attribute.

compositeSkin: CompositeSkin
class DashItem(dash: float, gap: float)

Bases: _ACBaseType

A dash item.

Variables:

  • dash (float) – The length of the dash.

  • gap (float) – The length of the gap.

dash: float
gap: float
class DashItemWrapper(dashItem: DashItem)

Bases: _ACBaseType

Variables:

dashItem (DashItem) – A dash item.

dashItem: DashItem
class DashOrLineItem(dashItem: DashItem | None = None, lineItem: LineItem | None = None)

Bases: _ACUnionType

A dash or line item.

Variables:

  • dashItem (DashItem, optional) – A dash item.

  • lineItem (LineItem, optional) – A line item.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
dashItem: DashItem | None
lineItem: LineItem | None
class DetailNavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str)

Bases: _ACBaseType

The details of a detail 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.

name: str
navigatorItemId: NavigatorItemId
prefix: str
class DetailNavigatorItemOrError(detailNavigatorItem: DetailNavigatorItem | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains a detail navigator item or an error.

Variables:

  • detailNavigatorItem (DetailNavigatorItem, optional) – The details of a detail navigator item.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
detailNavigatorItem: DetailNavigatorItem | None
error: Error | None
class DetailNavigatorItemWrapper(detailNavigatorItem: DetailNavigatorItem)

Bases: _ACBaseType

Variables:

detailNavigatorItem (DetailNavigatorItem) – The details of a detail navigator item.

detailNavigatorItem: DetailNavigatorItem
class DisplayValueEnumId(displayValue: str, type: str = 'displayValue')

Bases: _ACBaseType

An enumeration value identifier using the displayed value.

Variables:

  • displayValue (str) – EMPTY STRING

  • type (str) – EMPTY STRING

displayValue: str
type: str
class Document3DNavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str)

Bases: _ACBaseType

The details of a 3D document 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.

name: str
navigatorItemId: NavigatorItemId
prefix: str
class Document3DNavigatorItemOrError(document3DNavigatorItem: Document3DNavigatorItem | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains a 3D document navigator item or an error.

Variables:

  • document3DNavigatorItem (Document3DNavigatorItem, optional) – The details of a 3D document navigator item.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
document3DNavigatorItem: Document3DNavigatorItem | None
error: Error | None
class Document3DNavigatorItemWrapper(document3DNavigatorItem: Document3DNavigatorItem)

Bases: _ACBaseType

Variables:

document3DNavigatorItem (Document3DNavigatorItem) – The details of a 3D document navigator item.

document3DNavigatorItem: Document3DNavigatorItem
class ElementClassification(elementId: ElementId, classificationId: ClassificationId)

Bases: _ACBaseType

The classification of an element.

Variables:

  • elementId (ElementId) – The identifier of an element.

  • classificationId (ClassificationId) – The element classification identifier.

classificationId: ClassificationId
elementId: ElementId
class ElementClassificationOrError(classificationIds: List[ClassificationIdOrError] | None = None, error: Error | None = None)

Bases: _ACUnionType

Element classification identifiers or errors.

Variables:

  • classificationIds (list of ClassificationIdOrError, optional) – A list of element classification identifiers or errors.

  • error (Error, optional) – The details of an error.

classificationIds: List[ClassificationIdOrError] | None
constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
class ElementComponentId(elementId: ElementId, componentId: ComponentId)

Bases: _ACBaseType

The identifier of an element’s component.

Variables:

  • elementId (ElementId) – The identifier of an element.

  • componentId (ComponentId) – The identifier of a component.

componentId: ComponentId
elementId: ElementId
class ElementComponentIdArrayItem(elementComponentId: ElementComponentId)

Bases: _ACBaseType

An item of a component array.

Variables:

elementComponentId (ElementComponentId) – The identifier of an element’s component.

elementComponentId: ElementComponentId
class ElementComponentsOrError(elementComponents: List[ElementComponentIdArrayItem] | None = None, error: Error | None = None)

Bases: _ACUnionType

List of components or error.

Variables:

  • elementComponents (list of ElementComponentIdArrayItem, optional) – List of components of elements.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
elementComponents: List[ElementComponentIdArrayItem] | None
error: Error | None
class ElementComponentsWrapper(elementComponents: List[ElementComponentIdArrayItem])

Bases: _ACBaseType

List of components.

Variables:

elementComponents (list of ElementComponentIdArrayItem) – List of components of elements.

elementComponents: List[ElementComponentIdArrayItem]
class ElementId(guid: UUID)

Bases: _ACBaseType

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.

guid: UUID
class ElementIdArrayItem(elementId: ElementId)

Bases: _ACBaseType

EMPTY STRING

Variables:

elementId (ElementId) – The identifier of an element.

elementId: ElementId
class ElementPropertyValue(elementId: ElementId, propertyId: PropertyId, propertyValue: NormalOrUserUndefinedPropertyValue)

Bases: _ACBaseType

A property value with the identifiers of the property and its owner element.

Variables:

  • elementId (ElementId) – The identifier of an element.

  • propertyId (PropertyId) – The identifier of a property.

  • propertyValue (NormalOrUserUndefinedPropertyValue) – A normal or a userUndefined property value.

elementId: ElementId
propertyId: PropertyId
propertyValue: NormalOrUserUndefinedPropertyValue
class ElementsOrError(elements: List[ElementIdArrayItem] | None = None, error: Error | None = None)

Bases: _ACUnionType

A list of elements or an error.

Variables:

  • elements (list of ElementIdArrayItem, optional) – A list of elements.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
elements: List[ElementIdArrayItem] | None
error: Error | None
class ElementsWrapper(elements: List[ElementIdArrayItem])

Bases: _ACBaseType

A wrapper for a list of elements.

Variables:

elements (list of ElementIdArrayItem) – A list of elements.

elements: List[ElementIdArrayItem]
class ElevationNavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str)

Bases: _ACBaseType

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.

name: str
navigatorItemId: NavigatorItemId
prefix: str
class ElevationNavigatorItemOrError(elevationNavigatorItem: ElevationNavigatorItem | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains an elevation navigator item or an error.

Variables:

  • elevationNavigatorItem (ElevationNavigatorItem, optional) – The details of an elevation navigator item.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
elevationNavigatorItem: ElevationNavigatorItem | None
error: Error | None
class ElevationNavigatorItemWrapper(elevationNavigatorItem: ElevationNavigatorItem)

Bases: _ACBaseType

Variables:

elevationNavigatorItem (ElevationNavigatorItem) – The details of an elevation navigator item.

elevationNavigatorItem: ElevationNavigatorItem
class EnumValueId(type: str, displayValue: str | None = None, nonLocalizedValue: str | None = None)

Bases: _ACUnionType

The identifier of a property enumeration value.

Variables:

  • type (str) – None

  • displayValue (str, optional) – EMPTY STRING

  • nonLocalizedValue (str, optional) – EMPTY STRING

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
displayValue: str | None
nonLocalizedValue: str | None
type: str
class EnumValueIdWrapper(enumValueId: EnumValueId)

Bases: _ACBaseType

Variables:

enumValueId (EnumValueId) – The identifier of a property enumeration value.

enumValueId: EnumValueId
class Error(code: int, message: str)

Bases: _ACBaseType

The details of an error.

Variables:

  • code (int) – The code of the error.

  • message (str) – The error message.

code: int
message: str
class ErrorItem(error: Error)

Bases: _ACBaseType

EMPTY STRING

Variables:

error (Error) – The details of an error.

error: Error
class ExecutionResult(success: bool, error: Error | None = None)

Bases: _ACUnionType

The result of the execution.

Variables:

  • success (bool) – None

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
success: bool
class FailedExecutionResult(success: bool, error: Error)

Bases: _ACBaseType

The result of a failed execution.

Variables:

  • success (bool) – EMPTY STRING

  • error (Error) – The details of an error.

error: Error
success: bool
class FillAttribute(attributeId: AttributeId, name: str, subType: str, pattern: int, appearanceType: str)

Bases: _ACBaseType

A fill attribute.

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • subType (str) – The filling type of a fill attribute.

  • pattern (int) – The pattern of the fill attribute, stored in a 64 bit unsigned integer, and represented as an 8x8 matrix. Each byte in the value is a row, and the bits are the columns of the matrix.

  • appearanceType (str) – The appearance type of a line or fill attribute.

appearanceType: str
attributeId: AttributeId
name: str
pattern: int
subType: str
class FillAttributeOrError(fillAttribute: FillAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A fill attribute or an error.

Variables:

  • fillAttribute (FillAttribute, optional) – A fill attribute.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
fillAttribute: FillAttribute | None
class FillAttributeWrapper(fillAttribute: FillAttribute)

Bases: _ACBaseType

Variables:

fillAttribute (FillAttribute) – A fill attribute.

fillAttribute: FillAttribute
class FolderParameters(name: str)

Bases: _ACBaseType

The parameters of a folder.

Variables:

name (str) – The name of the folder.

name: str
class GeneralNavigatorItemData(navigatorItemId: NavigatorItemId, prefix: str, name: str)

Bases: _ACBaseType

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.

name: str
navigatorItemId: NavigatorItemId
prefix: str
class Image(content: str)

Bases: _ACBaseType

An image encoded as a Base64 string.

Variables:

content (str) – The image content as a string .

content: str
class ImageOrError(image: Image | None = None, error: Error | None = None)

Bases: _ACUnionType

An image or an error.

Variables:

  • image (Image, optional) – An image encoded as a Base64 string.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
image: Image | None
class ImageWrapper(image: Image)

Bases: _ACBaseType

Variables:

image (Image) – An image encoded as a Base64 string.

image: Image
class InteriorElevationNavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str)

Bases: _ACBaseType

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.

name: str
navigatorItemId: NavigatorItemId
prefix: str
class InteriorElevationNavigatorItemOrError(interiorElevationNavigatorItem: InteriorElevationNavigatorItem | None = None, error: Error | None = None)

Bases: _ACUnionType

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.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
interiorElevationNavigatorItem: InteriorElevationNavigatorItem | None
class InteriorElevationNavigatorItemWrapper(interiorElevationNavigatorItem: InteriorElevationNavigatorItem)

Bases: _ACBaseType

Variables:

interiorElevationNavigatorItem (InteriorElevationNavigatorItem) – The details of an interior elevation navigator item.

interiorElevationNavigatorItem: InteriorElevationNavigatorItem
class LayerAttribute(attributeId: AttributeId, name: str, intersectionGroupNr: int, isLocked: bool, isHidden: bool, isWireframe: bool)

Bases: _ACBaseType

A layer attribute

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • intersectionGroupNr (int) – The intersection group number

  • isLocked (bool) – Defines whether the layer is locked or not.

  • isHidden (bool) – Defines whether the layer is hidden or not.

  • isWireframe (bool) – Defines whether the elements placed on this layer are visible as wireframes or a solid model.

attributeId: AttributeId
intersectionGroupNr: int
isHidden: bool
isLocked: bool
isWireframe: bool
name: str
class LayerAttributeOrError(layerAttribute: LayerAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A layer attribute or an error.

Variables:

  • layerAttribute (LayerAttribute, optional) – A layer attribute

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
layerAttribute: LayerAttribute | None
class LayerAttributeWrapper(layerAttribute: LayerAttribute)

Bases: _ACBaseType

Variables:

layerAttribute (LayerAttribute) – A layer attribute

layerAttribute: LayerAttribute
class LayerCombinationAttribute(attributeId: AttributeId, name: str, layerAttributeIds: List[AttributeIdWrapperItem])

Bases: _ACBaseType

A layer combination attribute

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • layerAttributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

attributeId: AttributeId
layerAttributeIds: List[AttributeIdWrapperItem]
name: str
class LayerCombinationAttributeOrError(layerCombinationAttribute: LayerCombinationAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A layer combination attribute or an error.

Variables:

  • layerCombinationAttribute (LayerCombinationAttribute, optional) – A layer combination attribute

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
layerCombinationAttribute: LayerCombinationAttribute | None
class LayerCombinationAttributeWrapper(layerCombinationAttribute: LayerCombinationAttribute)

Bases: _ACBaseType

Variables:

layerCombinationAttribute (LayerCombinationAttribute) – A layer combination attribute

layerCombinationAttribute: LayerCombinationAttribute
class LayoutParameters(horizontalSize: float, verticalSize: float, leftMargin: float, topMargin: float, rightMargin: float, bottomMargin: float, customLayoutNumber: str, customLayoutNumbering: bool, doNotIncludeInNumbering: bool, displayMasterLayoutBelow: bool, layoutPageNumber: int, actPageIndex: int, currentRevisionId: str, currentFinalRevisionId: str, hasIssuedRevision: bool, hasActualRevision: bool)

Bases: _ACBaseType

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.

actPageIndex: int
bottomMargin: float
currentFinalRevisionId: str
currentRevisionId: str
customLayoutNumber: str
customLayoutNumbering: bool
displayMasterLayoutBelow: bool
doNotIncludeInNumbering: bool
hasActualRevision: bool
hasIssuedRevision: bool
horizontalSize: float
layoutPageNumber: int
leftMargin: float
rightMargin: float
topMargin: float
verticalSize: float
class LineAttribute(attributeId: AttributeId, name: str, appearanceType: str, displayScale: float, period: float, height: float, lineType: str, lineItems: List[DashOrLineItem] | None = None)

Bases: _ACBaseType

A line attribute

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • appearanceType (str) – The appearance type of a line or fill attribute.

  • displayScale (float) – The original scale of the line.

  • period (float) – The length of the dashed or symbol line’s period.

  • height (float) – The height of the symbol line.

  • lineType (str) – The type of a line attribute.

  • lineItems (list of DashOrLineItem, optional) – A list of dash or line items.

appearanceType: str
attributeId: AttributeId
displayScale: float
height: float
lineItems: List[DashOrLineItem] | None
lineType: str
name: str
period: float
class LineAttributeOrError(lineAttribute: LineAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A line attribute or an error.

Variables:

  • lineAttribute (LineAttribute, optional) – A line attribute

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
lineAttribute: LineAttribute | None
class LineAttributeWrapper(lineAttribute: LineAttribute)

Bases: _ACBaseType

Variables:

lineAttribute (LineAttribute) – A line attribute

lineAttribute: LineAttribute
class LineItem(lineItemType: str, centerOffset: float, length: float, begPosition: Point2D, endPosition: Point2D, radius: float, begAngle: float, endAngle: float)

Bases: _ACBaseType

A line item.

Variables:

  • lineItemType (str) – The type of a line item.

  • centerOffset (float) – The vertical distance from the origin of the symbol line. Used in separator, center dot, and centerline item types.

  • length (float) – The length of the item. Used in centerline, right angle, and parallel item types.

  • begPosition (Point2D) – Coordinates of a 2D point

  • endPosition (Point2D) – Coordinates of a 2D point

  • radius (float) – The radius of the item. Used in circle and arc item types.

  • begAngle (float) – The beginning angle of the item, measured from the vertical axis. Used in the arc item type.

  • endAngle (float) – The ending angle of the item, measured from the vertical axis. Used in the arc item type.

begAngle: float
begPosition: Point2D
centerOffset: float
endAngle: float
endPosition: Point2D
length: float
lineItemType: str
radius: float
class LineItemWrapper(lineItem: LineItem)

Bases: _ACBaseType

Variables:

lineItem (LineItem) – A line item.

lineItem: LineItem
class NavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str, type: str, sourceNavigatorItemId: NavigatorItemId | None = None, children: List[NavigatorItemArrayItem] | None = None)

Bases: _ACBaseType

The details 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.

  • type (str) – The type of a navigator item. The ‘UndefinedItem’ type is used when the actual type of the navigator item cannot be retrieved from Archicad.

  • sourceNavigatorItemId (NavigatorItemId, optional) – The identifier of a navigator item.

  • children (list of NavigatorItemArrayItem, optional) – A list of navigator items.

children: List[NavigatorItemArrayItem] | None
name: str
navigatorItemId: NavigatorItemId
prefix: str
sourceNavigatorItemId: NavigatorItemId | None
type: str
class NavigatorItemArrayItem(navigatorItem: NavigatorItem_)

Bases: _ACBaseType

EMPTY STRING

Variables:

navigatorItem (NavigatorItem_) – The details of a navigator item.

navigatorItem: NavigatorItem_
class NavigatorItemId(guid: UUID)

Bases: _ACBaseType

The identifier of a navigator item.

Variables:

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

guid: UUID
class NavigatorItemIdAndType(navigatorItemType: str, navigatorItemId: NavigatorItemId)

Bases: _ACBaseType

Consists of a navigator item type and an identifier.

Variables:

  • navigatorItemType (str) – The type of a navigator item. The ‘UndefinedItem’ type is used when the actual type of the navigator item cannot be retrieved from Archicad.

  • navigatorItemId (NavigatorItemId) – The identifier of a navigator item.

navigatorItemId: NavigatorItemId
navigatorItemType: str
class NavigatorItemIdAndTypeOrError(navigatorItemIdAndType: NavigatorItemIdAndType | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains a pair of navigator item type and identifier or an error.

Variables:

  • navigatorItemIdAndType (NavigatorItemIdAndType, optional) – Consists of a navigator item type and an identifier.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
navigatorItemIdAndType: NavigatorItemIdAndType | None
class NavigatorItemIdAndTypeWrapper(navigatorItemIdAndType: NavigatorItemIdAndType)

Bases: _ACBaseType

Variables:

navigatorItemIdAndType (NavigatorItemIdAndType) – Consists of a navigator item type and an identifier.

navigatorItemIdAndType: NavigatorItemIdAndType
class NavigatorItemIdWrapper(navigatorItemId: NavigatorItemId)

Bases: _ACBaseType

Variables:

navigatorItemId (NavigatorItemId) – The identifier of a navigator item.

navigatorItemId: NavigatorItemId
class NavigatorTree(rootItem: NavigatorItem)

Bases: _ACBaseType

A tree of navigator items.

Variables:

rootItem (NavigatorItem) – The details of a navigator item.

rootItem: NavigatorItem
class NavigatorTreeId(type: str, name: str | None = None)

Bases: _ACUnionType

The identifier of a navigator item tree.

Variables:

  • type (str) – The type of the navigator item tree.

  • name (str, optional) – The name of the publisher set.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
name: str | None
type: str
class NonLocalizedValueEnumId(nonLocalizedValue: str, type: str = 'nonLocalizedValue')

Bases: _ACBaseType

An enumeration value identifier using the nonlocalized value.

Variables:

  • nonLocalizedValue (str) – EMPTY STRING

  • type (str) – EMPTY STRING

nonLocalizedValue: str
type: str
class NormalAngleListPropertyValue(value: List[float], type: str = 'angleList', status: str = 'normal')

Bases: _ACBaseType

An angle list property value containing angles in an array. The values are measured in SI (radians).

Variables:

  • value (list of float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: List[float]
class NormalAnglePropertyValue(value: float, type: str = 'angle', status: str = 'normal')

Bases: _ACBaseType

An angle property value containing a real angle. The value is measured in SI (radians).

Variables:

  • value (float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: float
class NormalAreaListPropertyValue(value: List[float], type: str = 'areaList', status: str = 'normal')

Bases: _ACBaseType

An area list property value containing areas in an array. The values are measured in SI (square meters).

Variables:

  • value (list of float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: List[float]
class NormalAreaPropertyValue(value: float, type: str = 'area', status: str = 'normal')

Bases: _ACBaseType

An area property value containing a real area. The value is measured in SI (square meters).

Variables:

  • value (float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: float
class NormalBooleanListPropertyValue(value: List[bool], type: str = 'booleanList', status: str = 'normal')

Bases: _ACBaseType

A boolean list property value containing boolean values in an array.

Variables:

  • value (list of bool) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: List[bool]
class NormalBooleanPropertyValue(value: bool, type: str = 'boolean', status: str = 'normal')

Bases: _ACBaseType

A boolean property value containing a valid boolean value.

Variables:

  • value (bool) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: bool
class NormalIntegerListPropertyValue(value: List[int], type: str = 'integerList', status: str = 'normal')

Bases: _ACBaseType

An integer list property value containing integers in an array.

Variables:

  • value (list of int) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: List[int]
class NormalIntegerPropertyValue(value: int, type: str = 'integer', status: str = 'normal')

Bases: _ACBaseType

An integer property value containing a valid integer number.

Variables:

  • value (int) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: int
class NormalLengthListPropertyValue(value: List[float], type: str = 'lengthList', status: str = 'normal')

Bases: _ACBaseType

A length list property value containing length values in an array. The values are measured in SI (meters).

Variables:

  • value (list of float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: List[float]
class NormalLengthPropertyValue(value: float, type: str = 'length', status: str = 'normal')

Bases: _ACBaseType

A length property value containing a real length value. The value is measured in SI (meters).

Variables:

  • value (float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: float
class NormalMultiEnumPropertyValue(value: List[EnumValueIdWrapper], type: str = 'multiEnum', status: str = 'normal')

Bases: _ACBaseType

A multiple choice enumeration property value containing the IDs of the selected enum values in an array.

Variables:

  • value (list of EnumValueIdWrapper) – A list of enumeration identifiers.

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: List[EnumValueIdWrapper]
class NormalNumberListPropertyValue(value: List[float], type: str = 'numberList', status: str = 'normal')

Bases: _ACBaseType

A number list property value containing numbers in an array.

Variables:

  • value (list of float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: List[float]
class NormalNumberPropertyValue(value: float, type: str = 'number', status: str = 'normal')

Bases: _ACBaseType

A number property value containing a valid numeric value.

Variables:

  • value (float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: float
class NormalOrUserUndefinedPropertyValue(type: str, status: str, value: float | int | str | bool | List[float] | List[int] | List[str] | List[bool] | EnumValueId | List[EnumValueIdWrapper] | None = None)

Bases: _ACUnionType

A normal or a userUndefined property value.

Variables:

  • type (str) – None

  • status (str) – None

  • value (float, int, str, bool, list of float, list of int, list of str, list of bool, EnumValueId, list of EnumValueIdWrapper) – None; The identifier of a property enumeration value.; A list of enumeration identifiers.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
status: str
type: str
value: float | int | str | bool | List[float] | List[int] | List[str] | List[bool] | EnumValueId | List[EnumValueIdWrapper] | None
class NormalSingleEnumPropertyValue(value: EnumValueId, type: str = 'singleEnum', status: str = 'normal')

Bases: _ACBaseType

A single enumeration property value containing the ID of the selected enum value.

Variables:

  • value (EnumValueId) – The identifier of a property enumeration value.

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: EnumValueId
class NormalStringListPropertyValue(value: List[str], type: str = 'stringList', status: str = 'normal')

Bases: _ACBaseType

A string list property value containing strings in an array.

Variables:

  • value (list of str) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: List[str]
class NormalStringPropertyValue(value: str, type: str = 'string', status: str = 'normal')

Bases: _ACBaseType

A string property value containing a valid string.

Variables:

  • value (str) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: str
class NormalVolumeListPropertyValue(value: List[float], type: str = 'volumeList', status: str = 'normal')

Bases: _ACBaseType

A volume list property value containing volumes in an array. The values are measured in SI (cubic meters).

Variables:

  • value (list of float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: List[float]
class NormalVolumePropertyValue(value: float, type: str = 'volume', status: str = 'normal')

Bases: _ACBaseType

A volume property value containing a real volume. The value is measured in SI (cubic meters).

Variables:

  • value (float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
value: float
class NotAvailablePropertyValue(type: str, status: str = 'notAvailable')

Bases: _ACBaseType

A notAvailable value means that the property is not available for the property owner (and therefore it has no property value for it).

Variables:

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
class NotEvaluatedPropertyValue(type: str, status: str = 'notEvaluated')

Bases: _ACBaseType

A notEvaluated value means that the property could not be evaluated for the property owner for some reason.

Variables:

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
class OtherNavigatorTreeId(type: str)

Bases: _ACBaseType

The identifier of a navigator item tree.

Variables:

type (str) – The type of the navigator item tree.

type: str
class Pen(index: int, color: RGBColor, weight: float, description: str)

Bases: _ACBaseType

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.

color: RGBColor
description: str
index: int
weight: float
class PenArrayItem(pen: Pen)

Bases: _ACBaseType

EMPTY STRING

Variables:

pen (Pen) – A pen attribute.

pen: Pen
class PenTableAttribute(attributeId: AttributeId, name: str, pens: List[PenArrayItem])

Bases: _ACBaseType

A pen table attribute.

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • pens (list of PenArrayItem) – A collection of pens in a pen table.

attributeId: AttributeId
name: str
pens: List[PenArrayItem]
class PenTableAttributeOrError(penTableAttribute: PenTableAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A pen table attribute or an error.

Variables:

  • penTableAttribute (PenTableAttribute, optional) – A pen table attribute.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
penTableAttribute: PenTableAttribute | None
class PenTableAttributeWrapper(penTableAttribute: PenTableAttribute)

Bases: _ACBaseType

Variables:

penTableAttribute (PenTableAttribute) – A pen table attribute.

penTableAttribute: PenTableAttribute
class Point2D(x: float, y: float)

Bases: _ACBaseType

Coordinates of a 2D point

Variables:

  • x (float) – X coordinate of 2D point

  • y (float) – Y coordinate of 2D point

x: float
y: float
class PossibleEnumValue(enumValueId: EnumValueId, displayValue: str, nonLocalizedValue: str | None = None)

Bases: _ACBaseType

The description of an enumeration value.

Variables:

  • enumValueId (EnumValueId) – The identifier of a property enumeration value.

  • displayValue (str) – Displayed value of the enumeration.

  • nonLocalizedValue (str, optional) – Nonlocalized value of the enumeration if there is one.

displayValue: str
enumValueId: EnumValueId
nonLocalizedValue: str | None
class PossibleEnumValuesArrayItem(enumValue: PossibleEnumValue)

Bases: _ACBaseType

EMPTY STRING

Variables:

enumValue (PossibleEnumValue) – The description of an enumeration value.

enumValue: PossibleEnumValue
class ProfileAttribute(attributeId: AttributeId, name: str, useWith: List[str], width: float, height: float, minimumWidth: float, minimumHeight: float, widthStretchable: bool, heightStretchable: bool, hasCoreSkin: bool, profileModifiers: List[ProfileModifierListItem])

Bases: _ACBaseType

A profile attribute.

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • useWith (list of str) – A list of element types.

  • width (float) – The default width (horizontal size) of the profile.

  • height (float) – The default height (vertical size) of the profile.

  • minimumWidth (float) – The minimum width (horizontal size) of the profile.

  • minimumHeight (float) – The minimum height (vertical size) of the profile.

  • widthStretchable (bool) – Defines whether the profile’s width can be increased beyond its default value or not.

  • heightStretchable (bool) – Defines whether the profile’s height can be increased beyond its default value or not.

  • hasCoreSkin (bool) – Defines whether the profile has a core skin or not.

  • profileModifiers (list of ProfileModifierListItem) – A list of profile modifiers.

attributeId: AttributeId
hasCoreSkin: bool
height: float
heightStretchable: bool
minimumHeight: float
minimumWidth: float
name: str
profileModifiers: List[ProfileModifierListItem]
useWith: List[str]
width: float
widthStretchable: bool
class ProfileAttributeOrError(profileAttribute: ProfileAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A profile attribute or an error.

Variables:

  • profileAttribute (ProfileAttribute, optional) – A profile attribute.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
profileAttribute: ProfileAttribute | None
class ProfileAttributeWrapper(profileAttribute: ProfileAttribute)

Bases: _ACBaseType

Variables:

profileAttribute (ProfileAttribute) – A profile attribute.

profileAttribute: ProfileAttribute
class ProfileModifier(name: str, value: float)

Bases: _ACBaseType

A profile modifier parameter.

Variables:

  • name (str) – The name of the modifier.

  • value (float) – The value of the modifier.

name: str
value: float
class ProfileModifierListItem(profileModifier: ProfileModifier)

Bases: _ACBaseType

EMPTY STRING

Variables:

profileModifier (ProfileModifier) – A profile modifier parameter.

profileModifier: ProfileModifier
class PropertyBasicDefaultValue(basicDefaultValue: PropertyValue_)

Bases: _ACBaseType

Default value of the property in case of a basic property value (ie. not an expression).

Variables:

basicDefaultValue (PropertyValue_) – A normal, userUndefined, notAvailable or notEvaluated property value.

basicDefaultValue: PropertyValue_
PropertyDefaultValue

alias of PropertyBasicDefaultValue

class PropertyDefinition(group: PropertyGroup, name: str, description: str, isEditable: bool, type: str, propertyId: PropertyId | None = None, possibleEnumValues: List[PossibleEnumValuesArrayItem] | None = None, defaultValue: PropertyBasicDefaultValue | None = None)

Bases: _ACBaseType

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.)

Variables:

  • group (PropertyGroup) – A property group.

  • name (str) – The localized name of the property.

  • description (str) – The description of the property.

  • isEditable (bool) – Defines whether the property is editable or not.

  • type (str) – Defines the type of the property’s value.

  • propertyId (PropertyId, optional) – The identifier of a property.

  • possibleEnumValues (list of PossibleEnumValuesArrayItem, optional) – A list of enumeration values.

  • defaultValue (PropertyDefaultValue, optional) – Default value of the property.

defaultValue: PropertyDefaultValue | None
description: str
group: PropertyGroup
isEditable: bool
name: str
possibleEnumValues: List[PossibleEnumValuesArrayItem] | None
propertyId: PropertyId | None
type: str
class PropertyDefinitionAvailability(propertyId: PropertyId, availableClassifications: List[ClassificationItemIdArrayItem])

Bases: _ACBaseType

Contains the ids of classification items the given property definiton is available for.

Variables:

  • propertyId (PropertyId) – The identifier of a property.

  • availableClassifications (list of ClassificationItemIdArrayItem) – A list of classification item identifiers.

availableClassifications: List[ClassificationItemIdArrayItem]
propertyId: PropertyId
class PropertyDefinitionAvailabilityOrError(propertyDefinitionAvailability: PropertyDefinitionAvailability | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains the ids of classification items the given property definiton is available for or error.

Variables:

  • propertyDefinitionAvailability (PropertyDefinitionAvailability, optional) – Contains the ids of classification items the given property definiton is available for.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
propertyDefinitionAvailability: PropertyDefinitionAvailability | None
class PropertyDefinitionAvailabilityWrapper(propertyDefinitionAvailability: PropertyDefinitionAvailability)

Bases: _ACBaseType

Variables:

propertyDefinitionAvailability (PropertyDefinitionAvailability) – Contains the ids of classification items the given property definiton is available for.

propertyDefinitionAvailability: PropertyDefinitionAvailability
class PropertyDefinitionOrError(propertyDefinition: PropertyDefinition | None = None, error: Error | None = None)

Bases: _ACUnionType

A property definition or an error.

Variables:

  • propertyDefinition (PropertyDefinition, optional) – 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.)

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
propertyDefinition: PropertyDefinition | None
class PropertyDefinitionWrapper(propertyDefinition: PropertyDefinition)

Bases: _ACBaseType

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.)

propertyDefinition: PropertyDefinition
class PropertyGroup(propertyGroupId: PropertyGroupId, name: str)

Bases: _ACBaseType

A property group.

Variables:

  • propertyGroupId (PropertyGroupId) – The identifier of a property group.

  • name (str) – The property group name.

name: str
propertyGroupId: PropertyGroupId
class PropertyGroupId(guid: UUID)

Bases: _ACBaseType

The identifier of a property group.

Variables:

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

guid: UUID
class PropertyGroupIdArrayItem(propertyGroupId: PropertyGroupId)

Bases: _ACBaseType

EMPTY STRING

Variables:

propertyGroupId (PropertyGroupId) – The identifier of a property group.

propertyGroupId: PropertyGroupId
class PropertyGroupOrError(propertyGroup: PropertyGroup | None = None, error: Error | None = None)

Bases: _ACUnionType

A property group or an error.

Variables:

  • propertyGroup (PropertyGroup, optional) – A property group.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
propertyGroup: PropertyGroup | None
class PropertyGroupWrapper(propertyGroup: PropertyGroup)

Bases: _ACBaseType

Variables:

propertyGroup (PropertyGroup) – A property group.

propertyGroup: PropertyGroup
class PropertyId(guid: UUID)

Bases: _ACBaseType

The identifier of a property.

Variables:

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

guid: UUID
class PropertyIdArrayItem(propertyId: PropertyId)

Bases: _ACBaseType

EMPTY STRING

Variables:

propertyId (PropertyId) – The identifier of a property.

propertyId: PropertyId
class PropertyIdOrError(propertyId: PropertyId | None = None, error: Error | None = None)

Bases: _ACUnionType

A property identifier or an error.

Variables:

  • propertyId (PropertyId, optional) – The identifier of a property.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
propertyId: PropertyId | None
class PropertyIdsOfElement(elementId: ElementId, propertyIds: List[PropertyIdArrayItem])

Bases: _ACBaseType

A list property identifiers of an owner element.

Variables:

  • elementId (ElementId) – The identifier of an element.

  • propertyIds (list of PropertyIdArrayItem) – A list of property identifiers.

elementId: ElementId
propertyIds: List[PropertyIdArrayItem]
class PropertyIdsOfElementOrError(propertyIdsOfElement: PropertyIdsOfElement | None = None, error: Error | None = None)

Bases: _ACUnionType

A list property identifiers of an owner element or an error.

Variables:

  • propertyIdsOfElement (PropertyIdsOfElement, optional) – A list property identifiers of an owner element.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
propertyIdsOfElement: PropertyIdsOfElement | None
class PropertyIdsOfElementWrapper(propertyIdsOfElement: PropertyIdsOfElement)

Bases: _ACBaseType

Variables:

propertyIdsOfElement (PropertyIdsOfElement) – A list property identifiers of an owner element.

propertyIdsOfElement: PropertyIdsOfElement
class PropertyUserId(type: str, localizedName: List[str] | None = None, nonLocalizedName: str | None = None)

Bases: _ACUnionType

The unique identifier of a Property, identified by its name. May represent a User-Defined or a Built-In Property.

Variables:

  • type (str) – None

  • localizedName (list of str, optional) – A two-element list of the localized name parts. The first element is the name of the group the property belongs to, and the second element is the actual name of the property.

  • nonLocalizedName (str, optional) – The non-localized name of the Built-In Property.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
localizedName: List[str] | None
nonLocalizedName: str | None
type: str
class PropertyValue(type: str, status: str, value: float | int | str | bool | List[float] | List[int] | List[str] | List[bool] | EnumValueId | List[EnumValueIdWrapper] | None = None)

Bases: _ACUnionType

A normal, userUndefined, notAvailable or notEvaluated property value.

Variables:

  • type (str) – None

  • status (str) – None

  • value (float, int, str, bool, list of float, list of int, list of str, list of bool, EnumValueId, list of EnumValueIdWrapper) – None; The identifier of a property enumeration value.; A list of enumeration identifiers.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
status: str
type: str
value: float | int | str | bool | List[float] | List[int] | List[str] | List[bool] | EnumValueId | List[EnumValueIdWrapper] | None
class PropertyValueOrErrorItem(propertyValue: PropertyValue | None = None, error: Error | None = None)

Bases: _ACUnionType

A property value or an error

Variables:

  • propertyValue (PropertyValue, optional) – A normal, userUndefined, notAvailable or notEvaluated property value.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
propertyValue: PropertyValue | None
class PropertyValueWrapper(propertyValue: PropertyValue)

Bases: _ACBaseType

Variables:

propertyValue (PropertyValue) – A normal, userUndefined, notAvailable or notEvaluated property value.

propertyValue: PropertyValue
class PropertyValuesOrError(propertyValues: List[PropertyValueOrErrorItem] | None = None, error: Error | None = None)

Bases: _ACUnionType

A list of property values or an error.

Variables:

  • propertyValues (list of PropertyValueOrErrorItem, optional) – A list of property values.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
propertyValues: List[PropertyValueOrErrorItem] | None
class PropertyValuesWrapper(propertyValues: List[PropertyValueOrErrorItem])

Bases: _ACBaseType

Variables:

propertyValues (list of PropertyValueOrErrorItem) – A list of property values.

propertyValues: List[PropertyValueOrErrorItem]
class PublisherSetId(name: str, type: str = 'PublisherSets')

Bases: _ACBaseType

The identifier of a publisher set.

Variables:

  • name (str) – The name of the publisher set.

  • type (str) – The type of the navigator item tree.

name: str
type: str
class RGBColor(red: float, green: float, blue: float)

Bases: _ACBaseType

A color model represented via its red, green and blue components.

Variables:

  • red (float) – The red component of the color model.

  • green (float) – The green component of the color model.

  • blue (float) – The blue component of the color model.

blue: float
green: float
red: float
class SectionNavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str)

Bases: _ACBaseType

The details of a section 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.

name: str
navigatorItemId: NavigatorItemId
prefix: str
class SectionNavigatorItemOrError(sectionNavigatorItem: SectionNavigatorItem | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains a section navigator item or an error.

Variables:

  • sectionNavigatorItem (SectionNavigatorItem, optional) – The details of a section navigator item.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
sectionNavigatorItem: SectionNavigatorItem | None
class SectionNavigatorItemWrapper(sectionNavigatorItem: SectionNavigatorItem)

Bases: _ACBaseType

Variables:

sectionNavigatorItem (SectionNavigatorItem) – The details of a section navigator item.

sectionNavigatorItem: SectionNavigatorItem
class StoryNavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str, floorLevel: float, floorNumber: float)

Bases: _ACBaseType

The details of a story 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.

  • floorLevel (float) – The floor level of the story navigator item.

  • floorNumber (float) – The floor number of the story navigator item.

floorLevel: float
floorNumber: float
name: str
navigatorItemId: NavigatorItemId
prefix: str
class StoryNavigatorItemOrError(storyNavigatorItem: StoryNavigatorItem | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains a story navigator item or an error.

Variables:

  • storyNavigatorItem (StoryNavigatorItem, optional) – The details of a story navigator item.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
storyNavigatorItem: StoryNavigatorItem | None
class StoryNavigatorItemWrapper(storyNavigatorItem: StoryNavigatorItem)

Bases: _ACBaseType

Variables:

storyNavigatorItem (StoryNavigatorItem) – The details of a story navigator item.

storyNavigatorItem: StoryNavigatorItem
class Subset(name: str, includeToIDSequence: bool, customNumbering: bool, continueNumbering: bool, useUpperPrefix: bool, addOwnPrefix: bool, customNumber: str, autoNumber: str, numberingStyle: str, startAt: int, ownPrefix: str)

Bases: _ACBaseType

A set of options used to assign IDs to the layouts contained in the subset.

Variables:

  • name (str) – The name for the layout subset.

  • includeToIDSequence (bool) – Defines whether this subset is included in automatic ID assignment or not.

  • customNumbering (bool) – Defines whether the IDs are generated automatically or a custom numbering is used.

  • continueNumbering (bool) – Defines whether to continue using the ID assignment of the upper levels or not. If ‘true’, layouts within this subset are going to be assigned IDs as if they were not within this subset, but part of the level above. In this case you only use the Subset as a logical grouping which has no effect on IDs.

  • useUpperPrefix (bool) – Defines whether to use the prefix and ID of the upper levels or not. If ‘true’, layouts in this subset will be assigned IDs based on the previous layout in the layout book structure.

  • addOwnPrefix (bool) – Defines whether to add own prefix to the subset or not.

  • customNumber (str) – The custom subset ID.

  • autoNumber (str) – The automatic subset ID.

  • numberingStyle (str) – A supported numbering style.

  • startAt (int) – The starting value of the numbering.

  • ownPrefix (str) – The custom prefix for the subset.

addOwnPrefix: bool
autoNumber: str
continueNumbering: bool
customNumber: str
customNumbering: bool
includeToIDSequence: bool
name: str
numberingStyle: str
ownPrefix: str
startAt: int
useUpperPrefix: bool
class SuccessfulExecutionResult(success: bool)

Bases: _ACBaseType

The result of a successful execution.

Variables:

success (bool) – EMPTY STRING

success: bool
class SurfaceAttribute(attributeId: AttributeId, name: str, materialType: str, ambientReflection: int, diffuseReflection: int, specularReflection: int, transparencyAttenuation: int, emissionAttenuation: int, surfaceColor: RGBColor, specularColor: RGBColor, emissionColor: RGBColor, fillId: AttributeIdOrError, transparency: int, shine: int, texture: Texture | None = None)

Bases: _ACBaseType

A surface attribute.

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • materialType (str) – The material type of a surface attribute.

  • ambientReflection (int) – The ambient reflection of the surface attribute.

  • diffuseReflection (int) – The diffuse reflection of the surface attribute.

  • specularReflection (int) – The specular reflection of the surface attribute.

  • transparencyAttenuation (int) – The transparency attenuation of the surface attribute.

  • emissionAttenuation (int) – The emission attenuation of the surface attribute.

  • surfaceColor (RGBColor) – A color model represented via its red, green and blue components.

  • specularColor (RGBColor) – A color model represented via its red, green and blue components.

  • emissionColor (RGBColor) – A color model represented via its red, green and blue components.

  • fillId (AttributeIdOrError) – The attribute’s identifier or an error.

  • transparency (int) – The transparency of the surface attribute.

  • shine (int) – The shininess of the surface attribute.

  • texture (Texture, optional) – A texture

ambientReflection: int
attributeId: AttributeId
diffuseReflection: int
emissionAttenuation: int
emissionColor: RGBColor
fillId: AttributeIdOrError
materialType: str
name: str
shine: int
specularColor: RGBColor
specularReflection: int
surfaceColor: RGBColor
texture: Texture | None
transparency: int
transparencyAttenuation: int
class SurfaceAttributeOrError(surfaceAttribute: SurfaceAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A surface attribute or an error.

Variables:

  • surfaceAttribute (SurfaceAttribute, optional) – A surface attribute.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
surfaceAttribute: SurfaceAttribute | None
class SurfaceAttributeWrapper(surfaceAttribute: SurfaceAttribute)

Bases: _ACBaseType

Variables:

surfaceAttribute (SurfaceAttribute) – A surface attribute.

surfaceAttribute: SurfaceAttribute
class Texture(name: str)

Bases: _ACBaseType

A texture

Variables:

name (str) – The name of the texture.

name: str
class TypeOfElement(elementId: ElementId, elementType: str)

Bases: _ACBaseType

An element id and its corresponding element type.

Variables:

  • elementId (ElementId) – The identifier of an element.

  • elementType (str) – The type of an element.

elementId: ElementId
elementType: str
class TypeOfElementOrError(typeOfElement: TypeOfElement | None = None, error: Error | None = None)

Bases: _ACUnionType

The type of an element or an error.

Variables:

  • typeOfElement (TypeOfElement, optional) – An element id and its corresponding element type.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
typeOfElement: TypeOfElement | None
class TypeOfElementWrapper(typeOfElement: TypeOfElement)

Bases: _ACBaseType

Variables:

typeOfElement (TypeOfElement) – An element id and its corresponding element type.

typeOfElement: TypeOfElement
class UserDefinedPropertyUserId(localizedName: List[str], type: str = 'UserDefined')

Bases: _ACBaseType

The unique identifier of a User-Defined Property, identified by its name.

Variables:

  • localizedName (list of str) – A two-element list of the localized name parts. The first element is the name of the group the property belongs to, and the second element is the actual name of the property.

  • type (str) – EMPTY STRING

localizedName: List[str]
type: str
class UserUndefinedPropertyValue(type: str, status: str = 'userUndefined')

Bases: _ACBaseType

A userUndefined value means that there is no actual number/string/etc. value, but the user deliberately set an Undefined value: this is a valid value, too.

Variables:

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

status: str
type: str
class WorksheetNavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str)

Bases: _ACBaseType

The details of a worksheet 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.

name: str
navigatorItemId: NavigatorItemId
prefix: str
class WorksheetNavigatorItemOrError(worksheetNavigatorItem: WorksheetNavigatorItem | None = None, error: Error | None = None)

Bases: _ACUnionType

Contains a worksheet navigator item or an error.

Variables:

  • worksheetNavigatorItem (WorksheetNavigatorItem, optional) – The details of a worksheet navigator item.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
worksheetNavigatorItem: WorksheetNavigatorItem | None
class WorksheetNavigatorItemWrapper(worksheetNavigatorItem: WorksheetNavigatorItem)

Bases: _ACBaseType

Variables:

worksheetNavigatorItem (WorksheetNavigatorItem) – The details of a worksheet navigator item.

worksheetNavigatorItem: WorksheetNavigatorItem
class ZoneCategoryAttribute(attributeId: AttributeId, name: str, categoryCode: str, stampName: str, stampMainGuid: UUID, stampRevisionGuid: UUID, color: RGBColor)

Bases: _ACBaseType

A zone category.

Variables:

  • attributeId (AttributeId) – The identifier of an attribute.

  • name (str) – The name of an attribute.

  • categoryCode (str) – The category code of the zone.

  • stampName (str) – The stamp name of the zone category.

  • stampMainGuid (UUID) – A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.

  • stampRevisionGuid (UUID) – A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.

  • color (RGBColor) – A color model represented via its red, green and blue components.

attributeId: AttributeId
categoryCode: str
color: RGBColor
name: str
stampMainGuid: UUID
stampName: str
stampRevisionGuid: UUID
class ZoneCategoryAttributeOrError(zoneCategoryAttribute: ZoneCategoryAttribute | None = None, error: Error | None = None)

Bases: _ACUnionType

A zone category attribute or an error.

Variables:

  • zoneCategoryAttribute (ZoneCategoryAttribute, optional) – A zone category.

  • error (Error, optional) – The details of an error.

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>
error: Error | None
zoneCategoryAttribute: ZoneCategoryAttribute | None
class ZoneCategoryAttributeWrapper(zoneCategoryAttribute: ZoneCategoryAttribute)

Bases: _ACBaseType

Variables:

zoneCategoryAttribute (ZoneCategoryAttribute) – A zone category.

zoneCategoryAttribute: ZoneCategoryAttribute
class archicad.Utilities(actypes: Types, accommands: Commands)

Bases: object

Utility functions for the archicad module.

FindClassificationItemInSystem(system_name: str, item_id: str) → ClassificationItemInTree | None

Finds the classification item in a system.

FindClassificationSystem(systemName: str) → ClassificationSystemId | None

Finds the classification system.

static FindInClassificationItemTree(treeRootItem: ClassificationItemInTree, criterion: Callable[[ClassificationItemInTree], bool]) → List[ClassificationItemInTree]

Finds items in a navigator tree.

Parameters:

  • treeRootItem (ClassificationItemInTree) – The root item of the classification tree.

  • criterion (Callable[[ClassificationItemInTree], bool]) – The criterion function.

Returns:

The list of classification items, which fulfill the criterion function.

Return type:

List[ClassificationItemInTree]

static FindInNavigatorItemTree(treeRootItem: NavigatorItem, criterion: Callable[[NavigatorItem], bool]) → List[NavigatorItem]

Finds items in a navigator tree.

Parameters:

  • treeRootItem (NavigatorItem) – The root item of the navigator tree.

  • criterion (Callable[[NavigatorItem], bool]) – The criterion function.

Returns:

The list of navigator items, which fulfill the criterion function.

Return type:

List[NavigatorItem]

GetBuiltInPropertyId(name: str) → PropertyId

Returns the PropertyId of the corresponding built-in property.

GetDisplayValueFromPropertyEnumValueId(propertyId: PropertyId, enumValueId: EnumValueId) → str

Returns the display value of an enumeration property value.

Parameters:

  • propertyId (PropertyId) – The identifier of the property.

  • enumValueId (EnumValueId) – The enumeration value identifier.

Returns:

The display value of the enumeration property value.

Return type:

str

GetPropertyValuesDictionary(elements: List[ElementId], propertyIds: List[PropertyId]) → Dict[ElementId, Dict[PropertyId, Any]]

Returns the values of the given elements’ given properties.

Parameters:

  • elements (List[ElementId]) – The identifier of the property.

  • propertyIds (List[PropertyId]) – The property value.

Returns:

A dictionary for the property values with two key-levels: the first key is the elementId, the second key is the propertyId.

Return type:

Dict[ElementId, Dict[PropertyId, Any]]

GetUserDefinedPropertyId(groupName: str, name: str) → PropertyId

Returns the PropertyId of the corresponding user-defined property.

GetValueFromPropertyValue(propertyId: PropertyId, propertyValue: PropertyValue) → Any

Returns the display value of a property value.

Parameters:

  • propertyId (PropertyId) – The identifier of the property.

  • propertyValue (PropertyValue) – The property value.

Returns:

The value unwrapped from the property value.

Return type:

Any

static OpenFile(filepath: str)

Opens the given file with the default application.

archicad.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.