archicad.releases.ac25 package

Submodules

archicad.releases.ac25.b3000commands module

Graphisoft

class archicad.releases.ac25.b3000commands.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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

exception archicad.releases.ac25.b3000commands.UnsucceededCommandCall

Bases: Exception

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

archicad.releases.ac25.b3000types module

Graphisoft

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.AddOnCommandIdArrayItem(addOnCommandId: AddOnCommandId)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

addOnCommandId: AddOnCommandId

class archicad.releases.ac25.b3000types.AddOnCommandParameters

Bases: _ACBaseType

The input parameters of an Add-On command.

class archicad.releases.ac25.b3000types.AddOnCommandResponse

Bases: _ACBaseType

The response returned by an Add-On command.

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.AttributeIdWrapperItem(attributeId: AttributeId)

Bases: _ACBaseType

EMPTY STRING

Variables:

attributeId (AttributeId) – The identifier of an attribute.

attributeId: AttributeId

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.BoundingBox2DWrapper(boundingBox2D: BoundingBox2D)

Bases: _ACBaseType

Variables:

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

boundingBox2D: BoundingBox2D

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.BoundingBox3DWrapper(boundingBox3D: BoundingBox3D)

Bases: _ACBaseType

Variables:

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

boundingBox3D: BoundingBox3D

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.BuildingMaterialAttributeWrapper(buildingMaterialAttribute: BuildingMaterialAttribute)

Bases: _ACBaseType

Variables:

buildingMaterialAttribute (BuildingMaterialAttribute) – A building material attribute

buildingMaterialAttribute: BuildingMaterialAttribute

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ClassificationIdOrError(classificationId: ClassificationId | None = None, error: Error | None = None)

Bases: _ACUnionType

EMPTY STRING

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 archicad.releases.ac25.b3000types.ClassificationIdWrapper(classificationId: ClassificationId)

Bases: _ACBaseType

Variables:

classificationId (ClassificationId) – The element classification identifier.

classificationId: ClassificationId

class archicad.releases.ac25.b3000types.ClassificationIdsOrErrorsWrapper(classificationIds: List[ClassificationIdOrError])

Bases: _ACBaseType

Variables:

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

classificationIds: List[ClassificationIdOrError]

class archicad.releases.ac25.b3000types.ClassificationItemArrayItem(classificationItem: ClassificationItemInTree_)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

classificationItem: ClassificationItemInTree_

class archicad.releases.ac25.b3000types.ClassificationItemDetails(id: str, name: str, description: str)

Bases: _ACBaseType

The details of a classification item.

Variables:

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

description: str

id: str

name: str

class archicad.releases.ac25.b3000types.ClassificationItemDetailsWrapper(classificationItem: ClassificationItemDetails)

Bases: _ACBaseType

Variables:

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

classificationItem: ClassificationItemDetails

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ClassificationItemIdArrayItem(classificationItemId: ClassificationItemId)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

classificationItemId: ClassificationItemId

class archicad.releases.ac25.b3000types.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

archicad.releases.ac25.b3000types.ClassificationItemInTree_

alias of ClassificationItemInTree

class archicad.releases.ac25.b3000types.ClassificationItemOrError(classificationItem: ClassificationItemDetails | None = None, error: Error | None = None)

Bases: _ACUnionType

EMPTY STRING

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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ClassificationSystemIdArrayItem(classificationSystemId: ClassificationSystemId)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

classificationSystemId: ClassificationSystemId

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.CompositeAttributeWrapper(compositeAttribute: CompositeAttribute)

Bases: _ACBaseType

Variables:

compositeAttribute (CompositeAttribute) – A composite attribute.

compositeAttribute: CompositeAttribute

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.CompositeLineListItem(compositeLine: CompositeLine)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

compositeLine: CompositeLine

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.CompositeSkinListItem(compositeSkin: CompositeSkin)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

compositeSkin: CompositeSkin

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.DashItemWrapper(dashItem: DashItem)

Bases: _ACBaseType

Variables:

dashItem (DashItem) – A dash item.

dashItem: DashItem

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ElementComponentIdArrayItem(elementComponentId: ElementComponentId)

Bases: _ACBaseType

An item of a component array.

Variables:

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

elementComponentId: ElementComponentId

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ElementComponentsWrapper(elementComponents: List[ElementComponentIdArrayItem])

Bases: _ACBaseType

List of components.

Variables:

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

elementComponents: List[ElementComponentIdArrayItem]

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ElementIdArrayItem(elementId: ElementId)

Bases: _ACBaseType

EMPTY STRING

Variables:

