Model.hm_getentitytypedictionary

Model.hm_getentitytypedictionary(entity_type)

Certain entity card images have organizational types defined in the templates which are used by the panels and the browsers to filter and organize the available entity card images (dictionaries). This function returns a list of available types defined in the current template for the specified entity_type.

The function Model.hm_getentitycardimagedictionary() can then be used to get a list of card images that are of the specified type.

Parameters:

entity_type (EntityFullType) – Entity type. Currently supported for properties and materials.

Returns:

• hwReturnStatus - Status object

• HmQueryResult - Result object containing the output values:

  • availableTypes (list of strings)

Example

Return the list of organizational types for propertiess defined in the current template

import hm
import hm.entities as ent

model = hm.Model()

_, result = model.hm_getentitytypedictionary(entity_type=ent.Property)

print("Available Types:", result.availableTypes)