archicad.releases.ac24 package¶

Submodules¶

archicad.releases.ac24.b2310commands module¶

Graphisoft

class archicad.releases.ac24.b2310commands.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) – Provides a way 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) – List of navigator item identifiers.
Returns:: Execution result for each input case.
Return type:: list of ExecutionResult

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 Element Information.

Parameters:: elements (list of ElementIdArrayItem) – List of the elements.
Returns:: List of element’s 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 Element Information.

Parameters:: elements (list of ElementIdArrayItem) – List of the elements.
Returns:: List of element’s 3D bounding boxes
Return type:: list of BoundingBox3DOrError

GetAllClassificationSystems() → List[ClassificationSystem]¶

Returns the list of available classification systems.

Returns:: The 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:: The list of classification items.
Return type:: list of ClassificationItemArrayItem

GetAllElements() → List[ElementIdArrayItem]¶

Returns the identifier of every element in the current plan.

Returns:: List of the elements.
Return type:: list of ElementIdArrayItem

GetAllPropertyNames() → List[PropertyUserId]¶

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

Returns:: List of PropertyUserId objects.
Return type:: list of PropertyUserId

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) – List of the elements.
classificationSystemIds (list of ClassificationSystemIdArrayItem) – The list of classification system identifiers.

Returns:

The list of element classification identifiers or errors.

Return type:

list of ElementClassificationOrError

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

Returns the details of classification items.

Parameters:: classificationItemIds (list of ClassificationItemIdArrayItem) – The list of classification item identifiers.
Returns:: The 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) – The list of property identifiers.
Returns:: The 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:: List of the 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:: List of the 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) – List of the elements.
elementTypes (list of str, optional) – List of element types.

Returns:

List of elements or error.

Return type:

list of ElementsOrError

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

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

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

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

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

Parameters:: properties (list of PropertyUserId) – List of PropertyUserId objects.
Returns:: The list of property identifiers or errors.
Return type:: list of PropertyIdOrError

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

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

Parameters:

elements (list of ElementIdArrayItem) – List of the elements.
properties (list of PropertyIdArrayItem) – The list of property identifiers.

Returns:

List of property value lists for elements

Return type:

list of PropertyValuesOrErrorForElement

GetPublisherSetNames() → List[str]¶

Returns the names of available publisher sets.

Returns:: The names of available publisher sets.
Return type:: list of str

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 parentNavigatorItemId in the navigator tree. If previousNavigatorItemId 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) – The list of element classification identifiers.
Returns:: Execution result for each input case.
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) – List of element property values.
Returns:: Execution result for each input case.
Return type:: list of ExecutionResult

exception archicad.releases.ac24.b2310commands.UnsucceededCommandCall¶: Bases: Exception

archicad.releases.ac24.b2310commands.post_command(req: Request, jsonStr: str) → Dict[str, Any]¶

archicad.releases.ac24.b2310types module¶

Graphisoft

class archicad.releases.ac24.b2310types.BoundingBox2D(xMin: float, yMin: float, xMax: float, yMax: float)¶

Bases: _ACBaseType

2D bounding box of an element.

Variables:

xMin (float) – Minimum X value of bounding box.
yMin (float) – Minimum Y value of bounding box.
xMax (float) – Maximum X value of bounding box.
yMax (float) – Maximum Y value of bounding box.

xMax: float¶

xMin: float¶

yMax: float¶

yMin: float¶

class archicad.releases.ac24.b2310types.BoundingBox2DOrError(boundingBox2D: BoundingBox2D | None = None, error: Error | None = None)¶

Bases: _ACUnionType

A 2D bounding box or error.

Variables:

boundingBox2D (BoundingBox2D, optional) – 2D bounding box of an element.
error (Error, optional) – Error details.

boundingBox2D: BoundingBox2D | None¶

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

error: Error | None¶

class archicad.releases.ac24.b2310types.BoundingBox2DWrapper(boundingBox2D: BoundingBox2D)¶

Bases: _ACBaseType

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

boundingBox2D: BoundingBox2D¶

class archicad.releases.ac24.b2310types.BoundingBox3D(xMin: float, yMin: float, zMin: float, xMax: float, yMax: float, zMax: float)¶

Bases: _ACBaseType

3D bounding box of an element.

Variables:

xMin (float) – Minimum X value of bounding box.
yMin (float) – Minimum Y value of bounding box.
zMin (float) – Minimum Z value of bounding box.
xMax (float) – Maximum X value of bounding box.
yMax (float) – Maximum Y value of bounding box.
zMax (float) – Maximum Z value of bounding box.

xMax: float¶

xMin: float¶

yMax: float¶

yMin: float¶

zMax: float¶

zMin: float¶

class archicad.releases.ac24.b2310types.BoundingBox3DOrError(boundingBox3D: BoundingBox3D | None = None, error: Error | None = None)¶

Bases: _ACUnionType

A 3D bounding box or error.

Variables:

boundingBox3D (BoundingBox3D, optional) – 3D bounding box of an element.
error (Error, optional) – Error details.

boundingBox3D: BoundingBox3D | None¶

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

error: Error | None¶

class archicad.releases.ac24.b2310types.BoundingBox3DWrapper(boundingBox3D: BoundingBox3D)¶

Bases: _ACBaseType

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

boundingBox3D: BoundingBox3D¶

class archicad.releases.ac24.b2310types.BuiltInPropertyUserId(nonLocalizedName: str, type: str = 'BuiltIn')¶

Bases: _ACBaseType

An object which uniquely identifies a Built-In Property by its name in a human-readable form.

Variables:

nonLocalizedName (str) – Non-localized name of the Built-In Property.
type (str) – EMPTY STRING

nonLocalizedName: str¶

type: str¶

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

Bases: _ACUnionType

EMPTY STRING

Variables:

classificationId (ClassificationId, optional) – The element classification identifier.
error (Error, optional) – Error details.

classificationId: ClassificationId | None¶

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

error: Error | None¶

class archicad.releases.ac24.b2310types.ClassificationIdWrapper(classificationId: ClassificationId)¶

Bases: _ACBaseType

Variables:: classificationId (ClassificationId) – The element classification identifier.

classificationId: ClassificationId¶

class archicad.releases.ac24.b2310types.ClassificationIdsOrErrorsWrapper(classificationIds: List[ClassificationIdOrError])¶

Bases: _ACBaseType

Variables:: classificationIds (list of ClassificationIdOrError) – The list of element classification identifiers or errors.

classificationIds: List[ClassificationIdOrError]¶

class archicad.releases.ac24.b2310types.ClassificationItemArrayItem(classificationItem: ClassificationItemInTree_)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: classificationItem (ClassificationItemInTree_) – Details of a classification item.

classificationItem: ClassificationItemInTree_¶

class archicad.releases.ac24.b2310types.ClassificationItemDetails(id: str, name: str, description: str)¶

Bases: _ACBaseType

Details of a classification item.

Variables:

id (str) – The user specified unique identifier of the classification item.
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.ac24.b2310types.ClassificationItemDetailsWrapper(classificationItem: ClassificationItemDetails)¶

Bases: _ACBaseType

Variables:: classificationItem (ClassificationItemDetails) – Details of a classification item.

classificationItem: ClassificationItemDetails¶

class archicad.releases.ac24.b2310types.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.ac24.b2310types.ClassificationItemIdArrayItem(classificationItemId: ClassificationItemId)¶

Bases: _ACBaseType

EMPTY STRING

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

classificationItemId: ClassificationItemId¶

class archicad.releases.ac24.b2310types.ClassificationItemInTree(classificationItemId: ClassificationItemId, id: str, name: str, description: str, children: List[ClassificationItemArrayItem] | None = None)¶

Bases: _ACBaseType

Details of a classification item.

Variables:

classificationItemId (ClassificationItemId) – The identifier of a classification item.
id (str) – The user specified unique identifier of the classification item.
name (str) – The display name of the classification item.
description (str) – The description of the classification item.
children (list of ClassificationItemArrayItem, optional) – The list of classification items.

children: List[ClassificationItemArrayItem] | None¶

classificationItemId: ClassificationItemId¶

description: str¶

id: str¶

name: str¶

