archicad¶

archicad.releases

Module contents¶

The archicad package from GRAPHISOFT

class archicad.ACConnection(port: int)¶

Bases: object

Represents a living connection to an existing ARCHICAD instance

Variables

version (int) – The version of the current ARCHICAD instance.
build (int) – The build number of the current ARCHICAD instance.
lang (str) – The language code of the current ARCHICAD instance.
commands – The commands can be called through this object.
types – The data types of commands can be access through this object.
utilities – Some other useful commands can be called through this object.

__init__(port: int)¶

static connect(port: Optional[int] = None)¶

Tries to connect to a running ARCHICAD instance.

Parameters: port (int, optional) – The ARCHICAD’s port. If not given, the command line or the default port will be used.
Raises: ConnectionError – When the connection is unsuccessful.
Returns: The living connection.
Return type: ACConnection

static port_from_args() → Optional[int]¶: Tries to extract hostname and port number from command line arguments Returns the tuple of the hostame and port number or None

class archicad.Commands(req: urllib.request.Request)¶

Bases: object

Collection of the ARCHICAD JSON interface commands

CloneProjectMapItemToViewMap(projectMapNavigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId, parentNavigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId) → archicad.releases.ac25.b3000types.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: archicad.releases.ac25.b3000types.LayoutParameters, masterNavigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId, parentNavigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId) → archicad.releases.ac25.b3000types.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: archicad.releases.ac25.b3000types.Subset, parentNavigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId) → archicad.releases.ac25.b3000types.NavigatorItemId¶

Creates a new layout subset.

Parameters

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

Returns

The identifier of a navigator item.

Return type

NavigatorItemId

CreateViewMapFolder(folderParameters: archicad.releases.ac25.b3000types.FolderParameters, parentNavigatorItemId: Optional[archicad.releases.ac25.b3000types.NavigatorItemId] = None, previousNavigatorItemId: Optional[archicad.releases.ac25.b3000types.NavigatorItemId] = None) → archicad.releases.ac25.b3000types.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[archicad.releases.ac25.b3000types.NavigatorItemIdWrapper]) → List[archicad.releases.ac25.b3000types.ExecutionResult]¶

Deletes items from navigator tree.

Parameters: navigatorItemIds (list of NavigatorItemIdWrapper) – A list of navigator item identifiers.
Returns: A list of execution results.
Return type: list of ExecutionResult

ExecuteAddOnCommand(addOnCommandId: archicad.releases.ac25.b3000types.AddOnCommandId, addOnCommandParameters: Optional[archicad.releases.ac25.b3000types.AddOnCommandParameters] = None) → archicad.releases.ac25.b3000types.AddOnCommandResponse¶

Executes a command registered in an Add-On.

Parameters

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

Returns

The response returned by an Add-On command.

Return type

AddOnCommandResponse

Get2DBoundingBoxes(elements: List[archicad.releases.ac25.b3000types.ElementIdArrayItem]) → List[archicad.releases.ac25.b3000types.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) – A list of elements.
Returns: A list of 2D bounding boxes.
Return type: list of BoundingBox2DOrError

Get3DBoundingBoxes(elements: List[archicad.releases.ac25.b3000types.ElementIdArrayItem]) → List[archicad.releases.ac25.b3000types.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) – A list of elements.
Returns: A list of 3D bounding boxes.
Return type: list of BoundingBox3DOrError

GetActivePenTables() → Tuple[archicad.releases.ac25.b3000types.AttributeIdOrError, archicad.releases.ac25.b3000types.AttributeIdOrError]¶

Returns the model view and layout book pen table identifiers.

Returns: The attribute’s identifier or an error. AttributeIdOrError: The attribute’s identifier or an error.
Return type: AttributeIdOrError

GetAllClassificationSystems() → List[archicad.releases.ac25.b3000types.ClassificationSystem]¶

Returns the list of available classification systems.

Returns: A list of classification systems.
Return type: list of ClassificationSystem

GetAllClassificationsInSystem(classificationSystemId: archicad.releases.ac25.b3000types.ClassificationSystemId) → List[archicad.releases.ac25.b3000types.ClassificationItemArrayItem]¶

Returns the tree of classifications in the given classification system.

Parameters: classificationSystemId (ClassificationSystemId) – The identifier of a classification system.
Returns: A list of classification items.
Return type: list of ClassificationItemArrayItem

GetAllElements() → List[archicad.releases.ac25.b3000types.ElementIdArrayItem]¶

Returns the identifier of every element in the current plan.

Returns: A list of elements.
Return type: list of ElementIdArrayItem

GetAllPropertyNames() → List[archicad.releases.ac25.b3000types.PropertyUserId]¶

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

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

GetAttributesByType(attributeType: str) → List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]¶

Returns the identifier of every attribute of the given type.

Parameters: attributeType (str) – The type of an attribute.
Returns: A list of attribute identifiers.
Return type: list of AttributeIdWrapperItem

GetBuildingMaterialAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.BuildingMaterialAttributeOrError]¶

Returns the detailed building material attributes identified by their GUIDs.

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of building material attributes and potential errors.
Return type: list of BuildingMaterialAttributeOrError

GetClassificationsOfElements(elements: List[archicad.releases.ac25.b3000types.ElementIdArrayItem], classificationSystemIds: List[archicad.releases.ac25.b3000types.ClassificationSystemIdArrayItem]) → List[archicad.releases.ac25.b3000types.ElementClassificationOrError]¶

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

Parameters

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

Returns

A list of element classification identifiers or errors.

Return type

list of ElementClassificationOrError

GetComponentsOfElements(elements: List[archicad.releases.ac25.b3000types.ElementIdArrayItem]) → List[archicad.releases.ac25.b3000types.ElementComponentsOrError]¶

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

Parameters: elements (list of ElementIdArrayItem) – A list of elements.
Returns: Array of component list or error.
Return type: list of ElementComponentsOrError

GetCompositeAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.CompositeAttributeOrError]¶

Returns the detailed composite attributes identified by their GUIDs.

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of the composite attributes and potential errors.
Return type: list of CompositeAttributeOrError

GetDetailsOfClassificationItems(classificationItemIds: List[archicad.releases.ac25.b3000types.ClassificationItemIdArrayItem]) → List[archicad.releases.ac25.b3000types.ClassificationItemOrError]¶

Returns the details of classification items.

Parameters: classificationItemIds (list of ClassificationItemIdArrayItem) – A list of classification item identifiers.
Returns: A list of classification items or errors.
Return type: list of ClassificationItemOrError

GetDetailsOfProperties(properties: List[archicad.releases.ac25.b3000types.PropertyIdArrayItem]) → List[archicad.releases.ac25.b3000types.PropertyDefinitionOrError]¶

Returns the details of property definitions.

Parameters: properties (list of PropertyIdArrayItem) – A list of property identifiers.
Returns: A list of property definitions or errors.
Return type: list of PropertyDefinitionOrError

GetElementsByClassification(classificationItemId: archicad.releases.ac25.b3000types.ClassificationItemId) → List[archicad.releases.ac25.b3000types.ElementIdArrayItem]¶

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

Parameters: classificationItemId (ClassificationItemId) – The identifier of a classification item.
Returns: A list of elements.
Return type: list of ElementIdArrayItem

GetElementsByType(elementType: str) → List[archicad.releases.ac25.b3000types.ElementIdArrayItem]¶

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

Parameters: elementType (str) – The type of an element.
Returns: A list of elements.
Return type: list of ElementIdArrayItem

GetElementsRelatedToZones(zones: List[archicad.releases.ac25.b3000types.ElementIdArrayItem], elementTypes: Optional[List[str]] = None) → List[archicad.releases.ac25.b3000types.ElementsOrError]¶

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

Parameters

zones (list of ElementIdArrayItem) – A list of elements.
elementTypes (list of str, optional) – A list of element types.

Returns

A list of ElementsOrError items.

Return type

list of ElementsOrError

GetFillAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.FillAttributeOrError]¶

Returns the detailed fill attributes identified by their GUIDs.

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of fill attributes and potential errors.
Return type: list of FillAttributeOrError

GetLayerAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.LayerAttributeOrError]¶

Returns the detailed layer attributes identified by their GUIDs.

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of layer attributes and potential errors.
Return type: list of LayerAttributeOrError

GetLayerCombinationAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.LayerCombinationAttributeOrError]¶

Returns the detailed layer combination attributes identified by their GUIDs.

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of layer combination attributes and potential errors.
Return type: list of LayerCombinationAttributeOrError