elementId (ElementId) – The identifier of an element.

elementId: ElementId

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.EnumValueIdWrapper(enumValueId: EnumValueId)

Bases: _ACBaseType

Variables:

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

enumValueId: EnumValueId

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ErrorItem(error: Error)

Bases: _ACBaseType

EMPTY STRING

Variables:

error (Error) – The details of an error.

error: Error

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.FailedExecutionResult(success: bool, error: Error)

Bases: _ACBaseType

EMPTY STRING

Variables:

• success (bool) – EMPTY STRING

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

error: Error

success: bool

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.FillAttributeWrapper(fillAttribute: FillAttribute)

Bases: _ACBaseType

Variables:

fillAttribute (FillAttribute) – A fill attribute.

fillAttribute: FillAttribute

class archicad.releases.ac25.b3000types.FolderParameters(name: str)

Bases: _ACBaseType

The parameters of a folder.

Variables:

name (str) – The name of the folder.

name: str

class archicad.releases.ac25.b3000types.Image(content: str)

Bases: _ACBaseType

An image encoded as a Base64 string.

Variables:

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

content: str

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ImageWrapper(image: Image)

Bases: _ACBaseType

Variables:

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

image: Image

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.LayerAttributeWrapper(layerAttribute: LayerAttribute)

Bases: _ACBaseType

Variables:

layerAttribute (LayerAttribute) – A layer attribute

layerAttribute: LayerAttribute

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.LayerCombinationAttributeWrapper(layerCombinationAttribute: LayerCombinationAttribute)

Bases: _ACBaseType

Variables:

layerCombinationAttribute (LayerCombinationAttribute) – A layer combination attribute

layerCombinationAttribute: LayerCombinationAttribute

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.LineAttributeWrapper(lineAttribute: LineAttribute)

Bases: _ACBaseType

Variables:

lineAttribute (LineAttribute) – A line attribute

lineAttribute: LineAttribute

class archicad.releases.ac25.b3000types.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) – EMPTY STRING

• endPosition (Point2D) – EMPTY STRING

• 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 archicad.releases.ac25.b3000types.LineItemWrapper(lineItem: LineItem)

Bases: _ACBaseType

Variables:

lineItem (LineItem) – A line item.

lineItem: LineItem

class archicad.releases.ac25.b3000types.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 types 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 archicad.releases.ac25.b3000types.NavigatorItemArrayItem(navigatorItem: NavigatorItem_)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

navigatorItem: NavigatorItem_

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.NavigatorItemIdWrapper(navigatorItemId: NavigatorItemId)

Bases: _ACBaseType

Variables:

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

navigatorItemId: NavigatorItemId

archicad.releases.ac25.b3000types.NavigatorItem_

alias of NavigatorItem

class archicad.releases.ac25.b3000types.NavigatorTree(rootItem: NavigatorItem)

Bases: _ACBaseType

A tree of navigator items.

Variables:

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

rootItem: NavigatorItem

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.Pen(name: str, index: int, color: RGBColor, weight: float, description: str)

Bases: _ACBaseType

A pen attribute.

Variables:

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

• 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

name: str

weight: float

class archicad.releases.ac25.b3000types.PenArrayItem(pen: Pen)

Bases: _ACBaseType

EMPTY STRING

Variables:

pen (Pen) – A pen attribute.

pen: Pen

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.PenTableAttributeWrapper(penTableAttribute: PenTableAttribute)

Bases: _ACBaseType

Variables:

penTableAttribute (PenTableAttribute) – A pen table attribute.

penTableAttribute: PenTableAttribute

class archicad.releases.ac25.b3000types.Point2D(x: float, y: float)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

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

x: float

y: float

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.PossibleEnumValuesArrayItem(enumValue: PossibleEnumValue)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

enumValue: PossibleEnumValue

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ProfileAttributeWrapper(profileAttribute: ProfileAttribute)

Bases: _ACBaseType

Variables:

profileAttribute (ProfileAttribute) – A profile attribute.

profileAttribute: ProfileAttribute

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ProfileModifierListItem(profileModifier: ProfileModifier)

Bases: _ACBaseType

EMPTY STRING

Variables:

profileModifier (ProfileModifier) – A profile modifier parameter.

profileModifier: ProfileModifier

class archicad.releases.ac25.b3000types.PropertyDefinition(group: PropertyGroup, name: str, description: str, possibleEnumValues: List[PossibleEnumValuesArrayItem] | None = None)

Bases: _ACBaseType

A property definition.

Variables:

• group (PropertyGroup) – A property group.

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

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

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

description: str

group: PropertyGroup

name: str