archicad.releases.ac24.b2310types.ClassificationItemInTree_¶: alias of ClassificationItemInTree

class archicad.releases.ac24.b2310types.ClassificationItemOrError(classificationItem: ClassificationItemDetails | None = None, error: Error | None = None)¶

Bases: _ACUnionType

EMPTY STRING

Variables:

classificationItem (ClassificationItemDetails, optional) – Details of a classification item.
error (Error, optional) – Error details.

classificationItem: ClassificationItemDetails | None¶

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

error: Error | None¶

class archicad.releases.ac24.b2310types.ClassificationSystem(classificationSystemId: ClassificationSystemId, name: str, description: str, source: str, version: str, date: str)¶

Bases: _ACBaseType

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 string 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.ac24.b2310types.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.ac24.b2310types.ClassificationSystemIdArrayItem(classificationSystemId: ClassificationSystemId)¶

Bases: _ACBaseType

EMPTY STRING

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

classificationSystemId: ClassificationSystemId¶

class archicad.releases.ac24.b2310types.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.ac24.b2310types.ElementClassification(elementId: ElementId, classificationId: ClassificationId)¶

Bases: _ACBaseType

Element classification.

Variables:

elementId (ElementId) – The identifier of an element.
classificationId (ClassificationId) – The element classification identifier.

classificationId: ClassificationId¶

elementId: ElementId¶

class archicad.releases.ac24.b2310types.ElementClassificationOrError(classificationIds: List[ClassificationIdOrError] | None = None, error: Error | None = None)¶

Bases: _ACUnionType

Element classification identifiers or error.

Variables:

classificationIds (list of ClassificationIdOrError, optional) – The list of element classification identifiers or errors.
error (Error, optional) – Error details.

classificationIds: List[ClassificationIdOrError] | None¶

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

error: Error | None¶

class archicad.releases.ac24.b2310types.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.ac24.b2310types.ElementIdArrayItem(elementId: ElementId)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: elementId (ElementId) – The identifier of an element.

elementId: ElementId¶

class archicad.releases.ac24.b2310types.ElementPropertyValue(elementId: ElementId, propertyId: PropertyId, propertyValue: NormalOrUserUndefinedPropertyValue)¶

Bases: _ACBaseType

A property value with the identifier of the property and the 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.ac24.b2310types.ElementsOrError(elements: List[ElementIdArrayItem] | None = None, error: Error | None = None)¶

Bases: _ACUnionType

List of elements or error.

Variables:

elements (list of ElementIdArrayItem, optional) – List of the elements.
error (Error, optional) – Error details.

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

elements: List[ElementIdArrayItem] | None¶

error: Error | None¶

class archicad.releases.ac24.b2310types.ElementsWrapper(elements: List[ElementIdArrayItem])¶

Bases: _ACBaseType

List of elements.

Variables:: elements (list of ElementIdArrayItem) – List of the elements.

elements: List[ElementIdArrayItem]¶

archicad.releases.ac24.b2310types.EnumValueId¶: The identifier of a property enumeration value.

class archicad.releases.ac24.b2310types.EnumValueIdWrapper(enumValueId: DisplayValueEnumId)¶

Bases: _ACBaseType

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

enumValueId: EnumValueId¶

class archicad.releases.ac24.b2310types.Error(code: int, message: str)¶

Bases: _ACBaseType

Error details.

Variables:

code (int) – The error code.
message (str) – The error message.

code: int¶

message: str¶

class archicad.releases.ac24.b2310types.ErrorItem(error: Error)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: error (Error) – Error details.

error: Error¶

class archicad.releases.ac24.b2310types.ExecutionResult(success: bool, error: Error | None = None)¶

Bases: _ACUnionType

The result of the execution for one case.

Variables:

success (bool) – None
error (Error, optional) – Error details.

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

error: Error | None¶

success: bool¶

class archicad.releases.ac24.b2310types.FailedExecutionResult(success: bool, error: Error)¶

Bases: _ACBaseType

EMPTY STRING

Variables:

success (bool) – EMPTY STRING
error (Error) – Error details.

error: Error¶

success: bool¶

class archicad.releases.ac24.b2310types.FolderParameters(name: str)¶

Bases: _ACBaseType

The parameters of a folder.

Variables:: name (str) – The name of the folder to create.

name: str¶

class archicad.releases.ac24.b2310types.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) – Horizontal size of the layout in millimeters.
verticalSize (float) – Vertical size of the layout in millimeters.
leftMargin (float) – Layout margin from the left side of the paper.
topMargin (float) – Layout margin from the top side of the paper.
rightMargin (float) – Layout margin from the right side of the paper.
bottomMargin (float) – Layout margin from the bottom side of the paper.
customLayoutNumber (str) – Specifies the custom ID.
customLayoutNumbering (bool) – Defines whether a unique ID is used for the current layout or not.
doNotIncludeInNumbering (bool) – Indicates whether this layout is included in or excluded from automatic ID assignment.
displayMasterLayoutBelow (bool) – Display the master layout above or below the layout.
layoutPageNumber (int) – 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) – ID of the current document revision of the layout.
currentFinalRevisionId (str) – ID with optional suffix of the current document revision of the layout.
hasIssuedRevision (bool) – One or more issued document revisions have already been created for the layout.
hasActualRevision (bool) – An open document revision exists for the layout.

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.ac24.b2310types.NavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str, type: str, sourceNavigatorItemId: NavigatorItemId | None = None, children: List[NavigatorItemArrayItem] | None = None)¶

Bases: _ACBaseType

Details of a navigator item.

Variables:

navigatorItemId (NavigatorItemId) – The identifier of a navigator item.
prefix (str) – Prefix of the name of the navigator item.
name (str) – Name of the navigator item.
type (str) – Possible types of a navigator item. Most of the names are self-explanatory, the only exception is ‘UndefinedItem’, which means that the type of this navigator item cannot be retrieved from Archicad yet.
sourceNavigatorItemId (NavigatorItemId, optional) – The identifier of a navigator item.
children (list of NavigatorItemArrayItem, optional) – List of navigator items.

children: List[NavigatorItemArrayItem] | None¶

name: str¶

navigatorItemId: NavigatorItemId¶

prefix: str¶

sourceNavigatorItemId: NavigatorItemId | None¶

type: str¶

class archicad.releases.ac24.b2310types.NavigatorItemArrayItem(navigatorItem: NavigatorItem_)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: navigatorItem (NavigatorItem_) – Details of a navigator item.

navigatorItem: NavigatorItem_¶

class archicad.releases.ac24.b2310types.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.ac24.b2310types.NavigatorItemIdWrapper(navigatorItemId: NavigatorItemId)¶

Bases: _ACBaseType

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

navigatorItemId: NavigatorItemId¶

archicad.releases.ac24.b2310types.NavigatorItem_¶: alias of NavigatorItem

class archicad.releases.ac24.b2310types.NavigatorTree(rootItem: NavigatorItem)¶

Bases: _ACBaseType

A tree of navigator items.

Variables:: rootItem (NavigatorItem) – Details of a navigator item.

rootItem: NavigatorItem¶

class archicad.releases.ac24.b2310types.NavigatorTreeId(type: str, name: str | None = None)¶

Bases: _ACUnionType

The identifier of a navigator item tree.

Variables:

type (str) – Type of the navigator item tree.
name (str, optional) – Name of the publisher set.

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

name: str | None¶

type: str¶

class archicad.releases.ac24.b2310types.NormalAngleListPropertyValue(value: List[float], type: str = 'angleList', status: str = 'normal')¶

Bases: _ACBaseType

A angle list property value containing angles in an array. 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.ac24.b2310types.NormalAnglePropertyValue(value: float, type: str = 'angle', status: str = 'normal')¶

Bases: _ACBaseType

An angle property value containing a real angle. 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.ac24.b2310types.NormalAreaListPropertyValue(value: List[float], type: str = 'areaList', status: str = 'normal')¶

Bases: _ACBaseType

A area list property value containing areas in an array. 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.ac24.b2310types.NormalAreaPropertyValue(value: float, type: str = 'area', status: str = 'normal')¶

Bases: _ACBaseType