GetLayoutSettings(layoutNavigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId) → archicad.releases.ac25.b3000types.LayoutParameters¶

Returns the parameters (settings) of the given layout.

Parameters: layoutNavigatorItemId (NavigatorItemId) – The identifier of a navigator item.
Returns: The parameters of the layout.
Return type: LayoutParameters

GetLineAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.LineAttributeOrError]¶

Returns the detailed line attributes identified by their GUIDs.

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of line attributes and potential errors.
Return type: list of LineAttributeOrError

GetNavigatorItemTree(navigatorTreeId: archicad.releases.ac25.b3000types.NavigatorTreeId) → archicad.releases.ac25.b3000types.NavigatorTree¶

Returns the tree of navigator items.

Parameters: navigatorTreeId (NavigatorTreeId) – The identifier of a navigator item tree.
Returns: A tree of navigator items.
Return type: NavigatorTree

GetPenTableAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.PenTableAttributeOrError]¶

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

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of pen table attributes and potential errors.
Return type: list of PenTableAttributeOrError

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

Accesses the version information from the running ARCHICAD.

Returns: The version of the running ARCHICAD. int: The build number of the running ARCHICAD. str: The language code of the running ARCHICAD.
Return type: int

GetProfileAttributePreview(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem], imageWidth: int, imageHeight: int, backgroundColor: Optional[archicad.releases.ac25.b3000types.RGBColor] = None) → List[archicad.releases.ac25.b3000types.ImageOrError]¶

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

Parameters

attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
imageWidth (int) – The width of the preview image.
imageHeight (int) – The height of the preview image.
backgroundColor (RGBColor, optional) – A color model represented via its red, green and blue components.

Returns

A list of images and potential errors.

Return type

list of ImageOrError

GetProfileAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.ProfileAttributeOrError]¶

Returns the detailed profile attributes identified by their GUIDs.

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of the profile attributes and potential errors.
Return type: list of ProfileAttributeOrError

GetPropertyIds(properties: List[archicad.releases.ac25.b3000types.PropertyUserId]) → List[archicad.releases.ac25.b3000types.PropertyIdOrError]¶

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

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

GetPropertyValuesOfElementComponents(elementComponents: List[archicad.releases.ac25.b3000types.ElementComponentIdArrayItem], properties: List[archicad.releases.ac25.b3000types.PropertyIdArrayItem]) → List[archicad.releases.ac25.b3000types.PropertyValuesOrError]¶

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

Parameters

elementComponents (list of ElementComponentIdArrayItem) – List of components of elements.
properties (list of PropertyIdArrayItem) – A list of property identifiers.

Returns

A list of property value lists.

Return type

list of PropertyValuesOrError

GetPropertyValuesOfElements(elements: List[archicad.releases.ac25.b3000types.ElementIdArrayItem], properties: List[archicad.releases.ac25.b3000types.PropertyIdArrayItem]) → List[archicad.releases.ac25.b3000types.PropertyValuesOrError]¶

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

Parameters

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

Returns

A list of property value lists.

Return type

list of PropertyValuesOrError

GetPublisherSetNames() → List[str]¶

Returns the names of available publisher sets.

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

GetSurfaceAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.SurfaceAttributeOrError]¶

Returns the detailed surface attributes identified by their GUIDs.

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of surface attributes and potential errors.
Return type: list of SurfaceAttributeOrError

GetZoneCategoryAttributes(attributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem]) → List[archicad.releases.ac25.b3000types.ZoneCategoryAttributeOrError]¶

Returns the detailed zone category attributes identified by their GUIDs.

Parameters: attributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.
Returns: A list of zone category attributes and potential errors.
Return type: list of ZoneCategoryAttributeOrError

IsAddOnCommandAvailable(addOnCommandId: archicad.releases.ac25.b3000types.AddOnCommandId) → bool¶

Checks if the command is available or not.

Parameters: addOnCommandId (AddOnCommandId) – The identifier of an Add-On command.
Returns: Returns true if the command is available.
Return type: bool

IsAlive() → bool¶

Checks if the ARCHICAD connection is alive.

Returns: Returns true if the connection is alive.
Return type: bool

MoveNavigatorItem(navigatorItemIdToMove: archicad.releases.ac25.b3000types.NavigatorItemId, parentNavigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId, previousNavigatorItemId: Optional[archicad.releases.ac25.b3000types.NavigatorItemId] = 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: archicad.releases.ac25.b3000types.NavigatorItemId, newName: Optional[str] = None, newId: Optional[str] = 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[archicad.releases.ac25.b3000types.ElementClassification]) → List[archicad.releases.ac25.b3000types.ExecutionResult]¶

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

Parameters: elementClassifications (list of ElementClassification) – A list of element classification identifiers.
Returns: A list of execution results.
Return type: list of ExecutionResult

SetLayoutSettings(layoutParameters: archicad.releases.ac25.b3000types.LayoutParameters, layoutNavigatorItemId: archicad.releases.ac25.b3000types.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[archicad.releases.ac25.b3000types.ElementPropertyValue]) → List[archicad.releases.ac25.b3000types.ExecutionResult]¶

Sets the property values of elements.

Parameters: elementPropertyValues (list of ElementPropertyValue) – A list of element property values.
Returns: A list of execution results.
Return type: list of ExecutionResult

__init__(req: urllib.request.Request)¶

__weakref__¶: list of weak references to the object (if defined)

class archicad.Types¶

Bases: object

class AddOnCommandId(commandNamespace: str, commandName: str)¶

Bases: archicad.acbasetype._ACBaseType

The identifier of an Add-On command.

Variables

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

__init__(commandNamespace: str, commandName: str)¶

class AddOnCommandIdArrayItem(addOnCommandId: archicad.releases.ac25.b3000types.AddOnCommandId)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(addOnCommandId: archicad.releases.ac25.b3000types.AddOnCommandId)¶

class AddOnCommandParameters¶

Bases: archicad.acbasetype._ACBaseType

The input parameters of an Add-On command.

__dict__ = mappingproxy({'__module__': 'archicad.releases.ac25.b3000types', '__doc__': ' The input parameters of an Add-On command.\n\n ', '__init__': <function AddOnCommandParameters.__init__>, '__dict__': <attribute '__dict__' of 'AddOnCommandParameters' objects>, '__weakref__': <attribute '__weakref__' of 'AddOnCommandParameters' objects>, '__abstractmethods__': frozenset(), '_abc_impl': <_abc._abc_data object>, '__annotations__': {'_class_info': typing.ClassVar[archicad.acbasetype._ClassInfo]}})¶

__init__()¶

__weakref__¶: list of weak references to the object (if defined)

class AddOnCommandResponse¶

Bases: archicad.acbasetype._ACBaseType

The response returned by an Add-On command.

__dict__ = mappingproxy({'__module__': 'archicad.releases.ac25.b3000types', '__doc__': ' The response returned by an Add-On command.\n\n ', '__init__': <function AddOnCommandResponse.__init__>, '__dict__': <attribute '__dict__' of 'AddOnCommandResponse' objects>, '__weakref__': <attribute '__weakref__' of 'AddOnCommandResponse' objects>, '__abstractmethods__': frozenset(), '_abc_impl': <_abc._abc_data object>, '__annotations__': {'_class_info': typing.ClassVar[archicad.acbasetype._ClassInfo]}})¶

__init__()¶

__weakref__¶: list of weak references to the object (if defined)

class AttributeHeader(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str)¶

Bases: archicad.acbasetype._ACBaseType

The header object of an attribute.

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str)¶

class AttributeId(guid: uuid.UUID)¶

Bases: archicad.acbasetype._ACBaseType

The identifier of an attribute.

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

__init__(guid: uuid.UUID)¶