possibleEnumValues: List[PossibleEnumValuesArrayItem] | None

class archicad.releases.ac25.b3000types.PropertyDefinitionOrError(propertyDefinition: PropertyDefinition | None = None, error: Error | None = None)

Bases: _ACUnionType

A property definition or an error.

Variables:

• propertyDefinition (PropertyDefinition, optional) – A property definition.

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

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>

error: Error | None

propertyDefinition: PropertyDefinition | None

class archicad.releases.ac25.b3000types.PropertyDefinitionWrapper(propertyDefinition: PropertyDefinition)

Bases: _ACBaseType

Variables:

propertyDefinition (PropertyDefinition) – A property definition.

propertyDefinition: PropertyDefinition

class archicad.releases.ac25.b3000types.PropertyGroup(name: str)

Bases: _ACBaseType

A property group.

Variables:

name (str) – The property group name.

name: str

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.PropertyIdArrayItem(propertyId: PropertyId)

Bases: _ACBaseType

EMPTY STRING

Variables:

propertyId (PropertyId) – The identifier of a property.

propertyId: PropertyId

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.PropertyValueWrapper(propertyValue: PropertyValue)

Bases: _ACBaseType

Variables:

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

propertyValue: PropertyValue

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.PropertyValuesWrapper(propertyValues: List[PropertyValueOrErrorItem])

Bases: _ACBaseType

Variables:

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

propertyValues: List[PropertyValueOrErrorItem]

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.SuccessfulExecutionResult(success: bool)

Bases: _ACBaseType

EMPTY STRING

Variables:

success (bool) – EMPTY STRING

success: bool

class archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.SurfaceAttributeWrapper(surfaceAttribute: SurfaceAttribute)

Bases: _ACBaseType

Variables:

surfaceAttribute (SurfaceAttribute) – A surface attribute.

surfaceAttribute: SurfaceAttribute

class archicad.releases.ac25.b3000types.Texture(name: str)

Bases: _ACBaseType

A texture

Variables:

name (str) – The name of the texture.

name: str

class archicad.releases.ac25.b3000types.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 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 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 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 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

EMPTY STRING

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 ClassificationItemDetails(id: str, name: str, description: str)

Bases: _ACBaseType

The details of a classification item.

Variables:

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

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

EMPTY STRING

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

EMPTY STRING

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 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 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) – EMPTY STRING

• endPosition (Point2D) – EMPTY STRING

• 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 types 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 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(name: str, index: int, color: RGBColor, weight: float, description: str)

Bases: _ACBaseType

A pen attribute.

Variables:

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

• 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

name: str

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

EMPTY STRING

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 PropertyDefinition(group: PropertyGroup, name: str, description: str, possibleEnumValues: List[PossibleEnumValuesArrayItem] | None = None)

Bases: _ACBaseType

A property definition.

Variables:

• group (PropertyGroup) – A property group.

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

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

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

description: str

group: PropertyGroup

name: str

possibleEnumValues: List[PossibleEnumValuesArrayItem] | None

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.

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

propertyDefinition: PropertyDefinition

class PropertyGroup(name: str)

Bases: _ACBaseType

A property group.

Variables:

name (str) – The property group name.

name: str

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

EMPTY STRING

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 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 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.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.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 archicad.releases.ac25.b3000types.ZoneCategoryAttributeWrapper(zoneCategoryAttribute: ZoneCategoryAttribute)

Bases: _ACBaseType

Variables:

zoneCategoryAttribute (ZoneCategoryAttribute) – A zone category.

zoneCategoryAttribute: ZoneCategoryAttribute

archicad.releases.ac25.b3000utilities module

class archicad.releases.ac25.b3000utilities.Utilities(actypes: Types, accommands: Commands)

Bases: object

Utility functions for the archicad module.

FindClassificationItemInSystem(system_name: str, item_id: str) → ClassificationItemId | 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.releases.ac25.b326commands module

Graphisoft

class archicad.releases.ac25.b326commands.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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

exception archicad.releases.ac25.b326commands.UnsucceededCommandCall

Bases: Exception

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

archicad.releases.ac25.b326types module

Graphisoft

class archicad.releases.ac25.b326types.AddOnCommandId(addOnId: AddOnId, commandName: str)

Bases: _ACBaseType

The identifier of an Add-On command.

Variables:

• addOnId (AddOnId) – The Add-On identifier.

• commandName (str) – The name of the Add-On command.

addOnId: AddOnId

commandName: str

class archicad.releases.ac25.b326types.AddOnCommandIdArrayItem(addOnCommandId: AddOnCommandId)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