An area property value containing a real area. 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.ac24.b2310types.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.ac24.b2310types.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.ac24.b2310types.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.ac24.b2310types.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.ac24.b2310types.NormalLengthListPropertyValue(value: List[float], type: str = 'lengthList', status: str = 'normal')¶

Bases: _ACBaseType

A length list property value containing length values in an array. 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.ac24.b2310types.NormalLengthPropertyValue(value: float, type: str = 'length', status: str = 'normal')¶

Bases: _ACBaseType

A length property value containing a real length value. 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.ac24.b2310types.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) – List of enumeration identifiers.
type (str) – EMPTY STRING
status (str) – EMPTY STRING

status: str¶

type: str¶

value: List[EnumValueIdWrapper]¶

class archicad.releases.ac24.b2310types.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.ac24.b2310types.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¶

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.; 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.ac24.b2310types.NormalSingleEnumPropertyValue(value: DisplayValueEnumId, 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.ac24.b2310types.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.ac24.b2310types.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.ac24.b2310types.NormalVolumeListPropertyValue(value: List[float], type: str = 'volumeList', status: str = 'normal')¶

Bases: _ACBaseType

A volume list property value containing volumes in an array. 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.ac24.b2310types.NormalVolumePropertyValue(value: float, type: str = 'volume', status: str = 'normal')¶

Bases: _ACBaseType

A volume property value containing a real volume. 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.ac24.b2310types.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.ac24.b2310types.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.ac24.b2310types.OtherNavigatorTreeId(type: str)¶

Bases: _ACBaseType

The identifier of a navigator item tree.

Variables:: type (str) – Type of the navigator item tree.

type: str¶

class archicad.releases.ac24.b2310types.PossibleEnumValue(enumValueId: DisplayValueEnumId, displayValue: str)¶

Bases: _ACBaseType

Description of an enumeration value.

Variables:

enumValueId (EnumValueId) – The identifier of a property enumeration value.
displayValue (str) – Displayed value of the enumeration.

displayValue: str¶

enumValueId: EnumValueId¶

class archicad.releases.ac24.b2310types.PossibleEnumValuesArrayItem(enumValue: PossibleEnumValue)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: enumValue (PossibleEnumValue) – Description of an enumeration value.

enumValue: PossibleEnumValue¶

class archicad.releases.ac24.b2310types.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) – List of enumeration values.

description: str¶

group: PropertyGroup¶

name: str¶

possibleEnumValues: List[PossibleEnumValuesArrayItem] | None¶

class archicad.releases.ac24.b2310types.PropertyDefinitionOrError(propertyDefinition: PropertyDefinition | None = None, error: Error | None = None)¶

Bases: _ACUnionType

A property definition or error.

Variables:

propertyDefinition (PropertyDefinition, optional) – A property definition.
error (Error, optional) – Error details.

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

error: Error | None¶

propertyDefinition: PropertyDefinition | None¶

class archicad.releases.ac24.b2310types.PropertyDefinitionWrapper(propertyDefinition: PropertyDefinition)¶

Bases: _ACBaseType

Variables:: propertyDefinition (PropertyDefinition) – A property definition.

propertyDefinition: PropertyDefinition¶

class archicad.releases.ac24.b2310types.PropertyGroup(name: str)¶

Bases: _ACBaseType

A property group.

Variables:: name (str) – The property group name.

name: str¶

class archicad.releases.ac24.b2310types.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.ac24.b2310types.PropertyIdArrayItem(propertyId: PropertyId)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: propertyId (PropertyId) – The identifier of a property.

propertyId: PropertyId¶

class archicad.releases.ac24.b2310types.PropertyIdOrError(propertyId: PropertyId | None = None, error: Error | None = None)¶

Bases: _ACUnionType

A property identifier or error.

Variables:

propertyId (PropertyId, optional) – The identifier of a property.
error (Error, optional) – Error details.

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

error: Error | None¶

propertyId: PropertyId | None¶

class archicad.releases.ac24.b2310types.PropertyUserId(type: str, localizedName: List[str] | None = None, nonLocalizedName: str | None = None)¶

Bases: _ACUnionType

An object which uniquely identifies a Property by its name in human-readable form. May represent a User-Defined or a Built-In Property.

Variables:

type (str) – None
localizedName (list of str, optional) – List of the localized name parts: first element is the Group Name, second element is the Property Name of the Property.
nonLocalizedName (str, optional) – Non-localized name of the Built-In Property.

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

localizedName: List[str] | None¶

nonLocalizedName: str | None¶

type: str¶

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.; 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.ac24.b2310types.PropertyValueOrErrorItem(propertyValue: PropertyValue | None = None, error: Error | None = None)¶

Bases: _ACUnionType

Contains a property value or an error for the property.

Variables:

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

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

error: Error | None¶

propertyValue: PropertyValue | None¶

class archicad.releases.ac24.b2310types.PropertyValueWrapper(propertyValue: PropertyValue)¶

Bases: _ACBaseType

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

propertyValue: PropertyValue¶

class archicad.releases.ac24.b2310types.PropertyValuesOrErrorForElement(propertyValues: List[PropertyValueOrErrorItem] | None = None, error: Error | None = None)¶

Bases: _ACUnionType

Contains either a list of property values or an error for the element

Variables:

propertyValues (list of PropertyValueOrErrorItem, optional) – List of property values for an element.
error (Error, optional) – Error details.

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

error: Error | None¶

propertyValues: List[PropertyValueOrErrorItem] | None¶

class archicad.releases.ac24.b2310types.PropertyValuesWrapper(propertyValues: List[PropertyValueOrErrorItem])¶

Bases: _ACBaseType

Variables:: propertyValues (list of PropertyValueOrErrorItem) – List of property values for an element.

propertyValues: List[PropertyValueOrErrorItem]¶

class archicad.releases.ac24.b2310types.PublisherSetId(name: str, type: str = 'PublisherSets')¶

Bases: _ACBaseType

The identifier of a publisher set.

Variables:

name (str) – Name of the publisher set.
type (str) – Type of the navigator item tree.

name: str¶

type: str¶

class archicad.releases.ac24.b2310types.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

Provides a way to assign IDs to the layouts contained in the subset.

Variables:

name (str) – Defines the name for the layout subset.
includeToIDSequence (bool) – Indicates whether this subset is included in or excluded from automatic ID assignment.
customNumbering (bool) – Defines whether the IDs are generated automatically or use a custom numbering.
continueNumbering (bool) – Continue using the ID assignment of upper levels. 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 are only using the Subset as a logical grouping which has no effect on IDs.
useUpperPrefix (bool) – Use the prefix and ID of upper levels. Layouts in this subset will be assigned IDs based on the previous layout in the layout book structure.
addOwnPrefix (bool) – Adds own prefix to the subset.
customNumber (str) – Specifies the custom subset ID.
autoNumber (str) – Specifies the automatic subset ID.
numberingStyle (str) – List of the supported numbering styles.
startAt (int) – Specifies a number from which the numbering starts.
ownPrefix (str) – Defines a 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.ac24.b2310types.SuccessfulExecutionResult(success: bool)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: success (bool) – EMPTY STRING

success: bool¶

class archicad.releases.ac24.b2310types.Types¶

Bases: object

class BoundingBox2D(xMin: float, yMin: float, xMax: float, yMax: float)¶

Bases: _ACBaseType

2D bounding box of an element.

Variables:

xMin (float) – Minimum X value of bounding box.
yMin (float) – Minimum Y value of bounding box.
xMax (float) – Maximum X value of bounding box.
yMax (float) – Maximum Y value of 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 error.

Variables:

boundingBox2D (BoundingBox2D, optional) – 2D bounding box of an element.
error (Error, optional) – Error details.

boundingBox2D: BoundingBox2D | None¶

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

error: Error | None¶

class BoundingBox2DWrapper(boundingBox2D: BoundingBox2D)¶

Bases: _ACBaseType

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

boundingBox2D: BoundingBox2D¶

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

Bases: _ACBaseType

3D bounding box of an element.

Variables:

xMin (float) – Minimum X value of bounding box.
yMin (float) – Minimum Y value of bounding box.
zMin (float) – Minimum Z value of bounding box.
xMax (float) – Maximum X value of bounding box.
yMax (float) – Maximum Y value of bounding box.
zMax (float) – Maximum Z value of 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 error.

