archicad.releases.ac24

archicad.releases.ac24.b3000commands

GRAPHISOFT

class archicad.releases.ac24.b3000commands.Commands(req: urllib.request.Request)

Bases: object

Collection of the ARCHICAD JSON interface commands

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

Creates a new layout subset.

Parameters
  • subsetParameters (Subset) – Provides a way to assign IDs to the layouts contained in the subset.

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

Returns

The identifier of a navigator item.

Return type

NavigatorItemId

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

Deletes items from navigator tree.

Parameters

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

Returns

Execution result for each input case.

Return type

list of ExecutionResult

Get2DBoundingBoxes(elements: List[archicad.releases.ac24.b3000types.ElementIdArrayItem]) List[archicad.releases.ac24.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 <i>Element Information</i>.

Parameters

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

Returns

List of element’s 2D bounding boxes.

Return type

list of BoundingBox2DOrError

Get3DBoundingBoxes(elements: List[archicad.releases.ac24.b3000types.ElementIdArrayItem]) List[archicad.releases.ac24.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 <i>Element Information</i>.

Parameters

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

Returns

List of element’s 3D bounding boxes

Return type

list of BoundingBox3DOrError

GetAllClassificationSystems() List[archicad.releases.ac24.b3000types.ClassificationSystem]

Returns the list of available classification systems.

Returns

The list of classification systems.

Return type

list of ClassificationSystem

GetAllClassificationsInSystem(classificationSystemId: archicad.releases.ac24.b3000types.ClassificationSystemId) List[archicad.releases.ac24.b3000types.ClassificationItemArrayItem]

Returns the tree of classifications in the given classification system.

Parameters

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

Returns

The list of classification items.

Return type

list of ClassificationItemArrayItem

GetAllElements() List[archicad.releases.ac24.b3000types.ElementIdArrayItem]

Returns the identifier of every element in the current plan.

Returns

List of the elements.

Return type

list of ElementIdArrayItem

GetAllPropertyNames() List[archicad.releases.ac24.b3000types.PropertyUserId]

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

Returns

List of PropertyUserId objects.

Return type

list of PropertyUserId

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

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

Parameters
  • elements (list of ElementIdArrayItem) – List of the elements.

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

Returns

The list of element classification identifiers or errors.

Return type

list of ElementClassificationOrError

GetDetailsOfClassificationItems(classificationItemIds: List[archicad.releases.ac24.b3000types.ClassificationItemIdArrayItem]) List[archicad.releases.ac24.b3000types.ClassificationItemOrError]

Returns the details of classification items.

Parameters

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

Returns

The list of classification items or errors.

Return type

list of ClassificationItemOrError

GetDetailsOfProperties(properties: List[archicad.releases.ac24.b3000types.PropertyIdArrayItem]) List[archicad.releases.ac24.b3000types.PropertyDefinitionOrError]

Returns the details of property definitions.

Parameters

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

Returns

The list of property definitions or errors.

Return type

list of PropertyDefinitionOrError

GetElementsByClassification(classificationItemId: archicad.releases.ac24.b3000types.ClassificationItemId) List[archicad.releases.ac24.b3000types.ElementIdArrayItem]

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

Parameters

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

Returns

List of the elements.

Return type

list of ElementIdArrayItem

GetElementsByType(elementType: str) List[archicad.releases.ac24.b3000types.ElementIdArrayItem]

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

Parameters

elementType (str) – The type of an element.

Returns

List of the elements.

Return type

list of ElementIdArrayItem

GetElementsRelatedToZones(zones: List[archicad.releases.ac24.b3000types.ElementIdArrayItem], elementTypes: Optional[List[str]] = None) List[archicad.releases.ac24.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) – List of the elements.

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

Returns

List of elements or error.

Return type

list of ElementsOrError

GetLayoutSettings(layoutNavigatorItemId: archicad.releases.ac24.b3000types.NavigatorItemId) archicad.releases.ac24.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

GetNavigatorItemTree(navigatorTreeId: archicad.releases.ac24.b3000types.NavigatorTreeId) archicad.releases.ac24.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

GetProductInfo() Tuple[int, int, str]

Accesses the version information from the running ARCHICAD.

Returns

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

Return type

int

GetPropertyIds(properties: List[archicad.releases.ac24.b3000types.PropertyUserId]) List[archicad.releases.ac24.b3000types.PropertyIdOrError]

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

Parameters

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

Returns

The list of property identifiers or errors.

Return type

list of PropertyIdOrError

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

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

Parameters
  • elements (list of ElementIdArrayItem) – List of the elements.

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

Returns

List of property value lists.

Return type

list of PropertyValuesOrError

GetPublisherSetNames() List[str]

Returns the names of available publisher sets.

Returns

The names of available publisher sets.

Return type

list of str

IsAlive() bool

Checks if the ARCHICAD connection is alive.

Returns

Returns true if the connection is alive.

Return type

bool

MoveNavigatorItem(navigatorItemIdToMove: archicad.releases.ac24.b3000types.NavigatorItemId, parentNavigatorItemId: archicad.releases.ac24.b3000types.NavigatorItemId, previousNavigatorItemId: Optional[archicad.releases.ac24.b3000types.NavigatorItemId] = None)

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

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

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

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

RenameNavigatorItem(navigatorItemId: archicad.releases.ac24.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.ac24.b3000types.ElementClassification]) List[archicad.releases.ac24.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) – The list of element classification identifiers.

Returns

Execution result for each input case.

Return type

list of ExecutionResult

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

Sets the property values of elements.

Parameters

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

Returns

Execution result for each input case.

Return type

list of ExecutionResult

__init__(req: urllib.request.Request)
__weakref__

list of weak references to the object (if defined)

exception archicad.releases.ac24.b3000commands.UnsucceededCommandCall

Bases: Exception

__weakref__

list of weak references to the object (if defined)

archicad.releases.ac24.b3000types

GRAPHISOFT

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

Bases: archicad.acbasetype._ACBaseType

2D bounding box of an element.

Variables
  • xMin (float) – Minimum X value of bounding box.

  • yMin (float) – Minimum Y value of bounding box.

  • xMax (float) – Maximum X value of bounding box.

  • yMax (float) – Maximum Y value of bounding box.

__init__(xMin: float, yMin: float, xMax: float, yMax: float)
class archicad.releases.ac24.b3000types.BoundingBox2DOrError(boundingBox2D: Optional[archicad.releases.ac24.b3000types.BoundingBox2D] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)

Bases: archicad.acbasetype._ACUnionType

A 2D bounding box or error.

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

  • error (Error, optional) – Error details.

__init__(boundingBox2D: Optional[archicad.releases.ac24.b3000types.BoundingBox2D] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, boundingBox2D: Optional[archicad.releases.ac24.b3000types.BoundingBox2D] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.BoundingBox2DWrapper(boundingBox2D: archicad.releases.ac24.b3000types.BoundingBox2D)

Bases: archicad.acbasetype._ACBaseType

Variables

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

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

Bases: archicad.acbasetype._ACBaseType

3D bounding box of an element.

Variables
  • xMin (float) – Minimum X value of bounding box.

  • yMin (float) – Minimum Y value of bounding box.

  • zMin (float) – Minimum Z value of bounding box.

  • xMax (float) – Maximum X value of bounding box.

  • yMax (float) – Maximum Y value of bounding box.

  • zMax (float) – Maximum Z value of bounding box.

__init__(xMin: float, yMin: float, zMin: float, xMax: float, yMax: float, zMax: float)
class archicad.releases.ac24.b3000types.BoundingBox3DOrError(boundingBox3D: Optional[archicad.releases.ac24.b3000types.BoundingBox3D] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)

Bases: archicad.acbasetype._ACUnionType

A 3D bounding box or error.

Variables
  • boundingBox3D (BoundingBox3D, optional) – 3D bounding box of an element.

  • error (Error, optional) – Error details.

__init__(boundingBox3D: Optional[archicad.releases.ac24.b3000types.BoundingBox3D] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, boundingBox3D: Optional[archicad.releases.ac24.b3000types.BoundingBox3D] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.BoundingBox3DWrapper(boundingBox3D: archicad.releases.ac24.b3000types.BoundingBox3D)

Bases: archicad.acbasetype._ACBaseType

Variables

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

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

Bases: archicad.acbasetype._ACBaseType

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

Variables
  • nonLocalizedName (str) – Non-localized name of the Built-In Property.

  • type (str) – EMPTY STRING

__init__(nonLocalizedName: str, type: str = 'BuiltIn')
class archicad.releases.ac24.b3000types.ClassificationId(classificationSystemId: archicad.releases.ac24.b3000types.ClassificationSystemId, classificationItemId: Optional[archicad.releases.ac24.b3000types.ClassificationItemId] = None)

Bases: archicad.acbasetype._ACBaseType

The element classification identifier.

Variables
__init__(classificationSystemId: archicad.releases.ac24.b3000types.ClassificationSystemId, classificationItemId: Optional[archicad.releases.ac24.b3000types.ClassificationItemId] = None)
class archicad.releases.ac24.b3000types.ClassificationIdOrError(classificationId: Optional[archicad.releases.ac24.b3000types.ClassificationId] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)

Bases: archicad.acbasetype._ACUnionType

EMPTY STRING

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

  • error (Error, optional) – Error details.

__init__(classificationId: Optional[archicad.releases.ac24.b3000types.ClassificationId] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, classificationId: Optional[archicad.releases.ac24.b3000types.ClassificationId] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.ClassificationIdWrapper(classificationId: archicad.releases.ac24.b3000types.ClassificationId)

Bases: archicad.acbasetype._ACBaseType

Variables

classificationId (ClassificationId) – The element classification identifier.

__init__(classificationId: archicad.releases.ac24.b3000types.ClassificationId)
class archicad.releases.ac24.b3000types.ClassificationIdsOrErrorsWrapper(classificationIds: List[archicad.releases.ac24.b3000types.ClassificationIdOrError])

Bases: archicad.acbasetype._ACBaseType

Variables

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

__init__(classificationIds: List[archicad.releases.ac24.b3000types.ClassificationIdOrError])
class archicad.releases.ac24.b3000types.ClassificationItemArrayItem(classificationItem: archicad.releases.ac24.b3000types.ClassificationItemInTree_)

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

classificationItem (ClassificationItemInTree_) – Details of a classification item.

__init__(classificationItem: archicad.releases.ac24.b3000types.ClassificationItemInTree_)
class archicad.releases.ac24.b3000types.ClassificationItemDetails(id: str, name: str, description: str)

Bases: archicad.acbasetype._ACBaseType

Details of a classification item.

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

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

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

__init__(id: str, name: str, description: str)
class archicad.releases.ac24.b3000types.ClassificationItemDetailsWrapper(classificationItem: archicad.releases.ac24.b3000types.ClassificationItemDetails)

Bases: archicad.acbasetype._ACBaseType

Variables

classificationItem (ClassificationItemDetails) – Details of a classification item.

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

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

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

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

Bases: archicad.acbasetype._ACBaseType

Details of a classification item.

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

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

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

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

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

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

alias of archicad.releases.ac24.b3000types.ClassificationItemInTree

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

Bases: archicad.acbasetype._ACUnionType

EMPTY STRING

Variables
__init__(classificationItem: Optional[archicad.releases.ac24.b3000types.ClassificationItemDetails] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, classificationItem: Optional[archicad.releases.ac24.b3000types.ClassificationItemDetails] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.ClassificationSystem(classificationSystemId: archicad.releases.ac24.b3000types.ClassificationSystemId, name: str, description: str, source: str, version: str, date: str)

Bases: archicad.acbasetype._ACBaseType

Details of a classification system.

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

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

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

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

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

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

__init__(classificationSystemId: archicad.releases.ac24.b3000types.ClassificationSystemId, name: str, description: str, source: str, version: str, date: str)
class archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.ClassificationSystemIdArrayItem(classificationSystemId: archicad.releases.ac24.b3000types.ClassificationSystemId)

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

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

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

Bases: archicad.acbasetype._ACBaseType

Element classification.

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

  • classificationId (ClassificationId) – The element classification identifier.

__init__(elementId: archicad.releases.ac24.b3000types.ElementId, classificationId: archicad.releases.ac24.b3000types.ClassificationId)
class archicad.releases.ac24.b3000types.ElementClassificationOrError(classificationIds: Optional[List[archicad.releases.ac24.b3000types.ClassificationIdOrError]] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)

Bases: archicad.acbasetype._ACUnionType

Element classification identifiers or error.

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

  • error (Error, optional) – Error details.

__init__(classificationIds: Optional[List[archicad.releases.ac24.b3000types.ClassificationIdOrError]] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, classificationIds: Optional[List[archicad.releases.ac24.b3000types.ClassificationIdOrError]] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.ElementIdArrayItem(elementId: archicad.releases.ac24.b3000types.ElementId)

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

elementId (ElementId) – The identifier of an element.

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

Bases: archicad.acbasetype._ACBaseType

A property value with the identifier of the property and the owner element.

Variables
__init__(elementId: archicad.releases.ac24.b3000types.ElementId, propertyId: archicad.releases.ac24.b3000types.PropertyId, propertyValue: archicad.releases.ac24.b3000types.NormalOrUserUndefinedPropertyValue)
class archicad.releases.ac24.b3000types.ElementsOrError(elements: Optional[List[archicad.releases.ac24.b3000types.ElementIdArrayItem]] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)

Bases: archicad.acbasetype._ACUnionType

List of elements or error.

Variables
  • elements (list of ElementIdArrayItem, optional) – List of the elements.

  • error (Error, optional) – Error details.

__init__(elements: Optional[List[archicad.releases.ac24.b3000types.ElementIdArrayItem]] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, elements: Optional[List[archicad.releases.ac24.b3000types.ElementIdArrayItem]] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.ElementsWrapper(elements: List[archicad.releases.ac24.b3000types.ElementIdArrayItem])

Bases: archicad.acbasetype._ACBaseType

List of elements.

Variables

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

__init__(elements: List[archicad.releases.ac24.b3000types.ElementIdArrayItem])
archicad.releases.ac24.b3000types.EnumValueId

The identifier of a property enumeration value.

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

Bases: archicad.acbasetype._ACBaseType

Variables

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

__init__(enumValueId: archicad.releases.ac24.b3000types.DisplayValueEnumId)
class archicad.releases.ac24.b3000types.Error(code: int, message: str)

Bases: archicad.acbasetype._ACBaseType

Error details.

Variables
  • code (int) – The error code.

  • message (str) – The error message.

__init__(code: int, message: str)
class archicad.releases.ac24.b3000types.ErrorItem(error: archicad.releases.ac24.b3000types.Error)

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

error (Error) – Error details.

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

Bases: archicad.acbasetype._ACUnionType

The result of the execution for one case.

Variables
  • success (bool) – None

  • error (Error, optional) – Error details.

__init__(success: bool, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, success: bool, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.FailedExecutionResult(success: bool, error: archicad.releases.ac24.b3000types.Error)

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables
  • success (bool) – EMPTY STRING

  • error (Error) – Error details.

__init__(success: bool, error: archicad.releases.ac24.b3000types.Error)
class archicad.releases.ac24.b3000types.FolderParameters(name: str)

Bases: archicad.acbasetype._ACBaseType

The parameters of a folder.

Variables

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

__init__(name: str)
class archicad.releases.ac24.b3000types.LayoutParameters(horizontalSize: float, verticalSize: float, leftMargin: float, topMargin: float, rightMargin: float, bottomMargin: float, customLayoutNumber: str, customLayoutNumbering: bool, doNotIncludeInNumbering: bool, displayMasterLayoutBelow: bool, layoutPageNumber: int, actPageIndex: int, currentRevisionId: str, currentFinalRevisionId: str, hasIssuedRevision: bool, hasActualRevision: bool)

Bases: archicad.acbasetype._ACBaseType

The parameters of the layout.

Variables
  • horizontalSize (float) – Horizontal size of the layout in millimeters.

  • verticalSize (float) – Vertical size of the layout in millimeters.

  • leftMargin (float) – Layout margin from the left side of the paper.

  • topMargin (float) – Layout margin from the top side of the paper.

  • rightMargin (float) – Layout margin from the right side of the paper.

  • bottomMargin (float) – Layout margin from the bottom side of the paper.

  • customLayoutNumber (str) – Specifies the custom ID.

  • customLayoutNumbering (bool) – Defines whether a unique ID is used for the current layout or not.

  • doNotIncludeInNumbering (bool) – Indicates whether this layout is included in or excluded from automatic ID assignment.

  • displayMasterLayoutBelow (bool) – Display the master layout above or below the layout.

  • layoutPageNumber (int) – Page number of layout when this layout contains multi-page drawings.

  • actPageIndex (int) – The actual index of layout inside the multi-page layout.

  • currentRevisionId (str) – ID of the current document revision of the layout.

  • currentFinalRevisionId (str) – ID with optional suffix of the current document revision of the layout.

  • hasIssuedRevision (bool) – One or more issued document revisions have already been created for the layout.

  • hasActualRevision (bool) – An open document revision exists for the layout.

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

Bases: archicad.acbasetype._ACBaseType

Details of a navigator item.

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

  • prefix (str) – Prefix of the name of the navigator item.

  • name (str) – Name of the navigator item.

  • type (str) – Possible types of a navigator item. Most of the names are self-explanatory, the only exception is ‘UndefinedItem’, which means that the type of this navigator item cannot be retrieved from ARCHICAD yet.

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

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

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

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

navigatorItem (NavigatorItem_) – Details of a navigator item.

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

Bases: archicad.acbasetype._ACBaseType

Variables

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

__init__(navigatorItemId: archicad.releases.ac24.b3000types.NavigatorItemId)
archicad.releases.ac24.b3000types.NavigatorItem_

alias of archicad.releases.ac24.b3000types.NavigatorItem

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

Bases: archicad.acbasetype._ACBaseType

A tree of navigator items.

Variables

rootItem (NavigatorItem) – Details of a navigator item.

__init__(rootItem: archicad.releases.ac24.b3000types.NavigatorItem)
class archicad.releases.ac24.b3000types.NavigatorTreeId(type: str, name: Optional[str] = None)

Bases: archicad.acbasetype._ACUnionType

The identifier of a navigator item tree.

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

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

__init__(type: str, name: Optional[str] = None)
static __new__(cls, type: str, name: Optional[str] = None)
class archicad.releases.ac24.b3000types.NormalAngleListPropertyValue(value: List[float], type: str = 'angleList', status: str = 'normal')

Bases: archicad.acbasetype._ACBaseType

A angle list property value containing angles in an array. Values are measured in SI (radians).

Variables
  • value (list of float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

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

Bases: archicad.acbasetype._ACBaseType

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

Variables
  • value (float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

__init__(value: float, type: str = 'angle', status: str = 'normal')
class archicad.releases.ac24.b3000types.NormalAreaListPropertyValue(value: List[float], type: str = 'areaList', status: str = 'normal')

Bases: archicad.acbasetype._ACBaseType

A area list property value containing areas in an array. Values are measured in SI (square meters).

Variables
  • value (list of float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

__init__(value: List[float], type: str = 'areaList', status: str = 'normal')
class archicad.releases.ac24.b3000types.NormalAreaPropertyValue(value: float, type: str = 'area', status: str = 'normal')

Bases: archicad.acbasetype._ACBaseType

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

Variables
  • value (float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

__init__(value: float, type: str = 'area', status: str = 'normal')
class archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.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. 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 archicad.releases.ac24.b3000types.NormalLengthPropertyValue(value: float, type: str = 'length', status: str = 'normal')

Bases: archicad.acbasetype._ACBaseType

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

Variables
  • value (float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

__init__(value: float, type: str = 'length', status: str = 'normal')
class archicad.releases.ac24.b3000types.NormalMultiEnumPropertyValue(value: List[archicad.releases.ac24.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) – List of enumeration identifiers.

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

__init__(value: List[archicad.releases.ac24.b3000types.EnumValueIdWrapper], type: str = 'multiEnum', status: str = 'normal')
class archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.NormalOrUserUndefinedPropertyValue(type: str, status: str, value: Optional[Union[float, int, str, bool, List[float], List[int], List[str], List[bool], archicad.releases.ac24.b3000types.DisplayValueEnumId, List[archicad.releases.ac24.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.; 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.ac24.b3000types.DisplayValueEnumId, List[archicad.releases.ac24.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.ac24.b3000types.DisplayValueEnumId, List[archicad.releases.ac24.b3000types.EnumValueIdWrapper]]] = None)
class archicad.releases.ac24.b3000types.NormalSingleEnumPropertyValue(value: archicad.releases.ac24.b3000types.DisplayValueEnumId, 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.ac24.b3000types.DisplayValueEnumId, type: str = 'singleEnum', status: str = 'normal')
class archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.NormalVolumeListPropertyValue(value: List[float], type: str = 'volumeList', status: str = 'normal')

Bases: archicad.acbasetype._ACBaseType

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

Variables
  • value (list of float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

__init__(value: List[float], type: str = 'volumeList', status: str = 'normal')
class archicad.releases.ac24.b3000types.NormalVolumePropertyValue(value: float, type: str = 'volume', status: str = 'normal')

Bases: archicad.acbasetype._ACBaseType

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

Variables
  • value (float) – EMPTY STRING

  • type (str) – EMPTY STRING

  • status (str) – EMPTY STRING

__init__(value: float, type: str = 'volume', status: str = 'normal')
class archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.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 archicad.releases.ac24.b3000types.OtherNavigatorTreeId(type: str)

Bases: archicad.acbasetype._ACBaseType

The identifier of a navigator item tree.

Variables

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

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

Bases: archicad.acbasetype._ACBaseType

Description of an enumeration value.

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

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

__init__(enumValueId: archicad.releases.ac24.b3000types.DisplayValueEnumId, displayValue: str)
class archicad.releases.ac24.b3000types.PossibleEnumValuesArrayItem(enumValue: archicad.releases.ac24.b3000types.PossibleEnumValue)

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

enumValue (PossibleEnumValue) – Description of an enumeration value.

__init__(enumValue: archicad.releases.ac24.b3000types.PossibleEnumValue)
class archicad.releases.ac24.b3000types.PropertyDefinition(group: archicad.releases.ac24.b3000types.PropertyGroup, name: str, description: str, possibleEnumValues: Optional[List[archicad.releases.ac24.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) – List of enumeration values.

__init__(group: archicad.releases.ac24.b3000types.PropertyGroup, name: str, description: str, possibleEnumValues: Optional[List[archicad.releases.ac24.b3000types.PossibleEnumValuesArrayItem]] = None)
class archicad.releases.ac24.b3000types.PropertyDefinitionOrError(propertyDefinition: Optional[archicad.releases.ac24.b3000types.PropertyDefinition] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)

Bases: archicad.acbasetype._ACUnionType

A property definition or error.

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

  • error (Error, optional) – Error details.

__init__(propertyDefinition: Optional[archicad.releases.ac24.b3000types.PropertyDefinition] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, propertyDefinition: Optional[archicad.releases.ac24.b3000types.PropertyDefinition] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.PropertyDefinitionWrapper(propertyDefinition: archicad.releases.ac24.b3000types.PropertyDefinition)

Bases: archicad.acbasetype._ACBaseType

Variables

propertyDefinition (PropertyDefinition) – A property definition.

__init__(propertyDefinition: archicad.releases.ac24.b3000types.PropertyDefinition)
class archicad.releases.ac24.b3000types.PropertyGroup(name: str)

Bases: archicad.acbasetype._ACBaseType

A property group.

Variables

name (str) – The property group name.

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

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

propertyId (PropertyId) – The identifier of a property.

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

Bases: archicad.acbasetype._ACUnionType

A property identifier or error.

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

  • error (Error, optional) – Error details.

__init__(propertyId: Optional[archicad.releases.ac24.b3000types.PropertyId] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, propertyId: Optional[archicad.releases.ac24.b3000types.PropertyId] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.PropertyUserId(type: str, localizedName: Optional[List[str]] = None, nonLocalizedName: Optional[str] = None)

Bases: archicad.acbasetype._ACUnionType

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

Variables
  • type (str) – None

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

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

__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)
class archicad.releases.ac24.b3000types.PropertyValue(type: str, status: str, value: Optional[Union[float, int, str, bool, List[float], List[int], List[str], List[bool], archicad.releases.ac24.b3000types.DisplayValueEnumId, List[archicad.releases.ac24.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.; 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.ac24.b3000types.DisplayValueEnumId, List[archicad.releases.ac24.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.ac24.b3000types.DisplayValueEnumId, List[archicad.releases.ac24.b3000types.EnumValueIdWrapper]]] = None)
class archicad.releases.ac24.b3000types.PropertyValueOrErrorItem(propertyValue: Optional[archicad.releases.ac24.b3000types.PropertyValue] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)

Bases: archicad.acbasetype._ACUnionType

Contains a property value or an error for the property.

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

  • error (Error, optional) – Error details.

__init__(propertyValue: Optional[archicad.releases.ac24.b3000types.PropertyValue] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, propertyValue: Optional[archicad.releases.ac24.b3000types.PropertyValue] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.PropertyValueWrapper(propertyValue: archicad.releases.ac24.b3000types.PropertyValue)

Bases: archicad.acbasetype._ACBaseType

Variables

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

__init__(propertyValue: archicad.releases.ac24.b3000types.PropertyValue)
class archicad.releases.ac24.b3000types.PropertyValuesOrError(propertyValues: Optional[List[archicad.releases.ac24.b3000types.PropertyValueOrErrorItem]] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)

Bases: archicad.acbasetype._ACUnionType

Contains either a list of property values or an error.

Variables
__init__(propertyValues: Optional[List[archicad.releases.ac24.b3000types.PropertyValueOrErrorItem]] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
static __new__(cls, propertyValues: Optional[List[archicad.releases.ac24.b3000types.PropertyValueOrErrorItem]] = None, error: Optional[archicad.releases.ac24.b3000types.Error] = None)
class archicad.releases.ac24.b3000types.PropertyValuesWrapper(propertyValues: List[archicad.releases.ac24.b3000types.PropertyValueOrErrorItem])

Bases: archicad.acbasetype._ACBaseType

Variables

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

__init__(propertyValues: List[archicad.releases.ac24.b3000types.PropertyValueOrErrorItem])
class archicad.releases.ac24.b3000types.PublisherSetId(name: str, type: str = 'PublisherSets')

Bases: archicad.acbasetype._ACBaseType

The identifier of a publisher set.

Variables
  • name (str) – Name of the publisher set.

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

__init__(name: str, type: str = 'PublisherSets')
class archicad.releases.ac24.b3000types.Subset(name: str, includeToIDSequence: bool, customNumbering: bool, continueNumbering: bool, useUpperPrefix: bool, addOwnPrefix: bool, customNumber: str, autoNumber: str, numberingStyle: str, startAt: int, ownPrefix: str)

Bases: archicad.acbasetype._ACBaseType

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

Variables
  • name (str) – Defines the name for the layout subset.

  • includeToIDSequence (bool) – Indicates whether this subset is included in or excluded from automatic ID assignment.

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

  • continueNumbering (bool) – Continue using the ID assignment of upper levels. Layouts within this subset are going to be assigned IDs as if they were not within this subset, but part of the level above. In this case you are only using the Subset as a logical grouping which has no effect on IDs.

  • useUpperPrefix (bool) – Use the prefix and ID of upper levels. Layouts in this subset will be assigned IDs based on the previous layout in the layout book structure.

  • addOwnPrefix (bool) – Adds own prefix to the subset.

  • customNumber (str) – Specifies the custom subset ID.

  • autoNumber (str) – Specifies the automatic subset ID.

  • numberingStyle (str) – List of the supported numbering styles.

  • startAt (int) – Specifies a number from which the numbering starts.

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

__init__(name: str, includeToIDSequence: bool, customNumbering: bool, continueNumbering: bool, useUpperPrefix: bool, addOwnPrefix: bool, customNumber: str, autoNumber: str, numberingStyle: str, startAt: int, ownPrefix: str)
class archicad.releases.ac24.b3000types.SuccessfulExecutionResult(success: bool)

Bases: archicad.acbasetype._ACBaseType

EMPTY STRING

Variables

success (bool) – EMPTY STRING

__init__(success: bool)
class archicad.releases.ac24.b3000types.UserDefinedPropertyUserId(localizedName: List[str], type: str = 'UserDefined')

Bases: archicad.acbasetype._ACBaseType

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

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

  • type (str) – EMPTY STRING

__init__(localizedName: List[str], type: str = 'UserDefined')
class archicad.releases.ac24.b3000types.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')

archicad.releases.ac24.b3000utilities

class archicad.releases.ac24.b3000utilities.Utilities(actypes: archicad.releases.ac24.b3000types.Types, accommands: archicad.releases.ac24.b3000commands.Commands)

Bases: object

Utility functions for the archicad module.

FindClassificationItemInSystem(system_name: str, item_id: str) Optional[archicad.releases.ac24.b3000types.ClassificationItemId]

Finds the classification item in a system.

FindClassificationSystem(systemName: str) Optional[archicad.releases.ac24.b3000types.ClassificationSystemId]

Finds the classification system.

static FindInClassificationItemTree(treeRootItem: archicad.releases.ac24.b3000types.ClassificationItemInTree, criterion: Callable[[archicad.releases.ac24.b3000types.ClassificationItemInTree], bool]) List[archicad.releases.ac24.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.ac24.b3000types.NavigatorItem, criterion: Callable[[archicad.releases.ac24.b3000types.NavigatorItem], bool]) List[archicad.releases.ac24.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.ac24.b3000types.PropertyId

Returns the PropertyId of the corresponding built-in property.

GetDisplayValueFromPropertyEnumValueId(propertyId: archicad.releases.ac24.b3000types.PropertyId, enumValueId: archicad.releases.ac24.b3000types.DisplayValueEnumId) str

Returns the display value of an enumeration property value.

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

  • enumValueId (EnumValueId) – The enumeration value identifier.

Returns

The display value of the enumeration property value.

Return type

str

GetPropertyValuesDictionary(elements: List[archicad.releases.ac24.b3000types.ElementId], propertyIds: List[archicad.releases.ac24.b3000types.PropertyId]) Dict[archicad.releases.ac24.b3000types.ElementId, Dict[archicad.releases.ac24.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.ac24.b3000types.PropertyId

Returns the PropertyId of the corresponding user-defined property.

GetValueFromPropertyValue(propertyId: archicad.releases.ac24.b3000types.PropertyId, propertyValue: archicad.releases.ac24.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.ac24.b3000types.Types, accommands: archicad.releases.ac24.b3000commands.Commands)
__weakref__

list of weak references to the object (if defined)

Module contents