Model.reviewclearbyid#

Model.reviewclearbyid(entity, review_type)#

Removes/clears entities from the review list based on an entity.

Parameters:
  • entity (Entity) – The object describing the entity to add to the review list. Valid values are blocks and groups.

  • review_type (int) –

    The review type to control.

    For blocks:

    1 - Nodes

    2 - Elements

    For groups:

    1 - Secondary only

    2 - Main only

    3 - Main and secondary

Example#

Remove main and secondary review of group with ID 5 from the review list#
import hm
import hm.entities as ent

model = hm.Model()

model.reviewclearbyid(entity=ent.Group(model, 5), review_type=3)