Variables:

boundingBox3D (BoundingBox3D, optional) – 3D bounding box of an element.
error (Error, optional) – Error details.

boundingBox3D: BoundingBox3D | None¶

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

error: Error | None¶

class BoundingBox3DWrapper(boundingBox3D: BoundingBox3D)¶

Bases: _ACBaseType

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

boundingBox3D: BoundingBox3D¶

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

Bases: _ACBaseType

An object which uniquely identifies a Built-In Property by its name in a human-readable form.

Variables:

nonLocalizedName (str) – 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) – Error details.

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) – The list of element classification identifiers or errors.

classificationIds: List[ClassificationIdOrError]¶

class ClassificationItemArrayItem(classificationItem: ClassificationItemInTree_)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: classificationItem (ClassificationItemInTree_) – Details of a classification item.

classificationItem: ClassificationItemInTree_¶

class ClassificationItemDetails(id: str, name: str, description: str)¶

Bases: _ACBaseType

Details of a classification item.

Variables:

id (str) – The user specified unique identifier of the classification item.
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) – 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

Details of a classification item.

Variables:

classificationItemId (ClassificationItemId) – The identifier of a classification item.
id (str) – The user specified unique identifier of the classification item.
name (str) – The display name of the classification item.
description (str) – The description of the classification item.
children (list of ClassificationItemArrayItem, optional) – The 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) – Details of a classification item.
error (Error, optional) – Error details.

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

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

Element classification.

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

Variables:

classificationIds (list of ClassificationIdOrError, optional) – The list of element classification identifiers or errors.
error (Error, optional) – Error details.

classificationIds: List[ClassificationIdOrError] | None¶

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

error: Error | None¶

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 identifier of the property and the 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

List of elements or error.

Variables:

elements (list of ElementIdArrayItem, optional) – List of the elements.
error (Error, optional) – Error details.

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

elements: List[ElementIdArrayItem] | None¶

error: Error | None¶

class ElementsWrapper(elements: List[ElementIdArrayItem])¶

Bases: _ACBaseType

List of elements.

Variables:: elements (list of ElementIdArrayItem) – List of the elements.

elements: List[ElementIdArrayItem]¶

EnumValueId¶: alias of DisplayValueEnumId

class EnumValueIdWrapper(enumValueId: DisplayValueEnumId)¶

Bases: _ACBaseType

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

enumValueId: EnumValueId¶

class Error(code: int, message: str)¶

Bases: _ACBaseType

Error details.

Variables:

code (int) – The error code.
message (str) – The error message.

code: int¶

message: str¶

class ErrorItem(error: Error)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: error (Error) – Error details.

error: Error¶

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

Bases: _ACUnionType

The result of the execution for one case.

Variables:

success (bool) – None
error (Error, optional) – Error details.

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) – Error details.

error: Error¶

success: bool¶

class FolderParameters(name: str)¶

Bases: _ACBaseType

The parameters of a folder.

Variables:: name (str) – The name of the folder to create.

name: str¶

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) – Horizontal size of the layout in millimeters.
verticalSize (float) – Vertical size of the layout in millimeters.
leftMargin (float) – Layout margin from the left side of the paper.
topMargin (float) – Layout margin from the top side of the paper.
rightMargin (float) – Layout margin from the right side of the paper.
bottomMargin (float) – Layout margin from the bottom side of the paper.
customLayoutNumber (str) – Specifies the custom ID.
customLayoutNumbering (bool) – Defines whether a unique ID is used for the current layout or not.
doNotIncludeInNumbering (bool) – Indicates whether this layout is included in or excluded from automatic ID assignment.
displayMasterLayoutBelow (bool) – Display the master layout above or below the layout.
layoutPageNumber (int) – 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) – ID of the current document revision of the layout.
currentFinalRevisionId (str) – ID with optional suffix of the current document revision of the layout.
hasIssuedRevision (bool) – One or more issued document revisions have already been created for the layout.
hasActualRevision (bool) – An open document revision exists for the layout.

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 NavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str, type: str, sourceNavigatorItemId: NavigatorItemId | None = None, children: List[NavigatorItemArrayItem] | None = None)¶

Bases: _ACBaseType

Details of a navigator item.

Variables:

navigatorItemId (NavigatorItemId) – The identifier of a navigator item.
prefix (str) – Prefix of the name of the navigator item.
name (str) – Name of the navigator item.
type (str) – Possible types of a navigator item. Most of the names are self-explanatory, the only exception is ‘UndefinedItem’, which means that the type of this navigator item cannot be retrieved from Archicad yet.
sourceNavigatorItemId (NavigatorItemId, optional) – The identifier of a navigator item.
children (list of NavigatorItemArrayItem, optional) – 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_) – 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) – 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) – Type of the navigator item tree.
name (str, optional) – Name of the publisher set.

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

name: str | None¶

type: str¶

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

Bases: _ACBaseType

A angle list property value containing angles in an array. 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. 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

A area list property value containing areas in an array. 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. 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. 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. 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) – 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¶

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.; 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: DisplayValueEnumId, 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. 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. 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) – Type of the navigator item tree.

type: str¶

class PossibleEnumValue(enumValueId: DisplayValueEnumId, displayValue: str)¶

Bases: _ACBaseType

Description of an enumeration value.

Variables:

enumValueId (EnumValueId) – The identifier of a property enumeration value.
displayValue (str) – Displayed value of the enumeration.

displayValue: str¶

enumValueId: EnumValueId¶

class PossibleEnumValuesArrayItem(enumValue: PossibleEnumValue)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: enumValue (PossibleEnumValue) – Description of an enumeration value.

enumValue: PossibleEnumValue¶

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

Variables:

propertyDefinition (PropertyDefinition, optional) – A property definition.
error (Error, optional) – Error details.

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

Variables:

propertyId (PropertyId, optional) – The identifier of a property.
error (Error, optional) – Error details.

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

An object which uniquely identifies a Property by its name in human-readable form. May represent a User-Defined or a Built-In Property.

Variables:

type (str) – None
localizedName (list of str, optional) – List of the localized name parts: first element is the Group Name, second element is the Property Name of the Property.
nonLocalizedName (str, optional) – Non-localized name of the Built-In Property.

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

localizedName: List[str] | None¶

nonLocalizedName: str | None¶

type: str¶

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

Contains a property value or an error for the property.

Variables:

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

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 PropertyValuesOrErrorForElement(propertyValues: List[PropertyValueOrErrorItem] | None = None, error: Error | None = None)¶

Bases: _ACUnionType

Contains either a list of property values or an error for the element

Variables:

propertyValues (list of PropertyValueOrErrorItem, optional) – List of property values for an element.
error (Error, optional) – Error details.

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) – List of property values for an element.

propertyValues: List[PropertyValueOrErrorItem]¶

class PublisherSetId(name: str, type: str = 'PublisherSets')¶

Bases: _ACBaseType

The identifier of a publisher set.

Variables:

name (str) – Name of the publisher set.
type (str) – Type of the navigator item tree.

name: str¶

type: str¶

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

Provides a way to assign IDs to the layouts contained in the subset.

Variables:

name (str) – Defines the name for the layout subset.
includeToIDSequence (bool) – Indicates whether this subset is included in or excluded from automatic ID assignment.
customNumbering (bool) – Defines whether the IDs are generated automatically or use a custom numbering.
continueNumbering (bool) – Continue using the ID assignment of upper levels. 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 are only using the Subset as a logical grouping which has no effect on IDs.
useUpperPrefix (bool) – Use the prefix and ID of upper levels. Layouts in this subset will be assigned IDs based on the previous layout in the layout book structure.
addOwnPrefix (bool) – Adds own prefix to the subset.
customNumber (str) – Specifies the custom subset ID.
autoNumber (str) – Specifies the automatic subset ID.
numberingStyle (str) – List of the supported numbering styles.
startAt (int) – Specifies a number from which the numbering starts.
ownPrefix (str) – Defines a 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 UserDefinedPropertyUserId(localizedName: List[str], type: str = 'UserDefined')¶

Bases: _ACBaseType

An object which uniquely identifies a User-Defined Property by its name in human-readable form.