addOnCommandId: AddOnCommandId

class archicad.releases.ac25.b326types.AddOnCommandParameters

Bases: _ACBaseType

The input parameters of an Add-On command.

class archicad.releases.ac25.b326types.AddOnCommandResponse

Bases: _ACBaseType

The response returned by an Add-On command.

class archicad.releases.ac25.b326types.AddOnId(developerId: int, localId: int)

Bases: _ACBaseType

The Add-On identifier.

Variables:

• developerId (int) – The ID of the Add-On’s developer.

• localId (int) – The local ID of the Add-On.

developerId: int

localId: int

class archicad.releases.ac25.b326types.AttributeHeader(id: AttributeId, name: str)

Bases: _ACBaseType

The header object of an attribute.

Variables:

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

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

id: AttributeId

name: str

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.AttributeIdWrapperItem(attributeId: AttributeId)

Bases: _ACBaseType

EMPTY STRING

Variables:

attributeId (AttributeId) – The identifier of an attribute.

attributeId: AttributeId

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.BoundingBox2DWrapper(boundingBox2D: BoundingBox2D)

Bases: _ACBaseType

Variables:

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

boundingBox2D: BoundingBox2D

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.BoundingBox3DWrapper(boundingBox3D: BoundingBox3D)

Bases: _ACBaseType

Variables:

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

boundingBox3D: BoundingBox3D

class archicad.releases.ac25.b326types.BuildingMaterialAttribute(header: AttributeHeader, id: str, connectionPriority: int, cutFillId: AttributeIdOrError, cutFillPenIndex: int, cutSurfaceId: AttributeIdOrError)

Bases: _ACBaseType

A building material attribute

Variables:

• header (AttributeHeader) – The header object 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 cut fill pen index of the building material.

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

connectionPriority: int

cutFillId: AttributeIdOrError

cutFillPenIndex: int

cutSurfaceId: AttributeIdOrError

header: AttributeHeader

id: str

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.BuildingMaterialAttributeWrapper(buildingMaterialAttribute: BuildingMaterialAttribute)

Bases: _ACBaseType

Variables:

buildingMaterialAttribute (BuildingMaterialAttribute) – A building material attribute

buildingMaterialAttribute: BuildingMaterialAttribute

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ClassificationIdOrError(classificationId: ClassificationId | None = None, error: Error | None = None)

Bases: _ACUnionType

EMPTY STRING

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 archicad.releases.ac25.b326types.ClassificationIdWrapper(classificationId: ClassificationId)

Bases: _ACBaseType

Variables:

classificationId (ClassificationId) – The element classification identifier.

classificationId: ClassificationId

class archicad.releases.ac25.b326types.ClassificationIdsOrErrorsWrapper(classificationIds: List[ClassificationIdOrError])

Bases: _ACBaseType

Variables:

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

classificationIds: List[ClassificationIdOrError]

class archicad.releases.ac25.b326types.ClassificationItemArrayItem(classificationItem: ClassificationItemInTree_)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

classificationItem: ClassificationItemInTree_

class archicad.releases.ac25.b326types.ClassificationItemDetails(id: str, name: str, description: str)

Bases: _ACBaseType

The details of a classification item.

Variables:

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

description: str

id: str

name: str

class archicad.releases.ac25.b326types.ClassificationItemDetailsWrapper(classificationItem: ClassificationItemDetails)

Bases: _ACBaseType

Variables:

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

classificationItem: ClassificationItemDetails

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ClassificationItemIdArrayItem(classificationItemId: ClassificationItemId)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

classificationItemId: ClassificationItemId

class archicad.releases.ac25.b326types.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

archicad.releases.ac25.b326types.ClassificationItemInTree_

alias of ClassificationItemInTree

class archicad.releases.ac25.b326types.ClassificationItemOrError(classificationItem: ClassificationItemDetails | None = None, error: Error | None = None)

Bases: _ACUnionType

EMPTY STRING

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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ClassificationSystemIdArrayItem(classificationSystemId: ClassificationSystemId)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

classificationSystemId: ClassificationSystemId

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.CompositeAttribute(header: AttributeHeader, totalThickness: float, compositeSkins: List[CompositeSkinListItem], compositeLines: List[CompositeLineListItem], useWith: List[str])

Bases: _ACBaseType

A composite attribute.

Variables:

• header (AttributeHeader) – The header object 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.

compositeLines: List[CompositeLineListItem]

compositeSkins: List[CompositeSkinListItem]

header: AttributeHeader

totalThickness: float

useWith: List[str]

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.CompositeAttributeWrapper(compositeAttribute: CompositeAttribute)