class AttributeIdOrError(attributeId: Optional[archicad.releases.ac25.b3000types.AttributeId] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

The attribute’s identifier or an error.

Variables

attributeId (AttributeId, optional) – The identifier of an attribute.
error (Error, optional) – The details of an error.

__init__(attributeId: Optional[archicad.releases.ac25.b3000types.AttributeId] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, attributeId: Optional[archicad.releases.ac25.b3000types.AttributeId] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class AttributeIdWrapperItem(attributeId: archicad.releases.ac25.b3000types.AttributeId)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables: attributeId (AttributeId) – The identifier of an attribute.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId)¶

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

Bases: archicad.acbasetype._ACBaseType

The 2D bounding box of an element.

Variables

xMin (float) – The minimum X value of the bounding box.
yMin (float) – The minimum Y value of the bounding box.
xMax (float) – The maximum X value of the bounding box.
yMax (float) – The maximum Y value of the bounding box.

__init__(xMin: float, yMin: float, xMax: float, yMax: float)¶

class BoundingBox2DOrError(boundingBox2D: Optional[archicad.releases.ac25.b3000types.BoundingBox2D] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A 2D bounding box or an error.

Variables

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

__init__(boundingBox2D: Optional[archicad.releases.ac25.b3000types.BoundingBox2D] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, boundingBox2D: Optional[archicad.releases.ac25.b3000types.BoundingBox2D] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

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

Bases: archicad.acbasetype._ACBaseType

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

__init__(boundingBox2D: archicad.releases.ac25.b3000types.BoundingBox2D)¶

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

Bases: archicad.acbasetype._ACBaseType

A 3D bounding box of an element.

Variables

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

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

class BoundingBox3DOrError(boundingBox3D: Optional[archicad.releases.ac25.b3000types.BoundingBox3D] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A 3D bounding box or an error.

Variables

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

__init__(boundingBox3D: Optional[archicad.releases.ac25.b3000types.BoundingBox3D] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, boundingBox3D: Optional[archicad.releases.ac25.b3000types.BoundingBox3D] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

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

Bases: archicad.acbasetype._ACBaseType

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

__init__(boundingBox3D: archicad.releases.ac25.b3000types.BoundingBox3D)¶

class BuildingMaterialAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, id: str, connectionPriority: int, cutFillId: archicad.releases.ac25.b3000types.AttributeIdOrError, cutFillPenIndex: int, cutSurfaceId: archicad.releases.ac25.b3000types.AttributeIdOrError)¶

Bases: archicad.acbasetype._ACBaseType

A building material attribute

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
id (str) – The id of the building material.
connectionPriority (int) – The connection priority of the building material.
cutFillId (AttributeIdOrError) – The attribute’s identifier or an error.
cutFillPenIndex (int) – The index number of a pen.
cutSurfaceId (AttributeIdOrError) – The attribute’s identifier or an error.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, id: str, connectionPriority: int, cutFillId: archicad.releases.ac25.b3000types.AttributeIdOrError, cutFillPenIndex: int, cutSurfaceId: archicad.releases.ac25.b3000types.AttributeIdOrError)¶

class BuildingMaterialAttributeOrError(buildingMaterialAttribute: Optional[archicad.releases.ac25.b3000types.BuildingMaterialAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A building material attribute or an error.

Variables

buildingMaterialAttribute (BuildingMaterialAttribute, optional) – A building material attribute
error (Error, optional) – The details of an error.

__init__(buildingMaterialAttribute: Optional[archicad.releases.ac25.b3000types.BuildingMaterialAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, buildingMaterialAttribute: Optional[archicad.releases.ac25.b3000types.BuildingMaterialAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class BuildingMaterialAttributeWrapper(buildingMaterialAttribute: archicad.releases.ac25.b3000types.BuildingMaterialAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: buildingMaterialAttribute (BuildingMaterialAttribute) – A building material attribute

__init__(buildingMaterialAttribute: archicad.releases.ac25.b3000types.BuildingMaterialAttribute)¶

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

Bases: archicad.acbasetype._ACBaseType

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

Variables

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

__init__(nonLocalizedName: str, type: str = 'BuiltIn')¶

class ClassificationId(classificationSystemId: archicad.releases.ac25.b3000types.ClassificationSystemId, classificationItemId: Optional[archicad.releases.ac25.b3000types.ClassificationItemId] = None)¶

Bases: archicad.acbasetype._ACBaseType

The element classification identifier.

Variables

classificationSystemId (ClassificationSystemId) – The identifier of a classification system.
classificationItemId (ClassificationItemId, optional) – The identifier of a classification item.

__init__(classificationSystemId: archicad.releases.ac25.b3000types.ClassificationSystemId, classificationItemId: Optional[archicad.releases.ac25.b3000types.ClassificationItemId] = None)¶

class ClassificationIdOrError(classificationId: Optional[archicad.releases.ac25.b3000types.ClassificationId] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

EMPTY STRING

Variables

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

__init__(classificationId: Optional[archicad.releases.ac25.b3000types.ClassificationId] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, classificationId: Optional[archicad.releases.ac25.b3000types.ClassificationId] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

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

Bases: archicad.acbasetype._ACBaseType

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

__init__(classificationId: archicad.releases.ac25.b3000types.ClassificationId)¶

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

Bases: archicad.acbasetype._ACBaseType

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

__init__(classificationIds: List[archicad.releases.ac25.b3000types.ClassificationIdOrError])¶

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

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(classificationItem: archicad.releases.ac25.b3000types.ClassificationItemInTree_)¶

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

Bases: archicad.acbasetype._ACBaseType

The details of a classification item.

Variables

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

__init__(id: str, name: str, description: str)¶

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

Bases: archicad.acbasetype._ACBaseType

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

__init__(classificationItem: archicad.releases.ac25.b3000types.ClassificationItemDetails)¶

class ClassificationItemId(guid: uuid.UUID)¶

Bases: archicad.acbasetype._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.

__init__(guid: uuid.UUID)¶

class ClassificationItemIdArrayItem(classificationItemId: archicad.releases.ac25.b3000types.ClassificationItemId)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(classificationItemId: archicad.releases.ac25.b3000types.ClassificationItemId)¶

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

Bases: archicad.acbasetype._ACBaseType

The details of a classification item.

Variables

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

__init__(classificationItemId: archicad.releases.ac25.b3000types.ClassificationItemId, id: str, name: str, description: str, children: Optional[List[archicad.releases.ac25.b3000types.ClassificationItemArrayItem]] = None)¶

class ClassificationItemOrError(classificationItem: Optional[archicad.releases.ac25.b3000types.ClassificationItemDetails] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

EMPTY STRING

Variables

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

__init__(classificationItem: Optional[archicad.releases.ac25.b3000types.ClassificationItemDetails] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, classificationItem: Optional[archicad.releases.ac25.b3000types.ClassificationItemDetails] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

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

Bases: archicad.acbasetype._ACBaseType

The details of a classification system.

Variables

classificationSystemId (ClassificationSystemId) – The identifier of a classification system.
name (str) – The display name of the classification system.
description (str) – The description of the classification system.
source (str) – The source of the classification system (e.g. URL to a classification system standard).
version (str) – The version of the classification system.
date (str) – A date in its string representation as defined in ISO 8601: YYYY-MM-DD.

__init__(classificationSystemId: archicad.releases.ac25.b3000types.ClassificationSystemId, name: str, description: str, source: str, version: str, date: str)¶

class ClassificationSystemId(guid: uuid.UUID)¶

Bases: archicad.acbasetype._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.

__init__(guid: uuid.UUID)¶

class ClassificationSystemIdArrayItem(classificationSystemId: archicad.releases.ac25.b3000types.ClassificationSystemId)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(classificationSystemId: archicad.releases.ac25.b3000types.ClassificationSystemId)¶

class ComponentId(guid: uuid.UUID)¶

Bases: archicad.acbasetype._ACBaseType

The identifier of a component.

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

__init__(guid: uuid.UUID)¶

class CompositeAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, totalThickness: float, compositeSkins: List[archicad.releases.ac25.b3000types.CompositeSkinListItem], compositeLines: List[archicad.releases.ac25.b3000types.CompositeLineListItem], useWith: List[str])¶

Bases: archicad.acbasetype._ACBaseType

A composite attribute.

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
totalThickness (float) – The total thickness of the composite.
compositeSkins (list of CompositeSkinListItem) – A list of composite skins.
compositeLines (list of CompositeLineListItem) – A list of contour/separator lines for the composite.
useWith (list of str) – A list of element types.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, totalThickness: float, compositeSkins: List[archicad.releases.ac25.b3000types.CompositeSkinListItem], compositeLines: List[archicad.releases.ac25.b3000types.CompositeLineListItem], useWith: List[str])¶

class CompositeAttributeOrError(compositeAttribute: Optional[archicad.releases.ac25.b3000types.CompositeAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A composite attribute or an error.

Variables

compositeAttribute (CompositeAttribute, optional) – A composite attribute.
error (Error, optional) – The details of an error.

__init__(compositeAttribute: Optional[archicad.releases.ac25.b3000types.CompositeAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, compositeAttribute: Optional[archicad.releases.ac25.b3000types.CompositeAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class CompositeAttributeWrapper(compositeAttribute: archicad.releases.ac25.b3000types.CompositeAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: compositeAttribute (CompositeAttribute) – A composite attribute.

__init__(compositeAttribute: archicad.releases.ac25.b3000types.CompositeAttribute)¶

class CompositeLine(lineId: archicad.releases.ac25.b3000types.AttributeIdOrError, linePenIndex: Optional[int] = None)¶

Bases: archicad.acbasetype._ACBaseType

A contour or separator line component for a composite attribute.

Variables

lineId (AttributeIdOrError) – The attribute’s identifier or an error.
linePenIndex (int, optional) – The index number of a pen.

__init__(lineId: archicad.releases.ac25.b3000types.AttributeIdOrError, linePenIndex: Optional[int] = None)¶

class CompositeLineListItem(compositeLine: archicad.releases.ac25.b3000types.CompositeLine)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(compositeLine: archicad.releases.ac25.b3000types.CompositeLine)¶

class CompositeSkin(buildingMaterialId: archicad.releases.ac25.b3000types.AttributeIdOrError, thickness: float, isCore: bool, isFinish: bool, framePenIndex: Optional[int] = None)¶

Bases: archicad.acbasetype._ACBaseType

A skin component for a composite attribute.

Variables

buildingMaterialId (AttributeIdOrError) – The attribute’s identifier or an error.
thickness (float) – The thickness of the composite skin.
isCore (bool) – Defines whether the composite skin is part of the core or not.
isFinish (bool) – Defines whether the composite skin is part of the finish or not.
framePenIndex (int, optional) – The index number of a pen.

__init__(buildingMaterialId: archicad.releases.ac25.b3000types.AttributeIdOrError, thickness: float, isCore: bool, isFinish: bool, framePenIndex: Optional[int] = None)¶

class CompositeSkinListItem(compositeSkin: archicad.releases.ac25.b3000types.CompositeSkin)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(compositeSkin: archicad.releases.ac25.b3000types.CompositeSkin)¶

class DashItem(dash: float, gap: float)¶

Bases: archicad.acbasetype._ACBaseType

A dash item.

Variables

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

__init__(dash: float, gap: float)¶

class DashItemWrapper(dashItem: archicad.releases.ac25.b3000types.DashItem)¶

Bases: archicad.acbasetype._ACBaseType

Variables: dashItem (DashItem) – A dash item.

__init__(dashItem: archicad.releases.ac25.b3000types.DashItem)¶

class DashOrLineItem(dashItem: Optional[archicad.releases.ac25.b3000types.DashItem] = None, lineItem: Optional[archicad.releases.ac25.b3000types.LineItem] = None)¶

Bases: archicad.acbasetype._ACUnionType

A dash or line item.

Variables

dashItem (DashItem, optional) – A dash item.
lineItem (LineItem, optional) – A line item.

__init__(dashItem: Optional[archicad.releases.ac25.b3000types.DashItem] = None, lineItem: Optional[archicad.releases.ac25.b3000types.LineItem] = None)¶

static __new__(cls, dashItem: Optional[archicad.releases.ac25.b3000types.DashItem] = None, lineItem: Optional[archicad.releases.ac25.b3000types.LineItem] = None)¶

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

class DisplayValueEnumId(displayValue: str, type: str = 'displayValue')¶

Bases: archicad.acbasetype._ACBaseType

An enumeration value identifier using the displayed value.

Variables

displayValue (str) – EMPTY STRING
type (str) – EMPTY STRING

__init__(displayValue: str, type: str = 'displayValue')¶

class ElementClassification(elementId: archicad.releases.ac25.b3000types.ElementId, classificationId: archicad.releases.ac25.b3000types.ClassificationId)¶

Bases: archicad.acbasetype._ACBaseType

The classification of an element.

Variables

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

__init__(elementId: archicad.releases.ac25.b3000types.ElementId, classificationId: archicad.releases.ac25.b3000types.ClassificationId)¶

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

Bases: archicad.acbasetype._ACUnionType

Element classification identifiers or errors.

Variables

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

__init__(classificationIds: Optional[List[archicad.releases.ac25.b3000types.ClassificationIdOrError]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, classificationIds: Optional[List[archicad.releases.ac25.b3000types.ClassificationIdOrError]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class ElementComponentId(elementId: archicad.releases.ac25.b3000types.ElementId, componentId: archicad.releases.ac25.b3000types.ComponentId)¶

Bases: archicad.acbasetype._ACBaseType

The identifier of an element’s component.

Variables

elementId (ElementId) – The identifier of an element.
componentId (ComponentId) – The identifier of a component.

__init__(elementId: archicad.releases.ac25.b3000types.ElementId, componentId: archicad.releases.ac25.b3000types.ComponentId)¶

class ElementComponentIdArrayItem(elementComponentId: archicad.releases.ac25.b3000types.ElementComponentId)¶

Bases: archicad.acbasetype._ACBaseType

An item of a component array.

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

__init__(elementComponentId: archicad.releases.ac25.b3000types.ElementComponentId)¶

class ElementComponentsOrError(elementComponents: Optional[List[archicad.releases.ac25.b3000types.ElementComponentIdArrayItem]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

List of components or error.

Variables

elementComponents (list of ElementComponentIdArrayItem, optional) – List of components of elements.
error (Error, optional) – The details of an error.

__init__(elementComponents: Optional[List[archicad.releases.ac25.b3000types.ElementComponentIdArrayItem]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, elementComponents: Optional[List[archicad.releases.ac25.b3000types.ElementComponentIdArrayItem]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class ElementComponentsWrapper(elementComponents: List[archicad.releases.ac25.b3000types.ElementComponentIdArrayItem])¶

Bases: archicad.acbasetype._ACBaseType

List of components.

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

__init__(elementComponents: List[archicad.releases.ac25.b3000types.ElementComponentIdArrayItem])¶

class ElementId(guid: uuid.UUID)¶

Bases: archicad.acbasetype._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.

__init__(guid: uuid.UUID)¶

class ElementIdArrayItem(elementId: archicad.releases.ac25.b3000types.ElementId)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(elementId: archicad.releases.ac25.b3000types.ElementId)¶

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

Bases: archicad.acbasetype._ACBaseType

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

Variables

elementId (ElementId) – The identifier of an element.
propertyId (PropertyId) – The identifier of a property.
propertyValue (NormalOrUserUndefinedPropertyValue) – A normal or a userUndefined property value.

__init__(elementId: archicad.releases.ac25.b3000types.ElementId, propertyId: archicad.releases.ac25.b3000types.PropertyId, propertyValue: archicad.releases.ac25.b3000types.NormalOrUserUndefinedPropertyValue)¶

class ElementsOrError(elements: Optional[List[archicad.releases.ac25.b3000types.ElementIdArrayItem]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A list of elements or an error.

Variables

elements (list of ElementIdArrayItem, optional) – A list of elements.
error (Error, optional) – The details of an error.

__init__(elements: Optional[List[archicad.releases.ac25.b3000types.ElementIdArrayItem]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, elements: Optional[List[archicad.releases.ac25.b3000types.ElementIdArrayItem]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

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

Bases: archicad.acbasetype._ACBaseType

A wrapper for a list of elements.

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

__init__(elements: List[archicad.releases.ac25.b3000types.ElementIdArrayItem])¶

class EnumValueId(type: str, displayValue: Optional[str] = None, nonLocalizedValue: Optional[str] = None)¶

Bases: archicad.acbasetype._ACUnionType

The identifier of a property enumeration value.

Variables

type (str) – None
displayValue (str, optional) – EMPTY STRING
nonLocalizedValue (str, optional) – EMPTY STRING

__init__(type: str, displayValue: Optional[str] = None, nonLocalizedValue: Optional[str] = None)¶

static __new__(cls, type: str, displayValue: Optional[str] = None, nonLocalizedValue: Optional[str] = None)¶

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

class EnumValueIdWrapper(enumValueId: archicad.releases.ac25.b3000types.EnumValueId)¶

Bases: archicad.acbasetype._ACBaseType

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

__init__(enumValueId: archicad.releases.ac25.b3000types.EnumValueId)¶

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

Bases: archicad.acbasetype._ACBaseType

The details of an error.

Variables

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

__init__(code: int, message: str)¶

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

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables: error (Error) – The details of an error.

__init__(error: archicad.releases.ac25.b3000types.Error)¶

class ExecutionResult(success: bool, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

The result of the execution.

Variables

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

__init__(success: bool, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, success: bool, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

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

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

success (bool) – EMPTY STRING
error (Error) – The details of an error.

__init__(success: bool, error: archicad.releases.ac25.b3000types.Error)¶

class FillAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, subType: str, pattern: int, appearanceType: str)¶

Bases: archicad.acbasetype._ACBaseType

A fill attribute.

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
subType (str) – The filling type of a fill attribute.
pattern (int) – The pattern of the fill attribute, stored in a 64 bit unsigned integer, and represented as an 8x8 matrix. Each byte in the value is a row, and the bits are the columns of the matrix.
appearanceType (str) – The appearance type of a line or fill attribute.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, subType: str, pattern: int, appearanceType: str)¶

class FillAttributeOrError(fillAttribute: Optional[archicad.releases.ac25.b3000types.FillAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A fill attribute or an error.

Variables

fillAttribute (FillAttribute, optional) – A fill attribute.
error (Error, optional) – The details of an error.

__init__(fillAttribute: Optional[archicad.releases.ac25.b3000types.FillAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, fillAttribute: Optional[archicad.releases.ac25.b3000types.FillAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class FillAttributeWrapper(fillAttribute: archicad.releases.ac25.b3000types.FillAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: fillAttribute (FillAttribute) – A fill attribute.

__init__(fillAttribute: archicad.releases.ac25.b3000types.FillAttribute)¶

class FolderParameters(name: str)¶

Bases: archicad.acbasetype._ACBaseType

The parameters of a folder.

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

__init__(name: str)¶

class Image(content: str)¶

Bases: archicad.acbasetype._ACBaseType

An image encoded as a Base64 string.

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

__init__(content: str)¶

class ImageOrError(image: Optional[archicad.releases.ac25.b3000types.Image] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

An image or an error.

Variables

image (Image, optional) – An image encoded as a Base64 string.
error (Error, optional) – The details of an error.

__init__(image: Optional[archicad.releases.ac25.b3000types.Image] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, image: Optional[archicad.releases.ac25.b3000types.Image] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class ImageWrapper(image: archicad.releases.ac25.b3000types.Image)¶

Bases: archicad.acbasetype._ACBaseType

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

__init__(image: archicad.releases.ac25.b3000types.Image)¶

class LayerAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, intersectionGroupNr: int, isLocked: bool, isHidden: bool, isWireframe: bool)¶

Bases: archicad.acbasetype._ACBaseType

A layer attribute

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
intersectionGroupNr (int) – The intersection group number
isLocked (bool) – Defines whether the layer is locked or not.
isHidden (bool) – Defines whether the layer is hidden or not.
isWireframe (bool) – Defines whether the elements placed on this layer are visible as wireframes or a solid model.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, intersectionGroupNr: int, isLocked: bool, isHidden: bool, isWireframe: bool)¶

class LayerAttributeOrError(layerAttribute: Optional[archicad.releases.ac25.b3000types.LayerAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A layer attribute or an error.

Variables

layerAttribute (LayerAttribute, optional) – A layer attribute
error (Error, optional) – The details of an error.

__init__(layerAttribute: Optional[archicad.releases.ac25.b3000types.LayerAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, layerAttribute: Optional[archicad.releases.ac25.b3000types.LayerAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class LayerAttributeWrapper(layerAttribute: archicad.releases.ac25.b3000types.LayerAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: layerAttribute (LayerAttribute) – A layer attribute

__init__(layerAttribute: archicad.releases.ac25.b3000types.LayerAttribute)¶

class LayerCombinationAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, layerAttributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem])¶

Bases: archicad.acbasetype._ACBaseType

A layer combination attribute

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
layerAttributeIds (list of AttributeIdWrapperItem) – A list of attribute identifiers.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, layerAttributeIds: List[archicad.releases.ac25.b3000types.AttributeIdWrapperItem])¶

class LayerCombinationAttributeOrError(layerCombinationAttribute: Optional[archicad.releases.ac25.b3000types.LayerCombinationAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A layer combination attribute or an error.

Variables

layerCombinationAttribute (LayerCombinationAttribute, optional) – A layer combination attribute
error (Error, optional) – The details of an error.

__init__(layerCombinationAttribute: Optional[archicad.releases.ac25.b3000types.LayerCombinationAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, layerCombinationAttribute: Optional[archicad.releases.ac25.b3000types.LayerCombinationAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class LayerCombinationAttributeWrapper(layerCombinationAttribute: archicad.releases.ac25.b3000types.LayerCombinationAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: layerCombinationAttribute (LayerCombinationAttribute) – A layer combination attribute

__init__(layerCombinationAttribute: archicad.releases.ac25.b3000types.LayerCombinationAttribute)¶

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

Bases: archicad.acbasetype._ACBaseType

The parameters of the layout.

Variables

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

__init__(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)¶

class LineAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, appearanceType: str, displayScale: float, period: float, height: float, lineType: str, lineItems: Optional[List[archicad.releases.ac25.b3000types.DashOrLineItem]] = None)¶

Bases: archicad.acbasetype._ACBaseType

A line attribute

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
appearanceType (str) – The appearance type of a line or fill attribute.
displayScale (float) – The original scale of the line.
period (float) – The length of the dashed or symbol line’s period.
height (float) – The height of the symbol line.
lineType (str) – The type of a line attribute.
lineItems (list of DashOrLineItem, optional) – A list of dash or line items.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, appearanceType: str, displayScale: float, period: float, height: float, lineType: str, lineItems: Optional[List[archicad.releases.ac25.b3000types.DashOrLineItem]] = None)¶

class LineAttributeOrError(lineAttribute: Optional[archicad.releases.ac25.b3000types.LineAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A line attribute or an error.

Variables

lineAttribute (LineAttribute, optional) – A line attribute
error (Error, optional) – The details of an error.

__init__(lineAttribute: Optional[archicad.releases.ac25.b3000types.LineAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, lineAttribute: Optional[archicad.releases.ac25.b3000types.LineAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class LineAttributeWrapper(lineAttribute: archicad.releases.ac25.b3000types.LineAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: lineAttribute (LineAttribute) – A line attribute

__init__(lineAttribute: archicad.releases.ac25.b3000types.LineAttribute)¶

class LineItem(lineItemType: str, centerOffset: float, length: float, begPosition: archicad.releases.ac25.b3000types.Point2D, endPosition: archicad.releases.ac25.b3000types.Point2D, radius: float, begAngle: float, endAngle: float)¶

Bases: archicad.acbasetype._ACBaseType

A line item.

Variables

lineItemType (str) – The type of a line item.
centerOffset (float) – The vertical distance from the origin of the symbol line. Used in separator, center dot, and centerline item types.
length (float) – The length of the item. Used in centerline, right angle, and parallel item types.
begPosition (Point2D) – EMPTY STRING
endPosition (Point2D) – EMPTY STRING
radius (float) – The radius of the item. Used in circle and arc item types.
begAngle (float) – The beginning angle of the item, measured from the vertical axis. Used in the arc item type.
endAngle (float) – The ending angle of the item, measured from the vertical axis. Used in the arc item type.

__init__(lineItemType: str, centerOffset: float, length: float, begPosition: archicad.releases.ac25.b3000types.Point2D, endPosition: archicad.releases.ac25.b3000types.Point2D, radius: float, begAngle: float, endAngle: float)¶

class LineItemWrapper(lineItem: archicad.releases.ac25.b3000types.LineItem)¶

Bases: archicad.acbasetype._ACBaseType

Variables: lineItem (LineItem) – A line item.

__init__(lineItem: archicad.releases.ac25.b3000types.LineItem)¶

class NavigatorItem(navigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId, prefix: str, name: str, type: str, sourceNavigatorItemId: Optional[archicad.releases.ac25.b3000types.NavigatorItemId] = None, children: Optional[List[archicad.releases.ac25.b3000types.NavigatorItemArrayItem]] = None)¶

Bases: archicad.acbasetype._ACBaseType

The details of a navigator item.

Variables

navigatorItemId (NavigatorItemId) – The identifier of a navigator item.
prefix (str) – The prefix of the navigator item’s name.
name (str) – The name of the navigator item.
type (str) – The types of a navigator item. The ‘UndefinedItem’ type is used when the actual type of the navigator item cannot be retrieved from ARCHICAD.
sourceNavigatorItemId (NavigatorItemId, optional) – The identifier of a navigator item.
children (list of NavigatorItemArrayItem, optional) – A list of navigator items.

__init__(navigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId, prefix: str, name: str, type: str, sourceNavigatorItemId: Optional[archicad.releases.ac25.b3000types.NavigatorItemId] = None, children: Optional[List[archicad.releases.ac25.b3000types.NavigatorItemArrayItem]] = None)¶

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

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(navigatorItem: archicad.releases.ac25.b3000types.NavigatorItem_)¶

class NavigatorItemId(guid: uuid.UUID)¶

Bases: archicad.acbasetype._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.

__init__(guid: uuid.UUID)¶

class NavigatorItemIdWrapper(navigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId)¶

Bases: archicad.acbasetype._ACBaseType

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

__init__(navigatorItemId: archicad.releases.ac25.b3000types.NavigatorItemId)¶

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

Bases: archicad.acbasetype._ACBaseType

A tree of navigator items.

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

__init__(rootItem: archicad.releases.ac25.b3000types.NavigatorItem)¶

class NavigatorTreeId(type: str, name: Optional[str] = None)¶

Bases: archicad.acbasetype._ACUnionType

The identifier of a navigator item tree.

Variables

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

__init__(type: str, name: Optional[str] = None)¶

static __new__(cls, type: str, name: Optional[str] = None)¶

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

class NonLocalizedValueEnumId(nonLocalizedValue: str, type: str = 'nonLocalizedValue')¶

Bases: archicad.acbasetype._ACBaseType

An enumeration value identifier using the nonlocalized value.

Variables

nonLocalizedValue (str) – EMPTY STRING
type (str) – EMPTY STRING

__init__(nonLocalizedValue: str, type: str = 'nonLocalizedValue')¶

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

Bases: archicad.acbasetype._ACBaseType

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

Variables

value (list of float) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

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

class NormalAnglePropertyValue(value: float, type: str = 'angle', status: str = 'normal')¶

Bases: archicad.acbasetype._ACBaseType

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

Variables

value (float) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: float, type: str = 'angle', status: str = 'normal')¶

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

Bases: archicad.acbasetype._ACBaseType

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

Variables

value (list of float) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

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

class NormalAreaPropertyValue(value: float, type: str = 'area', status: str = 'normal')¶

Bases: archicad.acbasetype._ACBaseType

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

Variables

value (float) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: float, type: str = 'area', status: str = 'normal')¶

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

Bases: archicad.acbasetype._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

__init__(value: List[bool], type: str = 'booleanList', status: str = 'normal')¶

class NormalBooleanPropertyValue(value: bool, type: str = 'boolean', status: str = 'normal')¶

Bases: archicad.acbasetype._ACBaseType

A boolean property value containing a valid boolean value.

Variables

value (bool) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: bool, type: str = 'boolean', status: str = 'normal')¶

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

Bases: archicad.acbasetype._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

__init__(value: List[int], type: str = 'integerList', status: str = 'normal')¶

class NormalIntegerPropertyValue(value: int, type: str = 'integer', status: str = 'normal')¶

Bases: archicad.acbasetype._ACBaseType

An integer property value containing a valid integer number.

Variables

value (int) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: int, type: str = 'integer', status: str = 'normal')¶

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

Bases: archicad.acbasetype._ACBaseType

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

Variables

value (list of float) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: List[float], type: str = 'lengthList', status: str = 'normal')¶

class NormalLengthPropertyValue(value: float, type: str = 'length', status: str = 'normal')¶

Bases: archicad.acbasetype._ACBaseType

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

Variables

value (float) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: float, type: str = 'length', status: str = 'normal')¶

class NormalMultiEnumPropertyValue(value: List[archicad.releases.ac25.b3000types.EnumValueIdWrapper], type: str = 'multiEnum', status: str = 'normal')¶

Bases: archicad.acbasetype._ACBaseType

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

Variables

value (list of EnumValueIdWrapper) – A list of enumeration identifiers.
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: List[archicad.releases.ac25.b3000types.EnumValueIdWrapper], type: str = 'multiEnum', status: str = 'normal')¶

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

Bases: archicad.acbasetype._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

__init__(value: List[float], type: str = 'numberList', status: str = 'normal')¶

class NormalNumberPropertyValue(value: float, type: str = 'number', status: str = 'normal')¶

Bases: archicad.acbasetype._ACBaseType

A number property value containing a valid numeric value.

Variables

value (float) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: float, type: str = 'number', status: str = 'normal')¶

class NormalOrUserUndefinedPropertyValue(type: str, status: str, value: Optional[Union[float, int, str, bool, List[float], List[int], List[str], List[bool], archicad.releases.ac25.b3000types.EnumValueId, List[archicad.releases.ac25.b3000types.EnumValueIdWrapper]]] = None)¶

Bases: archicad.acbasetype._ACUnionType

A normal or a userUndefined property value.

Variables

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

__init__(type: str, status: str, value: Optional[Union[float, int, str, bool, List[float], List[int], List[str], List[bool], archicad.releases.ac25.b3000types.EnumValueId, List[archicad.releases.ac25.b3000types.EnumValueIdWrapper]]] = None)¶

static __new__(cls, type: str, status: str, value: Optional[Union[float, int, str, bool, List[float], List[int], List[str], List[bool], archicad.releases.ac25.b3000types.EnumValueId, List[archicad.releases.ac25.b3000types.EnumValueIdWrapper]]] = None)¶

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

class NormalSingleEnumPropertyValue(value: archicad.releases.ac25.b3000types.EnumValueId, type: str = 'singleEnum', status: str = 'normal')¶

Bases: archicad.acbasetype._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

__init__(value: archicad.releases.ac25.b3000types.EnumValueId, type: str = 'singleEnum', status: str = 'normal')¶

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

Bases: archicad.acbasetype._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

__init__(value: List[str], type: str = 'stringList', status: str = 'normal')¶

class NormalStringPropertyValue(value: str, type: str = 'string', status: str = 'normal')¶

Bases: archicad.acbasetype._ACBaseType

A string property value containing a valid string.

Variables

value (str) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: str, type: str = 'string', status: str = 'normal')¶

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

Bases: archicad.acbasetype._ACBaseType

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

Variables

value (list of float) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

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

class NormalVolumePropertyValue(value: float, type: str = 'volume', status: str = 'normal')¶

Bases: archicad.acbasetype._ACBaseType

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

Variables

value (float) – EMPTY STRING
type (str) – EMPTY STRING
status (str) – EMPTY STRING

__init__(value: float, type: str = 'volume', status: str = 'normal')¶

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

Bases: archicad.acbasetype._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

__init__(type: str, status: str = 'notAvailable')¶

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

Bases: archicad.acbasetype._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

__init__(type: str, status: str = 'notEvaluated')¶

class OtherNavigatorTreeId(type: str)¶

Bases: archicad.acbasetype._ACBaseType

The identifier of a navigator item tree.

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

__init__(type: str)¶

class Pen(name: str, index: int, color: archicad.releases.ac25.b3000types.RGBColor, weight: float, description: str)¶

Bases: archicad.acbasetype._ACBaseType

A pen attribute.

Variables

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

__init__(name: str, index: int, color: archicad.releases.ac25.b3000types.RGBColor, weight: float, description: str)¶

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

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables: pen (Pen) – A pen attribute.

__init__(pen: archicad.releases.ac25.b3000types.Pen)¶

class PenTableAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, pens: List[archicad.releases.ac25.b3000types.PenArrayItem])¶

Bases: archicad.acbasetype._ACBaseType

A pen table attribute.

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
pens (list of PenArrayItem) – A collection of pens in a pen table.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, pens: List[archicad.releases.ac25.b3000types.PenArrayItem])¶

class PenTableAttributeOrError(penTableAttribute: Optional[archicad.releases.ac25.b3000types.PenTableAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A pen table attribute or an error.

Variables

penTableAttribute (PenTableAttribute, optional) – A pen table attribute.
error (Error, optional) – The details of an error.

__init__(penTableAttribute: Optional[archicad.releases.ac25.b3000types.PenTableAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, penTableAttribute: Optional[archicad.releases.ac25.b3000types.PenTableAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class PenTableAttributeWrapper(penTableAttribute: archicad.releases.ac25.b3000types.PenTableAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: penTableAttribute (PenTableAttribute) – A pen table attribute.

__init__(penTableAttribute: archicad.releases.ac25.b3000types.PenTableAttribute)¶

class Point2D(x: float, y: float)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

x (float) – X coordinate of 2D point
y (float) – Y coordinate of 2D point

__init__(x: float, y: float)¶

class PossibleEnumValue(enumValueId: archicad.releases.ac25.b3000types.EnumValueId, displayValue: str, nonLocalizedValue: Optional[str] = None)¶

Bases: archicad.acbasetype._ACBaseType

The description of an enumeration value.

Variables

enumValueId (EnumValueId) – The identifier of a property enumeration value.
displayValue (str) – Displayed value of the enumeration.
nonLocalizedValue (str, optional) – Nonlocalized value of the enumeration if there is one.

__init__(enumValueId: archicad.releases.ac25.b3000types.EnumValueId, displayValue: str, nonLocalizedValue: Optional[str] = None)¶

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

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(enumValue: archicad.releases.ac25.b3000types.PossibleEnumValue)¶

class ProfileAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, useWith: List[str], width: float, height: float, minimumWidth: float, minimumHeight: float, widthStretchable: bool, heightStretchable: bool, hasCoreSkin: bool, profileModifiers: List[archicad.releases.ac25.b3000types.ProfileModifierListItem])¶

Bases: archicad.acbasetype._ACBaseType

A profile attribute.

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
useWith (list of str) – A list of element types.
width (float) – The default width (horizontal size) of the profile.
height (float) – The default height (vertical size) of the profile.
minimumWidth (float) – The minimum width (horizontal size) of the profile.
minimumHeight (float) – The minimum height (vertical size) of the profile.
widthStretchable (bool) – Defines whether the profile’s width can be increased beyond its default value or not.
heightStretchable (bool) – Defines whether the profile’s height can be increased beyond its default value or not.
hasCoreSkin (bool) – Defines whether the profile has a core skin or not.
profileModifiers (list of ProfileModifierListItem) – A list of profile modifiers.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, useWith: List[str], width: float, height: float, minimumWidth: float, minimumHeight: float, widthStretchable: bool, heightStretchable: bool, hasCoreSkin: bool, profileModifiers: List[archicad.releases.ac25.b3000types.ProfileModifierListItem])¶

class ProfileAttributeOrError(profileAttribute: Optional[archicad.releases.ac25.b3000types.ProfileAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A profile attribute or an error.

Variables

profileAttribute (ProfileAttribute, optional) – A profile attribute.
error (Error, optional) – The details of an error.

__init__(profileAttribute: Optional[archicad.releases.ac25.b3000types.ProfileAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, profileAttribute: Optional[archicad.releases.ac25.b3000types.ProfileAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class ProfileAttributeWrapper(profileAttribute: archicad.releases.ac25.b3000types.ProfileAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: profileAttribute (ProfileAttribute) – A profile attribute.

__init__(profileAttribute: archicad.releases.ac25.b3000types.ProfileAttribute)¶

class ProfileModifier(name: str, value: float)¶

Bases: archicad.acbasetype._ACBaseType

A profile modifier parameter.

Variables

name (str) – The name of the modifier.
value (float) – The value of the modifier.

__init__(name: str, value: float)¶

class ProfileModifierListItem(profileModifier: archicad.releases.ac25.b3000types.ProfileModifier)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables: profileModifier (ProfileModifier) – A profile modifier parameter.

__init__(profileModifier: archicad.releases.ac25.b3000types.ProfileModifier)¶

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

Bases: archicad.acbasetype._ACBaseType

A property definition.

Variables

group (PropertyGroup) – A property group.
name (str) – The localized name of the property.
description (str) – The description of the property.
possibleEnumValues (list of PossibleEnumValuesArrayItem, optional) – A list of enumeration values.

__init__(group: archicad.releases.ac25.b3000types.PropertyGroup, name: str, description: str, possibleEnumValues: Optional[List[archicad.releases.ac25.b3000types.PossibleEnumValuesArrayItem]] = None)¶

class PropertyDefinitionOrError(propertyDefinition: Optional[archicad.releases.ac25.b3000types.PropertyDefinition] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A property definition or an error.

Variables

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

__init__(propertyDefinition: Optional[archicad.releases.ac25.b3000types.PropertyDefinition] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, propertyDefinition: Optional[archicad.releases.ac25.b3000types.PropertyDefinition] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

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

Bases: archicad.acbasetype._ACBaseType

Variables: propertyDefinition (PropertyDefinition) – A property definition.

__init__(propertyDefinition: archicad.releases.ac25.b3000types.PropertyDefinition)¶

class PropertyGroup(name: str)¶

Bases: archicad.acbasetype._ACBaseType

A property group.

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

__init__(name: str)¶

class PropertyId(guid: uuid.UUID)¶

Bases: archicad.acbasetype._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.

__init__(guid: uuid.UUID)¶

class PropertyIdArrayItem(propertyId: archicad.releases.ac25.b3000types.PropertyId)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

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

__init__(propertyId: archicad.releases.ac25.b3000types.PropertyId)¶

class PropertyIdOrError(propertyId: Optional[archicad.releases.ac25.b3000types.PropertyId] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A property identifier or an error.

Variables

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

__init__(propertyId: Optional[archicad.releases.ac25.b3000types.PropertyId] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, propertyId: Optional[archicad.releases.ac25.b3000types.PropertyId] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class PropertyUserId(type: str, localizedName: Optional[List[str]] = None, nonLocalizedName: Optional[str] = None)¶

Bases: archicad.acbasetype._ACUnionType

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

Variables

type (str) – None
localizedName (list of str, optional) – A two-element list of the localized name parts. The first element is the name of the group the property belongs to, and the second element is the actual name of the property.
nonLocalizedName (str, optional) – The non-localized name of the Built-In Property.

__init__(type: str, localizedName: Optional[List[str]] = None, nonLocalizedName: Optional[str] = None)¶

static __new__(cls, type: str, localizedName: Optional[List[str]] = None, nonLocalizedName: Optional[str] = None)¶

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

class PropertyValue(type: str, status: str, value: Optional[Union[float, int, str, bool, List[float], List[int], List[str], List[bool], archicad.releases.ac25.b3000types.EnumValueId, List[archicad.releases.ac25.b3000types.EnumValueIdWrapper]]] = None)¶

Bases: archicad.acbasetype._ACUnionType

A normal, userUndefined, notAvailable or notEvaluated property value.

Variables

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

__init__(type: str, status: str, value: Optional[Union[float, int, str, bool, List[float], List[int], List[str], List[bool], archicad.releases.ac25.b3000types.EnumValueId, List[archicad.releases.ac25.b3000types.EnumValueIdWrapper]]] = None)¶

static __new__(cls, type: str, status: str, value: Optional[Union[float, int, str, bool, List[float], List[int], List[str], List[bool], archicad.releases.ac25.b3000types.EnumValueId, List[archicad.releases.ac25.b3000types.EnumValueIdWrapper]]] = None)¶

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

class PropertyValueOrErrorItem(propertyValue: Optional[archicad.releases.ac25.b3000types.PropertyValue] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A property value or an error

Variables

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

__init__(propertyValue: Optional[archicad.releases.ac25.b3000types.PropertyValue] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, propertyValue: Optional[archicad.releases.ac25.b3000types.PropertyValue] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

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

Bases: archicad.acbasetype._ACBaseType

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

__init__(propertyValue: archicad.releases.ac25.b3000types.PropertyValue)¶

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

Bases: archicad.acbasetype._ACUnionType

A list of property values or an error.

Variables

propertyValues (list of PropertyValueOrErrorItem, optional) – A list of property values.
error (Error, optional) – The details of an error.

__init__(propertyValues: Optional[List[archicad.releases.ac25.b3000types.PropertyValueOrErrorItem]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, propertyValues: Optional[List[archicad.releases.ac25.b3000types.PropertyValueOrErrorItem]] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

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

Bases: archicad.acbasetype._ACBaseType

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

__init__(propertyValues: List[archicad.releases.ac25.b3000types.PropertyValueOrErrorItem])¶

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

Bases: archicad.acbasetype._ACBaseType

The identifier of a publisher set.

Variables

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

__init__(name: str, type: str = 'PublisherSets')¶

class RGBColor(red: float, green: float, blue: float)¶

Bases: archicad.acbasetype._ACBaseType

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

Variables

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

__init__(red: float, green: float, blue: float)¶

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

Bases: archicad.acbasetype._ACBaseType

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

Variables

name (str) – The name for the layout subset.
includeToIDSequence (bool) – Defines whether this subset is included in automatic ID assignment or not.
customNumbering (bool) – Defines whether the IDs are generated automatically or a custom numbering is used.
continueNumbering (bool) – Defines whether to continue using the ID assignment of the upper levels or not. If ‘true’, layouts within this subset are going to be assigned IDs as if they were not within this subset, but part of the level above. In this case you only use the Subset as a logical grouping which has no effect on IDs.
useUpperPrefix (bool) – Defines whether to use the prefix and ID of the upper levels or not. If ‘true’, layouts in this subset will be assigned IDs based on the previous layout in the layout book structure.
addOwnPrefix (bool) – Defines whether to add own prefix to the subset or not.
customNumber (str) – The custom subset ID.
autoNumber (str) – The automatic subset ID.
numberingStyle (str) – A supported numbering style.
startAt (int) – The starting value of the numbering.
ownPrefix (str) – The custom prefix for the subset.

__init__(name: str, includeToIDSequence: bool, customNumbering: bool, continueNumbering: bool, useUpperPrefix: bool, addOwnPrefix: bool, customNumber: str, autoNumber: str, numberingStyle: str, startAt: int, ownPrefix: str)¶

class SuccessfulExecutionResult(success: bool)¶

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables: success (bool) – EMPTY STRING

__init__(success: bool)¶

class SurfaceAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, materialType: str, ambientReflection: int, diffuseReflection: int, specularReflection: int, transparencyAttenuation: int, emissionAttenuation: int, surfaceColor: archicad.releases.ac25.b3000types.RGBColor, specularColor: archicad.releases.ac25.b3000types.RGBColor, emissionColor: archicad.releases.ac25.b3000types.RGBColor, fillId: archicad.releases.ac25.b3000types.AttributeIdOrError, transparency: int, shine: int, texture: Optional[archicad.releases.ac25.b3000types.Texture] = None)¶

Bases: archicad.acbasetype._ACBaseType

A surface attribute.

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
materialType (str) – The material type of a surface attribute.
ambientReflection (int) – The ambient reflection of the surface attribute.
diffuseReflection (int) – The diffuse reflection of the surface attribute.
specularReflection (int) – The specular reflection of the surface attribute.
transparencyAttenuation (int) – The transparency attenuation of the surface attribute.
emissionAttenuation (int) – The emission attenuation of the surface attribute.
surfaceColor (RGBColor) – A color model represented via its red, green and blue components.
specularColor (RGBColor) – A color model represented via its red, green and blue components.
emissionColor (RGBColor) – A color model represented via its red, green and blue components.
fillId (AttributeIdOrError) – The attribute’s identifier or an error.
transparency (int) – The transparency of the surface attribute.
shine (int) – The shininess of the surface attribute.
texture (Texture, optional) – A texture

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, materialType: str, ambientReflection: int, diffuseReflection: int, specularReflection: int, transparencyAttenuation: int, emissionAttenuation: int, surfaceColor: archicad.releases.ac25.b3000types.RGBColor, specularColor: archicad.releases.ac25.b3000types.RGBColor, emissionColor: archicad.releases.ac25.b3000types.RGBColor, fillId: archicad.releases.ac25.b3000types.AttributeIdOrError, transparency: int, shine: int, texture: Optional[archicad.releases.ac25.b3000types.Texture] = None)¶

class SurfaceAttributeOrError(surfaceAttribute: Optional[archicad.releases.ac25.b3000types.SurfaceAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A surface attribute or an error.

Variables

surfaceAttribute (SurfaceAttribute, optional) – A surface attribute.
error (Error, optional) – The details of an error.

__init__(surfaceAttribute: Optional[archicad.releases.ac25.b3000types.SurfaceAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, surfaceAttribute: Optional[archicad.releases.ac25.b3000types.SurfaceAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class SurfaceAttributeWrapper(surfaceAttribute: archicad.releases.ac25.b3000types.SurfaceAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: surfaceAttribute (SurfaceAttribute) – A surface attribute.

__init__(surfaceAttribute: archicad.releases.ac25.b3000types.SurfaceAttribute)¶

class Texture(name: str)¶

Bases: archicad.acbasetype._ACBaseType

A texture

Variables: name (str) – The name of the texture.

__init__(name: str)¶

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

Bases: archicad.acbasetype._ACBaseType

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

Variables

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

__init__(localizedName: List[str], type: str = 'UserDefined')¶

class UserUndefinedPropertyValue(type: str, status: str = 'userUndefined')¶

Bases: archicad.acbasetype._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

__init__(type: str, status: str = 'userUndefined')¶

class ZoneCategoryAttribute(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, categoryCode: str, stampName: str, stampMainGuid: uuid.UUID, stampRevisionGuid: uuid.UUID, color: archicad.releases.ac25.b3000types.RGBColor)¶

Bases: archicad.acbasetype._ACBaseType

A zone category.

Variables

attributeId (AttributeId) – The identifier of an attribute.
name (str) – The name of an attribute.
categoryCode (str) – The category code of the zone.
stampName (str) – The stamp name of the zone category.
stampMainGuid (UUID) – A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
stampRevisionGuid (UUID) – A Globally Unique Identifier (or Universally Unique Identifier) in its string representation as defined in RFC 4122.
color (RGBColor) – A color model represented via its red, green and blue components.

__init__(attributeId: archicad.releases.ac25.b3000types.AttributeId, name: str, categoryCode: str, stampName: str, stampMainGuid: uuid.UUID, stampRevisionGuid: uuid.UUID, color: archicad.releases.ac25.b3000types.RGBColor)¶

class ZoneCategoryAttributeOrError(zoneCategoryAttribute: Optional[archicad.releases.ac25.b3000types.ZoneCategoryAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

Bases: archicad.acbasetype._ACUnionType

A zone category attribute or an error.

Variables

zoneCategoryAttribute (ZoneCategoryAttribute, optional) – A zone category.
error (Error, optional) – The details of an error.

__init__(zoneCategoryAttribute: Optional[archicad.releases.ac25.b3000types.ZoneCategoryAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

static __new__(cls, zoneCategoryAttribute: Optional[archicad.releases.ac25.b3000types.ZoneCategoryAttribute] = None, error: Optional[archicad.releases.ac25.b3000types.Error] = None)¶

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

class ZoneCategoryAttributeWrapper(zoneCategoryAttribute: archicad.releases.ac25.b3000types.ZoneCategoryAttribute)¶

Bases: archicad.acbasetype._ACBaseType

Variables: zoneCategoryAttribute (ZoneCategoryAttribute) – A zone category.

__init__(zoneCategoryAttribute: archicad.releases.ac25.b3000types.ZoneCategoryAttribute)¶

__weakref__¶: list of weak references to the object (if defined)

class archicad.Utilities(actypes: archicad.releases.ac25.b3000types.Types, accommands: archicad.releases.ac25.b3000commands.Commands)¶

Bases: object

Utility functions for the archicad module.

FindClassificationItemInSystem(system_name: str, item_id: str) → Optional[archicad.releases.ac25.b3000types.ClassificationItemId]¶: Finds the classification item in a system.

FindClassificationSystem(systemName: str) → Optional[archicad.releases.ac25.b3000types.ClassificationSystemId]¶: Finds the classification system.

static FindInClassificationItemTree(treeRootItem: archicad.releases.ac25.b3000types.ClassificationItemInTree, criterion: Callable[[archicad.releases.ac25.b3000types.ClassificationItemInTree], bool]) → List[archicad.releases.ac25.b3000types.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: archicad.releases.ac25.b3000types.NavigatorItem, criterion: Callable[[archicad.releases.ac25.b3000types.NavigatorItem], bool]) → List[archicad.releases.ac25.b3000types.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) → archicad.releases.ac25.b3000types.PropertyId¶: Returns the PropertyId of the corresponding built-in property.

GetDisplayValueFromPropertyEnumValueId(propertyId: archicad.releases.ac25.b3000types.PropertyId, enumValueId: archicad.releases.ac25.b3000types.EnumValueId) → str¶

Returns the display value of an enumeration property value.

Parameters

propertyId (PropertyId) – The identifier of the property.
enumValueId (EnumValueId) – The enumeration value identifier.

Returns

The display value of the enumeration property value.

Return type

str

GetPropertyValuesDictionary(elements: List[archicad.releases.ac25.b3000types.ElementId], propertyIds: List[archicad.releases.ac25.b3000types.PropertyId]) → Dict[archicad.releases.ac25.b3000types.ElementId, Dict[archicad.releases.ac25.b3000types.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) → archicad.releases.ac25.b3000types.PropertyId¶: Returns the PropertyId of the corresponding user-defined property.

GetValueFromPropertyValue(propertyId: archicad.releases.ac25.b3000types.PropertyId, propertyValue: archicad.releases.ac25.b3000types.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.

__init__(actypes: archicad.releases.ac25.b3000types.Types, accommands: archicad.releases.ac25.b3000commands.Commands)¶

__weakref__¶: list of weak references to the object (if defined)

archicad.handle_dependencies(*module_names: str, install_missing_modules: bool = True)¶

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

Parameters

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

archicad¶

Module contents¶

API Python Wrapper

Navigation

Related Topics