Variables:

localizedName (list of str) – List of the localized name parts: first element is the Group Name, second element is the Property 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 archicad.releases.ac24.b2310types.UserDefinedPropertyUserId(localizedName: List[str], type: str = 'UserDefined')¶

Bases: _ACBaseType

An object which uniquely identifies a User-Defined Property by its name in human-readable form.

Variables:

localizedName (list of str) – List of the localized name parts: first element is the Group Name, second element is the Property Name of the Property.
type (str) – EMPTY STRING

localizedName: List[str]¶

type: str¶

class archicad.releases.ac24.b2310types.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¶

archicad.releases.ac24.b2310utilities module¶

class archicad.releases.ac24.b2310utilities.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.

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.

GetUserDefinedPropertyId(groupName: str, name: str) → PropertyId¶: Returns the PropertyId of the corresponding user-defined property.

static OpenFile(filepath: str)¶: Opens the given file with the default application.

archicad.releases.ac24.b3000commands module¶

Graphisoft

class archicad.releases.ac24.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) – Provides a way 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) – List of navigator item identifiers.
Returns:: Execution result for each input case.
Return type:: list of ExecutionResult

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 Element Information.

Parameters:: elements (list of ElementIdArrayItem) – List of the elements.
Returns:: List of element’s 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 Element Information.

Parameters:: elements (list of ElementIdArrayItem) – List of the elements.
Returns:: List of element’s 3D bounding boxes
Return type:: list of BoundingBox3DOrError

GetAllClassificationSystems() → List[ClassificationSystem]¶

Returns the list of available classification systems.

Returns:: The 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:: The list of classification items.
Return type:: list of ClassificationItemArrayItem

GetAllElements() → List[ElementIdArrayItem]¶

Returns the identifier of every element in the current plan.

Returns:: List of the elements.
Return type:: list of ElementIdArrayItem

GetAllPropertyNames() → List[PropertyUserId]¶

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

Returns:: List of PropertyUserId objects.
Return type:: list of PropertyUserId

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) – List of the elements.
classificationSystemIds (list of ClassificationSystemIdArrayItem) – The list of classification system identifiers.

Returns:

The list of element classification identifiers or errors.

Return type:

list of ElementClassificationOrError

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

Returns the details of classification items.

Parameters:: classificationItemIds (list of ClassificationItemIdArrayItem) – The list of classification item identifiers.
Returns:: The 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) – The list of property identifiers.
Returns:: The 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:: List of the 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:: List of the 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) – List of the elements.
elementTypes (list of str, optional) – List of element types.

Returns:

List of elements or error.

Return type:

list of ElementsOrError

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

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

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

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

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

Parameters:: properties (list of PropertyUserId) – List of PropertyUserId objects.
Returns:: The list of property identifiers or errors.
Return type:: list of PropertyIdOrError

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) – List of the elements.
properties (list of PropertyIdArrayItem) – The list of property identifiers.

Returns:

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

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 parentNavigatorItemId in the navigator tree. If previousNavigatorItemId 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) – The list of element classification identifiers.
Returns:: Execution result for each input case.
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) – List of element property values.
Returns:: Execution result for each input case.
Return type:: list of ExecutionResult

exception archicad.releases.ac24.b3000commands.UnsucceededCommandCall¶: Bases: Exception

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

archicad.releases.ac24.b3000types module¶

Graphisoft

class archicad.releases.ac24.b3000types.BoundingBox2D(xMin: float, yMin: float, xMax: float, yMax: float)¶

Bases: _ACBaseType

2D bounding box of an element.

Variables:

xMin (float) – Minimum X value of bounding box.
yMin (float) – Minimum Y value of bounding box.
xMax (float) – Maximum X value of bounding box.
yMax (float) – Maximum Y value of bounding box.

xMax: float¶

xMin: float¶

yMax: float¶

yMin: float¶

class archicad.releases.ac24.b3000types.BoundingBox2DOrError(boundingBox2D: BoundingBox2D | None = None, error: Error | None = None)¶

Bases: _ACUnionType

A 2D bounding box or error.

Variables:

boundingBox2D (BoundingBox2D, optional) – 2D bounding box of an element.
error (Error, optional) – Error details.

boundingBox2D: BoundingBox2D | None¶

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

error: Error | None¶

class archicad.releases.ac24.b3000types.BoundingBox2DWrapper(boundingBox2D: BoundingBox2D)¶

Bases: _ACBaseType

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

boundingBox2D: BoundingBox2D¶

class archicad.releases.ac24.b3000types.BoundingBox3D(xMin: float, yMin: float, zMin: float, xMax: float, yMax: float, zMax: float)¶

Bases: _ACBaseType

3D bounding box of an element.

Variables:

xMin (float) – Minimum X value of bounding box.
yMin (float) – Minimum Y value of bounding box.
zMin (float) – Minimum Z value of bounding box.
xMax (float) – Maximum X value of bounding box.
yMax (float) – Maximum Y value of bounding box.
zMax (float) – Maximum Z value of bounding box.

xMax: float¶

xMin: float¶

yMax: float¶

yMin: float¶

zMax: float¶

zMin: float¶

class archicad.releases.ac24.b3000types.BoundingBox3DOrError(boundingBox3D: BoundingBox3D | None = None, error: Error | None = None)¶

Bases: _ACUnionType

A 3D bounding box or error.

Variables:

boundingBox3D (BoundingBox3D, optional) – 3D bounding box of an element.
error (Error, optional) – Error details.

boundingBox3D: BoundingBox3D | None¶

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

error: Error | None¶

class archicad.releases.ac24.b3000types.BoundingBox3DWrapper(boundingBox3D: BoundingBox3D)¶

Bases: _ACBaseType

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

boundingBox3D: BoundingBox3D¶

class archicad.releases.ac24.b3000types.BuiltInPropertyUserId(nonLocalizedName: str, type: str = 'BuiltIn')¶

Bases: _ACBaseType

An object which uniquely identifies a Built-In Property by its name in a human-readable form.

Variables:

nonLocalizedName (str) – Non-localized name of the Built-In Property.
type (str) – EMPTY STRING

nonLocalizedName: str¶

type: str¶

class archicad.releases.ac24.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.ac24.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) – Error details.

classificationId: ClassificationId | None¶

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

error: Error | None¶

class archicad.releases.ac24.b3000types.ClassificationIdWrapper(classificationId: ClassificationId)¶

Bases: _ACBaseType

Variables:: classificationId (ClassificationId) – The element classification identifier.

classificationId: ClassificationId¶

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

Bases: _ACBaseType

Variables:: classificationIds (list of ClassificationIdOrError) – The list of element classification identifiers or errors.

classificationIds: List[ClassificationIdOrError]¶

class archicad.releases.ac24.b3000types.ClassificationItemArrayItem(classificationItem: ClassificationItemInTree_)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: classificationItem (ClassificationItemInTree_) – Details of a classification item.

classificationItem: ClassificationItemInTree_¶

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

Bases: _ACBaseType

Details of a classification item.

Variables:

id (str) – The user specified unique identifier of the classification item.
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.ac24.b3000types.ClassificationItemDetailsWrapper(classificationItem: ClassificationItemDetails)¶

Bases: _ACBaseType

Variables:: classificationItem (ClassificationItemDetails) – Details of a classification item.

classificationItem: ClassificationItemDetails¶

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

Bases: _ACBaseType

EMPTY STRING

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

classificationItemId: ClassificationItemId¶

class archicad.releases.ac24.b3000types.ClassificationItemInTree(classificationItemId: ClassificationItemId, id: str, name: str, description: str, children: List[ClassificationItemArrayItem] | None = None)¶

Bases: _ACBaseType

Details of a classification item.

Variables:

classificationItemId (ClassificationItemId) – The identifier of a classification item.
id (str) – The user specified unique identifier of the classification item.
name (str) – The display name of the classification item.
description (str) – The description of the classification item.
children (list of ClassificationItemArrayItem, optional) – The list of classification items.

children: List[ClassificationItemArrayItem] | None¶

classificationItemId: ClassificationItemId¶

description: str¶

id: str¶

name: str¶