Bases: _ACBaseType

Variables:

compositeAttribute (CompositeAttribute) – A composite attribute.

compositeAttribute: CompositeAttribute

class archicad.releases.ac25.b326types.CompositeLine(lineId: AttributeIdOrError, linePenNr: int)

Bases: _ACBaseType

A contour or separator line component for a composite attribute.

Variables:

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

• linePenNr (int) – The number of the line pen.

lineId: AttributeIdOrError

linePenNr: int

class archicad.releases.ac25.b326types.CompositeLineListItem(compositeLine: CompositeLine)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

compositeLine: CompositeLine

class archicad.releases.ac25.b326types.CompositeSkin(buildingMaterialId: AttributeIdOrError, framePenNr: int, thickness: float, isCore: bool, isFinish: bool)

Bases: _ACBaseType

A skin component for a composite attribute.

Variables:

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

• framePenNr (int) – The number of the frame pen.

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

buildingMaterialId: AttributeIdOrError

framePenNr: int

isCore: bool

isFinish: bool

thickness: float

class archicad.releases.ac25.b326types.CompositeSkinListItem(compositeSkin: CompositeSkin)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

compositeSkin: CompositeSkin

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.DashItemWrapper(dashItem: DashItem)

Bases: _ACBaseType

Variables:

dashItem (DashItem) – A dash item.

dashItem: DashItem

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ElementComponentIdArrayItem(elementComponentId: ElementComponentId)

Bases: _ACBaseType

An item of a component array.

Variables:

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

elementComponentId: ElementComponentId

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ElementComponentsWrapper(elementComponents: List[ElementComponentIdArrayItem])

Bases: _ACBaseType

List of components.

Variables:

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

elementComponents: List[ElementComponentIdArrayItem]

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ElementIdArrayItem(elementId: ElementId)

Bases: _ACBaseType

EMPTY STRING

Variables:

elementId (ElementId) – The identifier of an element.

elementId: ElementId

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.EnumValueIdWrapper(enumValueId: EnumValueId)

Bases: _ACBaseType

Variables:

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

enumValueId: EnumValueId

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ErrorItem(error: Error)

Bases: _ACBaseType

EMPTY STRING

Variables:

error (Error) – The details of an error.

error: Error

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.FailedExecutionResult(success: bool, error: Error)

Bases: _ACBaseType

EMPTY STRING

Variables:

• success (bool) – EMPTY STRING

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

error: Error

success: bool

class archicad.releases.ac25.b326types.FillAttribute(header: AttributeHeader, subType: str, pattern: int)

Bases: _ACBaseType

A fill attribute.

Variables:

• header (AttributeHeader) – The header object 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.

header: AttributeHeader

pattern: int

subType: str

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.FillAttributeWrapper(fillAttribute: FillAttribute)

Bases: _ACBaseType

Variables:

fillAttribute (FillAttribute) – A fill attribute.

fillAttribute: FillAttribute

class archicad.releases.ac25.b326types.FolderParameters(name: str)

Bases: _ACBaseType

The parameters of a folder.

Variables:

name (str) – The name of the folder.

name: str

class archicad.releases.ac25.b326types.Image(content: str)

Bases: _ACBaseType

An image encoded as a Base64 string.

Variables:

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

content: str

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ImageWrapper(image: Image)

Bases: _ACBaseType

Variables:

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

image: Image

class archicad.releases.ac25.b326types.LayerAttribute(header: AttributeHeader, intersectionGroupNr: int, isLocked: bool, isHidden: bool, isWireframe: bool)

Bases: _ACBaseType

A layer attribute

Variables:

• header (AttributeHeader) – The header object 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.

header: AttributeHeader

intersectionGroupNr: int

isHidden: bool

isLocked: bool

isWireframe: bool

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.LayerAttributeWrapper(layerAttribute: LayerAttribute)

Bases: _ACBaseType

Variables:

layerAttribute (LayerAttribute) – A layer attribute

layerAttribute: LayerAttribute

class archicad.releases.ac25.b326types.LayerCombinationAttribute(header: AttributeHeader, layerAttributeIds: List[AttributeIdWrapperItem])

Bases: _ACBaseType

A layer combination attribute

Variables:

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

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

header: AttributeHeader

layerAttributeIds: List[AttributeIdWrapperItem]

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.LayerCombinationAttributeWrapper(layerCombinationAttribute: LayerCombinationAttribute)

Bases: _ACBaseType

Variables:

layerCombinationAttribute (LayerCombinationAttribute) – A layer combination attribute

