GRAPHISOFT®

Python APIVersion: 0.23 Beta

GetFavorites

Returns the list of the favorites with the given type.

def GetFavorites (typeID) -> List (String)

 

Parameters

typeID
[in] Element type ID. See API_ElemTypeID for available element types.
variationID (optional)
[in] Element variation ID, optional parameter. See API_ElemVariationID for available element variations.

 

Return Values

This function returns the list of the names of favorites which have the given type.

 

Remarks

This function is analogous to the ACAPI_Favorite_GetNum function of the C++ API.

 

Example

wallFavoriteList = GetFavorites(API_WallID)
print("Number of favorites with wall type: {}".format(len(wallFavoriteList)))

 

Requirements

Version: Python API 0.2 or Later
Module: GS

 

See Also

GetElementType, ApplyFavorite

All functions