archicad.releases.ac24.b3000types.ClassificationItemInTree_¶: alias of ClassificationItemInTree

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

Bases: _ACUnionType

EMPTY STRING

Variables:

classificationItem (ClassificationItemDetails, optional) – Details of a classification item.
error (Error, optional) – Error details.

classificationItem: ClassificationItemDetails | None¶

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

error: Error | None¶

class archicad.releases.ac24.b3000types.ClassificationSystem(classificationSystemId: ClassificationSystemId, name: str, description: str, source: str, version: str, date: str)¶

Bases: _ACBaseType

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 string 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.ac24.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.ac24.b3000types.ClassificationSystemIdArrayItem(classificationSystemId: ClassificationSystemId)¶

Bases: _ACBaseType

EMPTY STRING

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

classificationSystemId: ClassificationSystemId¶

class archicad.releases.ac24.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.ac24.b3000types.ElementClassification(elementId: ElementId, classificationId: ClassificationId)¶

Bases: _ACBaseType

Element classification.

Variables:

elementId (ElementId) – The identifier of an element.
classificationId (ClassificationId) – The element classification identifier.

classificationId: ClassificationId¶

elementId: ElementId¶

class archicad.releases.ac24.b3000types.ElementClassificationOrError(classificationIds: List[ClassificationIdOrError] | None = None, error: Error | None = None)¶

Bases: _ACUnionType

Element classification identifiers or error.

Variables:

classificationIds (list of ClassificationIdOrError, optional) – The list of element classification identifiers or errors.
error (Error, optional) – Error details.

classificationIds: List[ClassificationIdOrError] | None¶

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

error: Error | None¶

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

Bases: _ACBaseType

EMPTY STRING

Variables:: elementId (ElementId) – The identifier of an element.

elementId: ElementId¶

class archicad.releases.ac24.b3000types.ElementPropertyValue(elementId: ElementId, propertyId: PropertyId, propertyValue: NormalOrUserUndefinedPropertyValue)¶

Bases: _ACBaseType

A property value with the identifier of the property and the 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.ac24.b3000types.ElementsOrError(elements: List[ElementIdArrayItem] | None = None, error: Error | None = None)¶

Bases: _ACUnionType

List of elements or error.

Variables:

elements (list of ElementIdArrayItem, optional) – List of the elements.
error (Error, optional) – Error details.

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

elements: List[ElementIdArrayItem] | None¶

error: Error | None¶

class archicad.releases.ac24.b3000types.ElementsWrapper(elements: List[ElementIdArrayItem])¶

Bases: _ACBaseType

List of elements.

Variables:: elements (list of ElementIdArrayItem) – List of the elements.

elements: List[ElementIdArrayItem]¶

archicad.releases.ac24.b3000types.EnumValueId¶: The identifier of a property enumeration value.

class archicad.releases.ac24.b3000types.EnumValueIdWrapper(enumValueId: DisplayValueEnumId)¶

Bases: _ACBaseType

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

enumValueId: EnumValueId¶

class archicad.releases.ac24.b3000types.Error(code: int, message: str)¶

Bases: _ACBaseType

Error details.

Variables:

code (int) – The error code.
message (str) – The error message.

code: int¶

message: str¶

class archicad.releases.ac24.b3000types.ErrorItem(error: Error)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: error (Error) – Error details.

error: Error¶

class archicad.releases.ac24.b3000types.ExecutionResult(success: bool, error: Error | None = None)¶

Bases: _ACUnionType

The result of the execution for one case.

Variables:

success (bool) – None
error (Error, optional) – Error details.

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

error: Error | None¶

success: bool¶

class archicad.releases.ac24.b3000types.FailedExecutionResult(success: bool, error: Error)¶

Bases: _ACBaseType

EMPTY STRING

Variables:

success (bool) – EMPTY STRING
error (Error) – Error details.

error: Error¶

success: bool¶

class archicad.releases.ac24.b3000types.FolderParameters(name: str)¶

Bases: _ACBaseType

The parameters of a folder.

Variables:: name (str) – The name of the folder to create.

name: str¶

class archicad.releases.ac24.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) – Horizontal size of the layout in millimeters.
verticalSize (float) – Vertical size of the layout in millimeters.
leftMargin (float) – Layout margin from the left side of the paper.
topMargin (float) – Layout margin from the top side of the paper.
rightMargin (float) – Layout margin from the right side of the paper.
bottomMargin (float) – Layout margin from the bottom side of the paper.
customLayoutNumber (str) – Specifies the custom ID.
customLayoutNumbering (bool) – Defines whether a unique ID is used for the current layout or not.
doNotIncludeInNumbering (bool) – Indicates whether this layout is included in or excluded from automatic ID assignment.
displayMasterLayoutBelow (bool) – Display the master layout above or below the layout.
layoutPageNumber (int) – 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) – ID of the current document revision of the layout.
currentFinalRevisionId (str) – ID with optional suffix of the current document revision of the layout.
hasIssuedRevision (bool) – One or more issued document revisions have already been created for the layout.
hasActualRevision (bool) – An open document revision exists for the layout.

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.ac24.b3000types.NavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str, type: str, sourceNavigatorItemId: NavigatorItemId | None = None, children: List[NavigatorItemArrayItem] | None = None)¶

Bases: _ACBaseType

Details of a navigator item.

Variables:

navigatorItemId (NavigatorItemId) – The identifier of a navigator item.
prefix (str) – Prefix of the name of the navigator item.
name (str) – Name of the navigator item.
type (str) – Possible types of a navigator item. Most of the names are self-explanatory, the only exception is ‘UndefinedItem’, which means that the type of this navigator item cannot be retrieved from Archicad yet.
sourceNavigatorItemId (NavigatorItemId, optional) – The identifier of a navigator item.
children (list of NavigatorItemArrayItem, optional) – List of navigator items.

children: List[NavigatorItemArrayItem] | None¶

name: str¶

navigatorItemId: NavigatorItemId¶

prefix: str¶

sourceNavigatorItemId: NavigatorItemId | None¶

type: str¶

class archicad.releases.ac24.b3000types.NavigatorItemArrayItem(navigatorItem: NavigatorItem_)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: navigatorItem (NavigatorItem_) – Details of a navigator item.

navigatorItem: NavigatorItem_¶

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

Bases: _ACBaseType

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

navigatorItemId: NavigatorItemId¶

archicad.releases.ac24.b3000types.NavigatorItem_¶: alias of NavigatorItem

class archicad.releases.ac24.b3000types.NavigatorTree(rootItem: NavigatorItem)¶

Bases: _ACBaseType

A tree of navigator items.

Variables:: rootItem (NavigatorItem) – Details of a navigator item.

rootItem: NavigatorItem¶

class archicad.releases.ac24.b3000types.NavigatorTreeId(type: str, name: str | None = None)¶

Bases: _ACUnionType

The identifier of a navigator item tree.

Variables:

type (str) – Type of the navigator item tree.
name (str, optional) – Name of the publisher set.

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

name: str | None¶

type: str¶

class archicad.releases.ac24.b3000types.NormalAngleListPropertyValue(value: List[float], type: str = 'angleList', status: str = 'normal')¶

Bases: _ACBaseType

A angle list property value containing angles in an array. 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.ac24.b3000types.NormalAnglePropertyValue(value: float, type: str = 'angle', status: str = 'normal')¶

Bases: _ACBaseType

An angle property value containing a real angle. 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.ac24.b3000types.NormalAreaListPropertyValue(value: List[float], type: str = 'areaList', status: str = 'normal')¶

Bases: _ACBaseType

A area list property value containing areas in an array. 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.ac24.b3000types.NormalAreaPropertyValue(value: float, type: str = 'area', status: str = 'normal')¶

Bases: _ACBaseType

An area property value containing a real area. 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.ac24.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.ac24.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.ac24.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.ac24.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.ac24.b3000types.NormalLengthListPropertyValue(value: List[float], type: str = 'lengthList', status: str = 'normal')¶

Bases: _ACBaseType

A length list property value containing length values in an array. 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.ac24.b3000types.NormalLengthPropertyValue(value: float, type: str = 'length', status: str = 'normal')¶

Bases: _ACBaseType