layerCombinationAttribute: LayerCombinationAttribute

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.LineAttribute(header: AttributeHeader, appearenceType: str, displayScale: float, period: float, height: float, lineType: str, lineItems: List[DashOrLineItem] | None = None)

Bases: _ACBaseType

A line attribute

Variables:

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

• appearenceType (str) – The appearence type of a line 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.

appearenceType: str

displayScale: float

header: AttributeHeader

height: float

lineItems: List[DashOrLineItem] | None

lineType: str

period: float

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.LineAttributeWrapper(lineAttribute: LineAttribute)

Bases: _ACBaseType

Variables:

lineAttribute (LineAttribute) – A line attribute

lineAttribute: LineAttribute

class archicad.releases.ac25.b326types.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) – EMPTY STRING

• endPosition (Point2D) – EMPTY STRING

• 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 archicad.releases.ac25.b326types.LineItemWrapper(lineItem: LineItem)

Bases: _ACBaseType

Variables:

lineItem (LineItem) – A line item.

lineItem: LineItem

class archicad.releases.ac25.b326types.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 types 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 archicad.releases.ac25.b326types.NavigatorItemArrayItem(navigatorItem: NavigatorItem_)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

navigatorItem: NavigatorItem_

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.NavigatorItemIdWrapper(navigatorItemId: NavigatorItemId)

Bases: _ACBaseType

Variables:

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

navigatorItemId: NavigatorItemId

archicad.releases.ac25.b326types.NavigatorItem_

alias of NavigatorItem

class archicad.releases.ac25.b326types.NavigatorTree(rootItem: NavigatorItem)

Bases: _ACBaseType

A tree of navigator items.

Variables:

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

rootItem: NavigatorItem

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.Pen(name: str, index: int, color: RGBColor, weight: float, description: str)

Bases: _ACBaseType

A pen attribute.

Variables:

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

• index (int) – The index of the 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

name: str

weight: float

class archicad.releases.ac25.b326types.PenArrayItem(pen: Pen)

Bases: _ACBaseType

EMPTY STRING

Variables:

pen (Pen) – A pen attribute.

pen: Pen

class archicad.releases.ac25.b326types.PenTableAttribute(header: AttributeHeader, pens: List[PenArrayItem])

Bases: _ACBaseType

A pen table attribute.

Variables:

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

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

header: AttributeHeader

pens: List[PenArrayItem]

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.PenTableAttributeWrapper(penTableAttribute: PenTableAttribute)

Bases: _ACBaseType

Variables:

penTableAttribute (PenTableAttribute) – A pen table attribute.

penTableAttribute: PenTableAttribute

class archicad.releases.ac25.b326types.Point2D(x: float, y: float)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

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

x: float

y: float

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.PossibleEnumValuesArrayItem(enumValue: PossibleEnumValue)

Bases: _ACBaseType

EMPTY STRING

Variables:

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

enumValue: PossibleEnumValue

