Element Renumbering en - kuvbur/AddOn_SomeStuff GitHub Wiki

Element Numbering

Example file for AC25

Elements with the same value for the criterion property are assigned the same numbers (positions).

For numbering to work, two properties must be created:

  • A flag property to enable numbering
  • A property to store the position (number)

Numbering rules and flags are specified in the element's property descriptions.

v1.7+ When numbering, the positions of selected locked elements (including those within a module) are considered.

v1.74+ If only one element is selected, all elements from visible layers that have the numbering rules of the selected element available will be processed.

Numbering enable flag in one of the formats

Flag Format Description Version
Renum_flag{property_name} Standard numbering
Renum_flag{property_name ; NULL} Automatic zero-padding considering groups (e.g., 1001)
Renum_flag{property_name ; SPACE} Automatic space-padding considering groups (e.g., 1 1) v1.6
Renum_flag{property_name ; ALLNULL} Automatic zero-padding without considering groups
Renum_flag{property_name ; ALLSPACE} Automatic space-padding without considering groups
Renum_flag{property_name ; n_NULL} Fixed zero-padding (up to n characters) considering groups v1.76
Renum_flag{property_name ; n_SPACE} Fixed space-padding (up to n characters) considering groups v1.76
Renum_flag{property_name ; n_ALLNULL} Fixed zero-padding (up to n characters) without considering groups v1.76
Renum_flag{property_name ; n_ALLSPACE} Fixed space-padding (up to n characters) without considering groups v1.76

Operation specifics:

  1. Automatic length determination:

    • For NULL/SPACE/ALLNULL/ALLSPACE, the padding length is determined by the maximum position in the group
    • Example: positions [5, 12, 100] → number of characters in the maximum position is 3 → padding length → 005, 012, 100
  2. Fixed length specification (n_* commands):

    • n - minimum length of the resulting string
    • If the maximum position is longer than n - the actual length is used
    • Example: 4_NULL for positions [1, 25, 100]0001, 0025, 0100

Property name with the rule is specified in the format Property:group name/property name Data type of the flag property: Criterion (TRUE/FALSE), v1.6 or a set of parameters with values Add, Renumber, Exclude

Example 1 Example 2

Position property in one of the formats

Format Description Version
Renum{criterion_property_name} Standard numbering by one criterion
Renum{criterion_property_name; split_property_name} Numbering with grouping by an additional property
Renum{library_parameter_criterion} Using a library element parameter instead of a criterion property v1.6
Renum{library_parameter_criterion; library_parameter_split} Using library element parameters for both criteria v1.6

Clarifications:

  1. Criterion property - defines the group of elements for joint numbering
  2. Split property - separates one numbering group from another. Each group has independent numbering.
  3. Library parameters must be accessible via the Archicad API

Example 3 Example 4

To write the resulting position to the ID, add Sync_to{ID} to the description of the position property.

Example 5

Possible Errors

Error Message Cause Solution
Properties specified in numbering rules not found
Some elements were not numbered due to errors in properties
Numbering change is not required
Error in numbering rule
⚠️ **GitHub.com Fallback** ⚠️