A length property value containing a real length value. 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.ac24.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) – List of enumeration identifiers.
type (str) – EMPTY STRING
status (str) – EMPTY STRING

status: str¶

type: str¶

value: List[EnumValueIdWrapper]¶

class archicad.releases.ac24.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.ac24.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¶

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.; 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.ac24.b3000types.NormalSingleEnumPropertyValue(value: DisplayValueEnumId, 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.ac24.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.ac24.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.ac24.b3000types.NormalVolumeListPropertyValue(value: List[float], type: str = 'volumeList', status: str = 'normal')¶

Bases: _ACBaseType

A volume list property value containing volumes in an array. 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.ac24.b3000types.NormalVolumePropertyValue(value: float, type: str = 'volume', status: str = 'normal')¶

Bases: _ACBaseType

A volume property value containing a real volume. 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.ac24.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.ac24.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.ac24.b3000types.OtherNavigatorTreeId(type: str)¶

Bases: _ACBaseType

The identifier of a navigator item tree.

Variables:: type (str) – Type of the navigator item tree.

type: str¶

class archicad.releases.ac24.b3000types.PossibleEnumValue(enumValueId: DisplayValueEnumId, displayValue: str)¶

Bases: _ACBaseType

Description of an enumeration value.

Variables:

enumValueId (EnumValueId) – The identifier of a property enumeration value.
displayValue (str) – Displayed value of the enumeration.

displayValue: str¶

enumValueId: EnumValueId¶

class archicad.releases.ac24.b3000types.PossibleEnumValuesArrayItem(enumValue: PossibleEnumValue)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: enumValue (PossibleEnumValue) – Description of an enumeration value.

enumValue: PossibleEnumValue¶

class archicad.releases.ac24.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) – List of enumeration values.

description: str¶

group: PropertyGroup¶

name: str¶

possibleEnumValues: List[PossibleEnumValuesArrayItem] | None¶

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

Bases: _ACUnionType

A property definition or error.

Variables:

propertyDefinition (PropertyDefinition, optional) – A property definition.
error (Error, optional) – Error details.

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

error: Error | None¶

propertyDefinition: PropertyDefinition | None¶

class archicad.releases.ac24.b3000types.PropertyDefinitionWrapper(propertyDefinition: PropertyDefinition)¶

Bases: _ACBaseType

Variables:: propertyDefinition (PropertyDefinition) – A property definition.

propertyDefinition: PropertyDefinition¶

class archicad.releases.ac24.b3000types.PropertyGroup(name: str)¶

Bases: _ACBaseType

A property group.

Variables:: name (str) – The property group name.

name: str¶

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

Bases: _ACBaseType

EMPTY STRING

Variables:: propertyId (PropertyId) – The identifier of a property.

propertyId: PropertyId¶

class archicad.releases.ac24.b3000types.PropertyIdOrError(propertyId: PropertyId | None = None, error: Error | None = None)¶

Bases: _ACUnionType

A property identifier or error.

Variables:

propertyId (PropertyId, optional) – The identifier of a property.
error (Error, optional) – Error details.

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

error: Error | None¶

propertyId: PropertyId | None¶

class archicad.releases.ac24.b3000types.PropertyUserId(type: str, localizedName: List[str] | None = None, nonLocalizedName: str | None = None)¶

Bases: _ACUnionType

An object which uniquely identifies a Property by its name in human-readable form. May represent a User-Defined or a Built-In Property.

Variables:

type (str) – None
localizedName (list of str, optional) – List of the localized name parts: first element is the Group Name, second element is the Property Name of the Property.
nonLocalizedName (str, optional) – Non-localized name of the Built-In Property.

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

localizedName: List[str] | None¶

nonLocalizedName: str | None¶

type: str¶

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.; 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.ac24.b3000types.PropertyValueOrErrorItem(propertyValue: PropertyValue | None = None, error: Error | None = None)¶

Bases: _ACUnionType

Contains a property value or an error for the property.

Variables:

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

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

error: Error | None¶

propertyValue: PropertyValue | None¶

class archicad.releases.ac24.b3000types.PropertyValueWrapper(propertyValue: PropertyValue)¶

Bases: _ACBaseType

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

propertyValue: PropertyValue¶

class archicad.releases.ac24.b3000types.PropertyValuesOrError(propertyValues: List[PropertyValueOrErrorItem] | None = None, error: Error | None = None)¶

Bases: _ACUnionType

Contains either a list of property values or an error.

Variables:

propertyValues (list of PropertyValueOrErrorItem, optional) – List of property values.
error (Error, optional) – Error details.

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

error: Error | None¶

propertyValues: List[PropertyValueOrErrorItem] | None¶

class archicad.releases.ac24.b3000types.PropertyValuesWrapper(propertyValues: List[PropertyValueOrErrorItem])¶

Bases: _ACBaseType

Variables:: propertyValues (list of PropertyValueOrErrorItem) – List of property values.

propertyValues: List[PropertyValueOrErrorItem]¶

class archicad.releases.ac24.b3000types.PublisherSetId(name: str, type: str = 'PublisherSets')¶

Bases: _ACBaseType

The identifier of a publisher set.

Variables:

name (str) – Name of the publisher set.
type (str) – Type of the navigator item tree.

name: str¶

type: str¶

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

Provides a way to assign IDs to the layouts contained in the subset.

Variables:

name (str) – Defines the name for the layout subset.
includeToIDSequence (bool) – Indicates whether this subset is included in or excluded from automatic ID assignment.
customNumbering (bool) – Defines whether the IDs are generated automatically or use a custom numbering.
continueNumbering (bool) – Continue using the ID assignment of upper levels. 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 are only using the Subset as a logical grouping which has no effect on IDs.
useUpperPrefix (bool) – Use the prefix and ID of upper levels. Layouts in this subset will be assigned IDs based on the previous layout in the layout book structure.
addOwnPrefix (bool) – Adds own prefix to the subset.
customNumber (str) – Specifies the custom subset ID.
autoNumber (str) – Specifies the automatic subset ID.
numberingStyle (str) – List of the supported numbering styles.
startAt (int) – Specifies a number from which the numbering starts.
ownPrefix (str) – Defines a 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.ac24.b3000types.SuccessfulExecutionResult(success: bool)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: success (bool) – EMPTY STRING

success: bool¶

class archicad.releases.ac24.b3000types.Types¶

Bases: object

class BoundingBox2D(xMin: float, yMin: float, xMax: float, yMax: float)¶

Bases: _ACBaseType

2D bounding box of an element.

Variables:

xMin (float) – Minimum X value of bounding box.
yMin (float) – Minimum Y value of bounding box.
xMax (float) – Maximum X value of bounding box.
yMax (float) – Maximum Y value of 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 error.

Variables:

boundingBox2D (BoundingBox2D, optional) – 2D bounding box of an element.
error (Error, optional) – Error details.

boundingBox2D: BoundingBox2D | None¶

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

error: Error | None¶

class BoundingBox2DWrapper(boundingBox2D: BoundingBox2D)¶

Bases: _ACBaseType

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

boundingBox2D: BoundingBox2D¶

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

Bases: _ACBaseType

3D bounding box of an element.

Variables:

xMin (float) – Minimum X value of bounding box.
yMin (float) – Minimum Y value of bounding box.
zMin (float) – Minimum Z value of bounding box.
xMax (float) – Maximum X value of bounding box.
yMax (float) – Maximum Y value of bounding box.
zMax (float) – Maximum Z value of 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 error.

Variables:

boundingBox3D (BoundingBox3D, optional) – 3D bounding box of an element.
error (Error, optional) – Error details.

boundingBox3D: BoundingBox3D | None¶

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

error: Error | None¶

class BoundingBox3DWrapper(boundingBox3D: BoundingBox3D)¶

Bases: _ACBaseType

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

boundingBox3D: BoundingBox3D¶

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

Bases: _ACBaseType

An object which uniquely identifies a Built-In Property by its name in a human-readable form.

Variables:

nonLocalizedName (str) – 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) – Error details.

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) – The list of element classification identifiers or errors.

classificationIds: List[ClassificationIdOrError]¶

class ClassificationItemArrayItem(classificationItem: ClassificationItemInTree_)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: classificationItem (ClassificationItemInTree_) – Details of a classification item.