class archicad.releases.ac25.b326types.ProfileAttribute(header: AttributeHeader, 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:

• header (AttributeHeader) – The header object 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.

hasCoreSkin: bool

header: AttributeHeader

height: float

heightStretchable: bool

minimumHeight: float

minimumWidth: float

profileModifiers: List[ProfileModifierListItem]

useWith: List[str]

width: float

widthStretchable: bool

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ProfileAttributeWrapper(profileAttribute: ProfileAttribute)

Bases: _ACBaseType

Variables:

profileAttribute (ProfileAttribute) – A profile attribute.

profileAttribute: ProfileAttribute

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ProfileModifierListItem(profileModifier: ProfileModifier)

Bases: _ACBaseType

EMPTY STRING

Variables:

profileModifier (ProfileModifier) – A profile modifier parameter.

profileModifier: ProfileModifier

class archicad.releases.ac25.b326types.PropertyDefinition(group: PropertyGroup, name: str, description: str, possibleEnumValues: List[PossibleEnumValuesArrayItem] | None = None)

Bases: _ACBaseType

A property definition.

Variables:

• group (PropertyGroup) – A property group.

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

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

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

description: str

group: PropertyGroup

name: str

possibleEnumValues: List[PossibleEnumValuesArrayItem] | None

class archicad.releases.ac25.b326types.PropertyDefinitionOrError(propertyDefinition: PropertyDefinition | None = None, error: Error | None = None)

Bases: _ACUnionType

A property definition or an error.

Variables:

• propertyDefinition (PropertyDefinition, optional) – A property definition.

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

constructor: _ConstructUnion = <archicad.acbasetype._ConstructUnion object>

error: Error | None

propertyDefinition: PropertyDefinition | None

class archicad.releases.ac25.b326types.PropertyDefinitionWrapper(propertyDefinition: PropertyDefinition)

Bases: _ACBaseType

Variables:

propertyDefinition (PropertyDefinition) – A property definition.

propertyDefinition: PropertyDefinition

class archicad.releases.ac25.b326types.PropertyGroup(name: str)

Bases: _ACBaseType

A property group.

Variables:

name (str) – The property group name.

name: str

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.PropertyIdArrayItem(propertyId: PropertyId)

Bases: _ACBaseType

EMPTY STRING

Variables:

propertyId (PropertyId) – The identifier of a property.

propertyId: PropertyId

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.PropertyValueWrapper(propertyValue: PropertyValue)

Bases: _ACBaseType

Variables:

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

propertyValue: PropertyValue

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.PropertyValuesWrapper(propertyValues: List[PropertyValueOrErrorItem])

Bases: _ACBaseType

Variables:

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

propertyValues: List[PropertyValueOrErrorItem]

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.SuccessfulExecutionResult(success: bool)

Bases: _ACBaseType

EMPTY STRING

Variables:

success (bool) – EMPTY STRING

success: bool

class archicad.releases.ac25.b326types.SurfaceAttribute(header: AttributeHeader, 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:

• header (AttributeHeader) – The header object 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

diffuseReflection: int

emissionAttenuation: int

emissionColor: RGBColor

fillId: AttributeIdOrError

header: AttributeHeader

materialType: str

shine: int

specularColor: RGBColor

specularReflection: int

surfaceColor: RGBColor

texture: Texture | None

transparency: int

transparencyAttenuation: int

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.SurfaceAttributeWrapper(surfaceAttribute: SurfaceAttribute)

Bases: _ACBaseType

Variables:

surfaceAttribute (SurfaceAttribute) – A surface attribute.

surfaceAttribute: SurfaceAttribute

class archicad.releases.ac25.b326types.Texture(name: str)

Bases: _ACBaseType

A texture

Variables:

name (str) – The name of the texture.

name: str

class archicad.releases.ac25.b326types.Types

Bases: object

class AddOnCommandId(addOnId: AddOnId, commandName: str)

Bases: _ACBaseType

The identifier of an Add-On command.

Variables:

• addOnId (AddOnId) – The Add-On identifier.

• commandName (str) – The name of the Add-On command.

addOnId: AddOnId

commandName: 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 AddOnId(developerId: int, localId: int)

Bases: _ACBaseType

The Add-On identifier.

Variables:

• developerId (int) – The ID of the Add-On’s developer.

• localId (int) – The local ID of the Add-On.

developerId: int

localId: int

class AttributeHeader(id: AttributeId, name: str)

Bases: _ACBaseType

The header object of an attribute.

Variables:

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

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

id: AttributeId

name: str

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 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(header: AttributeHeader, id: str, connectionPriority: int, cutFillId: AttributeIdOrError, cutFillPenIndex: int, cutSurfaceId: AttributeIdOrError)

Bases: _ACBaseType

A building material attribute

Variables:

• header (AttributeHeader) – The header object 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 cut fill pen index of the building material.

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

connectionPriority: int

cutFillId: AttributeIdOrError

cutFillPenIndex: int

cutSurfaceId: AttributeIdOrError

header: AttributeHeader

id: 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 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

EMPTY STRING

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 ClassificationItemDetails(id: str, name: str, description: str)

Bases: _ACBaseType

The details of a classification item.

Variables:

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

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

EMPTY STRING

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 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(header: AttributeHeader, totalThickness: float, compositeSkins: List[CompositeSkinListItem], compositeLines: List[CompositeLineListItem], useWith: List[str])

Bases: _ACBaseType

A composite attribute.

Variables:

• header (AttributeHeader) – The header object 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.

compositeLines: List[CompositeLineListItem]

compositeSkins: List[CompositeSkinListItem]

header: AttributeHeader

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, linePenNr: int)

Bases: _ACBaseType

A contour or separator line component for a composite attribute.

Variables:

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

• linePenNr (int) – The number of the line pen.

lineId: AttributeIdOrError

linePenNr: int

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, framePenNr: int, thickness: float, isCore: bool, isFinish: bool)

Bases: _ACBaseType

A skin component for a composite attribute.

Variables:

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

• framePenNr (int) – The number of the frame pen.

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

buildingMaterialId: AttributeIdOrError

framePenNr: int

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

EMPTY STRING

Variables:

• success (bool) – EMPTY STRING

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

error: Error

success: bool

