topic Re: Python - List of names of the built-in properties in Archicad Python API

Python - List of names of the built-in properties

dushyant — Wed, 15 Sep 2021 08:33:32 GMT

Hello
Does any know how to fetch the list of all the available built-in properties like "General_ElementID" for 'Element ID' available in the Python API?

Thanks.

Re: Python - List of names of the built-in properties

poco2013 — Tue, 21 Jul 2020 16:01:28 GMT

The Property name for ElenentID is: IdAndCategoies_ElementID Built-ins use a single name with the group first , then underline then name . User properties separate the group and property name which is why they require separate functions to recall.

You can get a list of all properties by using the function GetAllPropertyNames()

Re: Python - List of names of the built-in properties

dushyant — Tue, 21 Jul 2020 17:32:39 GMT

Thanks. GetAllPropertyNames() lists all the 'BuiltIn' and even 'UserDefined' properties.

What did you mean by "User properties separate the group and property name which is why they require separate functions to recall." ?

Re: Python - List of names of the built-in properties

poco2013 — Tue, 21 Jul 2020 18:26:45 GMT

There are separate functions to get the Property ID for the built-in properties vs custom user properties.
acu,GetUserDefinedPropertyId which takes a group name and property name

acu.GetBuiltinPropertId which takes only the property name.

OR

You could create separate property classes (PropertUserId) one for builtin and one for property custom. The difference types require different inputs. Then use the common function acc.GetPropertyId(PropertyUserId) for both.

Re: Python - List of names of the built-in properties

dushyant — Tue, 21 Jul 2020 18:29:42 GMT

Got it, thanks!

Re: Python - List of names of the built-in properties

Tibor Lorantfy — Wed, 22 Jul 2020 10:28:41 GMT

Hi Guys,

There are two different types of Properties in ARCHICAD: User-Defined and Built-In.

User-Defined Properties
The User-Defined Properties are the ones you see in the Property Manager Dialog. Users can modify the name of these Properties so you can access them by the name you see on the user interface. We call this localized name. The localized name contains two strings the Group Name and the Property Name (as seen in Property Manager Dialog) and it's unique. Note, there can be two User-Defined Properties in two separate Groups with the same Property Name.

Please note, these User-Defined Properties are belong to the current project and may be not available in other projects. So if you refer to any User-Defined Property in your Python script, then it may not work with some projects.

Built-In Properties
The Built-In Properties are the ones defined by ARCHICAD. The user can't modify the name of these Properties so you can access them by their internal name. We call this non-localized name. If you use properties with non-localized names your script will be independent of the language of the ARCHICAD user interface.

Note, the non-localized names of Built-In Properties won't be changed between ARCHICAD updates and versions. So if you refer to any Built-In Properties in your Python script, then your script should work with any projects and any ARCHICAD versions.

You can find all the available Built-In Properties and currently available User-Defined Properties with the GetAllPropertyNames command.

As Python API is based on the JSON API, I recommend you to read the documentation of the JSON API:
http://archicadapi.graphisoft.com/JSONInterfaceDocumentation/#Property_Information

Re: Python - List of names of the built-in properties

dushyant — Wed, 22 Jul 2020 10:47:12 GMT

Ok, thanks for the info!

Re: Python - List of names of the built-in properties

Tibor Lorantfy — Wed, 22 Jul 2020 10:53:07 GMT

Python script examples for listing property values:

By using GetBuiltInPropertyId and GetUserDefinedPropertyId utility functions to retrieve the identifiers of the properties:

from archicad import ACConnection

conn = ACConnection.connect()
acc = conn.commands
act = conn.types
acu = conn.utilities

zoneNumberPropertyId = acu.GetBuiltInPropertyId('Zone_ZoneNumber')
elementIdPropertyId = acu.GetBuiltInPropertyId('General_ElementID')
zonesTemperatureReqPropertyId = acu.GetUserDefinedPropertyId('ZONES', 'Temperature Requirement')
propertyIds = [
	zoneNumberPropertyId,
	elementIdPropertyId,
	zonesTemperatureReqPropertyId
]

propertyValuesDictionary = acu.GetPropertyValuesDictionary(acc.GetAllElements(), propertyIds)
for elementId, valuesDictionary in propertyValuesDictionary.items():
	for propertyId, value in valuesDictionary.items():
		print(f"{elementId} {propertyId} {value}")

By using GetPropertyIds command to batch retrieve the identifier of the properties:

from archicad import ACConnection

conn = ACConnection.connect()
acc = conn.commands
act = conn.types
acu = conn.utilities

propertyIds = acc.GetPropertyIds([
	act.BuiltInPropertyUserId('Zone_ZoneNumber'),
	act.BuiltInPropertyUserId('General_ElementID'),
	act.UserDefinedPropertyUserId(['ZONES', 'Temperature Requirement']),
])

propertyValuesDictionary = acu.GetPropertyValuesDictionary(acc.GetAllElements(), propertyIds)
for elementId, valuesDictionary in propertyValuesDictionary.items():
	for propertyId, value in valuesDictionary.items():
		print(f"{elementId} {propertyId} {value}")

The result of the scripts above is exactly the same. But there is performance difference.
If you want to optimize your Python script for performance (run time), then you should minimize the executed commands, because each of them requires communication between ARCHICAD which has costs.
All utility functions (acu) execute one or more commands (acc) to help writing python scripts. Every GetBuiltInPropertyId and GetUserDefinedPropertyId utility functions call GetPropertyIds command once, so the first script above communicates with ARCHICAD more and runs slower (however it's not sensible in this case).

Re: Python - List of names of the built-in properties

dushyant — Wed, 22 Jul 2020 12:35:15 GMT

On trying both of the codes, I get this:

    print(f"{elementId.guid} {propertyId.guid} {value}")
AttributeError: 'ElementIdArrayItem' object has no attribute 'guid'

Re: Python - List of names of the built-in properties

poco2013 — Wed, 22 Jul 2020 14:32:57 GMT

Would have to see how you named ElementIdArrayItem , but assuming it is elemenId (confusing naming) , a return for guid would be elementId.elementId.guid

Re: Python - List of names of the built-in properties

dushyant — Wed, 22 Jul 2020 15:49:39 GMT

poco2013 wrote:
Would have to see how you named ElementIdArrayItem , but assuming it is elemenId (confusing naming) , a return for guid would be elementId.elementId.guid

You are right, it should be: elementId.elementId.guid and propertyId.propertyId.guid

print(f"{elementId.elementId.guid} {propertyId.propertyId.guid} {value}")

Re: Python - List of names of the built-in properties

Anonymous — Tue, 20 Jul 2021 13:58:06 GMT

Tibor wrote:
You can find all the available Built-In Properties and currently available User-Defined Properties with the GetAllPropertyNames command.

Can you help me to print the list of PropertyNames? my code is:

{
"command": "API.GetAllPropertyNames"
}

and result is:

==========

Выполнение скрипта test.py

=== Процесс завершен ===

I am trying to add to the script "excel_export.py" the list of names of objects and i can`t find the BuiltInProperty, which helps to call them.
thank you for your help and ask you to forgive me for my english:)