classificationItem: ClassificationItemInTree_¶

class ClassificationItemDetails(id: str, name: str, description: str)¶

Bases: _ACBaseType

Details of a classification item.

Variables:

id (str) – The user specified unique identifier of the classification item.
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) – 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

Details of a classification item.

Variables:

classificationItemId (ClassificationItemId) – The identifier of a classification item.
id (str) – The user specified unique identifier of the classification item.
name (str) – The display name of the classification item.
description (str) – The description of the classification item.
children (list of ClassificationItemArrayItem, optional) – The 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) – Details of a classification item.
error (Error, optional) – Error details.

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

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

Element classification.

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

Variables:

classificationIds (list of ClassificationIdOrError, optional) – The list of element classification identifiers or errors.
error (Error, optional) – Error details.

classificationIds: List[ClassificationIdOrError] | None¶

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

error: Error | None¶

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 identifier of the property and the 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

List of elements or error.

Variables:

elements (list of ElementIdArrayItem, optional) – List of the elements.
error (Error, optional) – Error details.

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

elements: List[ElementIdArrayItem] | None¶

error: Error | None¶

class ElementsWrapper(elements: List[ElementIdArrayItem])¶

Bases: _ACBaseType

List of elements.

Variables:: elements (list of ElementIdArrayItem) – List of the elements.

elements: List[ElementIdArrayItem]¶

EnumValueId¶: alias of DisplayValueEnumId

class EnumValueIdWrapper(enumValueId: DisplayValueEnumId)¶

Bases: _ACBaseType

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

enumValueId: EnumValueId¶

class Error(code: int, message: str)¶

Bases: _ACBaseType

Error details.

Variables:

code (int) – The error code.
message (str) – The error message.

code: int¶

message: str¶

class ErrorItem(error: Error)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: error (Error) – Error details.

error: Error¶

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

Bases: _ACUnionType

The result of the execution for one case.

Variables:

success (bool) – None
error (Error, optional) – Error details.

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) – Error details.

error: Error¶

success: bool¶

class FolderParameters(name: str)¶

Bases: _ACBaseType

The parameters of a folder.

Variables:: name (str) – The name of the folder to create.

name: str¶

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) – Horizontal size of the layout in millimeters.
verticalSize (float) – Vertical size of the layout in millimeters.
leftMargin (float) – Layout margin from the left side of the paper.
topMargin (float) – Layout margin from the top side of the paper.
rightMargin (float) – Layout margin from the right side of the paper.
bottomMargin (float) – Layout margin from the bottom side of the paper.
customLayoutNumber (str) – Specifies the custom ID.
customLayoutNumbering (bool) – Defines whether a unique ID is used for the current layout or not.
doNotIncludeInNumbering (bool) – Indicates whether this layout is included in or excluded from automatic ID assignment.
displayMasterLayoutBelow (bool) – Display the master layout above or below the layout.
layoutPageNumber (int) – 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) – ID of the current document revision of the layout.
currentFinalRevisionId (str) – ID with optional suffix of the current document revision of the layout.
hasIssuedRevision (bool) – One or more issued document revisions have already been created for the layout.
hasActualRevision (bool) – An open document revision exists for the layout.

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 NavigatorItem(navigatorItemId: NavigatorItemId, prefix: str, name: str, type: str, sourceNavigatorItemId: NavigatorItemId | None = None, children: List[NavigatorItemArrayItem] | None = None)¶

Bases: _ACBaseType

Details of a navigator item.

Variables:

navigatorItemId (NavigatorItemId) – The identifier of a navigator item.
prefix (str) – Prefix of the name of the navigator item.
name (str) – Name of the navigator item.
type (str) – Possible types of a navigator item. Most of the names are self-explanatory, the only exception is ‘UndefinedItem’, which means that the type of this navigator item cannot be retrieved from Archicad yet.
sourceNavigatorItemId (NavigatorItemId, optional) – The identifier of a navigator item.
children (list of NavigatorItemArrayItem, optional) – 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_) – 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) – 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) – Type of the navigator item tree.
name (str, optional) – Name of the publisher set.

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

name: str | None¶

type: str¶

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

Bases: _ACBaseType

A angle list property value containing angles in an array. 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. 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

A area list property value containing areas in an array. 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. 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. 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. 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) – 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¶

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.; 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: DisplayValueEnumId, 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. 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. 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) – Type of the navigator item tree.

type: str¶

class PossibleEnumValue(enumValueId: DisplayValueEnumId, displayValue: str)¶

Bases: _ACBaseType

Description of an enumeration value.

Variables:

enumValueId (EnumValueId) – The identifier of a property enumeration value.
displayValue (str) – Displayed value of the enumeration.

displayValue: str¶

enumValueId: EnumValueId¶

class PossibleEnumValuesArrayItem(enumValue: PossibleEnumValue)¶

Bases: _ACBaseType

EMPTY STRING

Variables:: enumValue (PossibleEnumValue) – Description of an enumeration value.

enumValue: PossibleEnumValue¶

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

Variables:

propertyDefinition (PropertyDefinition, optional) – A property definition.
error (Error, optional) – Error details.

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

Variables:

propertyId (PropertyId, optional) – The identifier of a property.
error (Error, optional) – Error details.

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

An object which uniquely identifies a Property by its name in human-readable form. May represent a User-Defined or a Built-In Property.

Variables:

type (str) – None
localizedName (list of str, optional) – List of the localized name parts: first element is the Group Name, second element is the Property Name of the Property.
nonLocalizedName (str, optional) – Non-localized name of the Built-In Property.

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

localizedName: List[str] | None¶

nonLocalizedName: str | None¶

type: str¶

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

Contains a property value or an error for the property.

Variables:

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

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

Contains either a list of property values or an error.

Variables:

propertyValues (list of PropertyValueOrErrorItem, optional) – List of property values.
error (Error, optional) – Error details.

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) – 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) – Name of the publisher set.
type (str) – Type of the navigator item tree.

name: str¶

type: str¶

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

Provides a way to assign IDs to the layouts contained in the subset.

Variables:

name (str) – Defines the name for the layout subset.
includeToIDSequence (bool) – Indicates whether this subset is included in or excluded from automatic ID assignment.
customNumbering (bool) – Defines whether the IDs are generated automatically or use a custom numbering.
continueNumbering (bool) – Continue using the ID assignment of upper levels. 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 are only using the Subset as a logical grouping which has no effect on IDs.
useUpperPrefix (bool) – Use the prefix and ID of upper levels. Layouts in this subset will be assigned IDs based on the previous layout in the layout book structure.
addOwnPrefix (bool) – Adds own prefix to the subset.
customNumber (str) – Specifies the custom subset ID.
autoNumber (str) – Specifies the automatic subset ID.
numberingStyle (str) – List of the supported numbering styles.
startAt (int) – Specifies a number from which the numbering starts.
ownPrefix (str) – Defines a 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 UserDefinedPropertyUserId(localizedName: List[str], type: str = 'UserDefined')¶

Bases: _ACBaseType

An object which uniquely identifies a User-Defined Property by its name in human-readable form.

Variables:

localizedName (list of str) – List of the localized name parts: first element is the Group Name, second element is the Property 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 archicad.releases.ac24.b3000types.UserDefinedPropertyUserId(localizedName: List[str], type: str = 'UserDefined')¶

Bases: _ACBaseType

An object which uniquely identifies a User-Defined Property by its name in human-readable form.

Variables:

localizedName (list of str) – List of the localized name parts: first element is the Group Name, second element is the Property Name of the Property.
type (str) – EMPTY STRING

localizedName: List[str]¶

type: str¶

class archicad.releases.ac24.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¶

archicad.releases.ac24.b3000utilities module¶

class archicad.releases.ac24.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: DisplayValueEnumId) → 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.ac24 package¶

Submodules¶

archicad.releases.ac24.b2310commands module¶

archicad.releases.ac24.b2310types module¶

archicad.releases.ac24.b2310utilities module¶

archicad.releases.ac24.b3000commands module¶

archicad.releases.ac24.b3000types module¶

archicad.releases.ac24.b3000utilities module¶

Module contents¶

API Python Wrapper

Navigation

Related Topics