class FillAttribute(header: AttributeHeader, subType: str, pattern: int)

Bases: _ACBaseType

A fill attribute.

Variables:

• header (AttributeHeader) – The header object 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.

header: AttributeHeader

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 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 LayerAttribute(header: AttributeHeader, intersectionGroupNr: int, isLocked: bool, isHidden: bool, isWireframe: bool)

Bases: _ACBaseType

A layer attribute

Variables:

• header (AttributeHeader) – The header object 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.

header: AttributeHeader

intersectionGroupNr: int

isHidden: bool

isLocked: bool

isWireframe: bool

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(header: AttributeHeader, layerAttributeIds: List[AttributeIdWrapperItem])

Bases: _ACBaseType

A layer combination attribute

Variables:

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

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

header: AttributeHeader

layerAttributeIds: List[AttributeIdWrapperItem]

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(header: AttributeHeader, appearenceType: str, displayScale: float, period: float, height: float, lineType: str, lineItems: List[DashOrLineItem] | None = None)

Bases: _ACBaseType

A line attribute

Variables:

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

• appearenceType (str) – The appearence type of a line 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.

appearenceType: str

displayScale: float

header: AttributeHeader

height: float

lineItems: List[DashOrLineItem] | None

lineType: 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) – EMPTY STRING

• endPosition (Point2D) – EMPTY STRING

• 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 types 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 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(name: str, index: int, color: RGBColor, weight: float, description: str)

Bases: _ACBaseType

A pen attribute.

Variables:

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

• index (int) – The index of the 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

name: str

weight: float

class PenArrayItem(pen: Pen)

Bases: _ACBaseType

EMPTY STRING

Variables:

pen (Pen) – A pen attribute.

pen: Pen

class PenTableAttribute(header: AttributeHeader, pens: List[PenArrayItem])

Bases: _ACBaseType

A pen table attribute.

Variables:

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

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

header: AttributeHeader

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

EMPTY STRING

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(header: AttributeHeader, 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:

• header (AttributeHeader) – The header object 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.

hasCoreSkin: bool

header: AttributeHeader

height: float

heightStretchable: bool

minimumHeight: float

minimumWidth: float

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 PropertyDefinition(group: PropertyGroup, name: str, description: str, possibleEnumValues: List[PossibleEnumValuesArrayItem] | None = None)

Bases: _ACBaseType

A property definition.

Variables:

• group (PropertyGroup) – A property group.

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

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

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

description: str

group: PropertyGroup

name: str

possibleEnumValues: List[PossibleEnumValuesArrayItem] | None

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.

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

propertyDefinition: PropertyDefinition

class PropertyGroup(name: str)

Bases: _ACBaseType

A property group.

Variables:

name (str) – The property group name.

name: str

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

EMPTY STRING

Variables:

success (bool) – EMPTY STRING

success: bool

class SurfaceAttribute(header: AttributeHeader, 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:

• header (AttributeHeader) – The header object 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

diffuseReflection: int

emissionAttenuation: int

emissionColor: RGBColor

fillId: AttributeIdOrError

header: AttributeHeader

materialType: 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 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 ZoneCategoryAttribute(header: AttributeHeader, categoryCode: str, stampName: str, stampMainGuid: UUID, stampRevisionGuid: UUID, color: RGBColor)

Bases: _ACBaseType

A zone category.

Variables:

• header (AttributeHeader) – The header object 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.

categoryCode: str

color: RGBColor

header: AttributeHeader

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.releases.ac25.b326types.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 archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ZoneCategoryAttribute(header: AttributeHeader, categoryCode: str, stampName: str, stampMainGuid: UUID, stampRevisionGuid: UUID, color: RGBColor)

Bases: _ACBaseType

A zone category.

Variables:

• header (AttributeHeader) – The header object 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.

categoryCode: str

color: RGBColor

header: AttributeHeader

stampMainGuid: UUID

stampName: str

stampRevisionGuid: UUID

class archicad.releases.ac25.b326types.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 archicad.releases.ac25.b326types.ZoneCategoryAttributeWrapper(zoneCategoryAttribute: ZoneCategoryAttribute)

Bases: _ACBaseType

Variables:

zoneCategoryAttribute (ZoneCategoryAttribute) – A zone category.

zoneCategoryAttribute: ZoneCategoryAttribute

archicad.releases.ac25.b326utilities module

class archicad.releases.ac25.b326utilities.Utilities(actypes: Types, accommands: Commands)

Bases: object

Utility functions for the archicad module.

FindClassificationItemInSystem(system_name: str, item_id: str) → ClassificationItemId | 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.

Module contents