You are here: HomeSupportArchiCAD

Listing Parameters

Written by Lászlo Nagy

Element Type

Type: string
Possible values: see list below
Returns a string stating the type of the element being listed.
The possible values are the following: Wall, Column, Beam, Window, Door, Slab, Roof, Object, Lamp, Mesh, Fill.
Note: in the list these string are usually displayed in all CAPITALS.

Listing_Parameters010425-00.png
The eleven Element types that can be listed.


View Pen

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen used to draw the contours of the element in views (not the contours of cut surfaces) as defined in the Settings Dialog of the element.
Note: since a Fill is not a 3D element, this parameter returns no value in case of a Fill.


Section Pen

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen used to draw the contours of the cut surfaces of the element in Section/Elevation Windows as defined in the Settings Dialog of the element.
Note: in case of Fills the index number of the pen used to draw the contour of the Fill in the Floor Plan Window is returned.


Composite Section Pens

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index numbers of the pens used to draw the contours of each skin of the composite structure of the element (Wall, Slab or Roof) as defined in the Composite Structures Dialog or the Settings Dialog of the element.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many pen index numbers as the number of skins in the composite structure used for that Wall/Slab/Roof.
Here is how it works: if the ‘Use Line & Fill Colors of Composite’ checkbox is not checked in the Wall/Slab/Roof Settings Dialog then one pen index number is returned several times. This is the index number of the pen used to draw the fill pattern of the Wall/Slab/Roof in section. The reason is because this is the pen used for all the fills and contours of all skins of the composite.

Listing_Parameters010425-01.png
The field (above) returned in the list when ‘Composite Section Pens’ is used in the case the ‘ Use Line & Fill Colors of Composite’ checkbox (below) is not checked.

If the ‘Use Line & Fill Colors of Composite’ checkbox is checked then the index numbers of the pens defined for each skin contour of the composite are returned.

Listing_Parameters010425-02.png
The field in the Composite Structures Dialog returned in the list under ‘Composite Section Pens’ when the ‘Use Line & Fill Colors of Composite’ checkbox is checked in the element’s Settings Dialog

Note: the pen index numbers are returned from top to bottom as defined in the Composite Structures Dialog (pen index number for top skin of the composite structure first, second top skin second and so on).


Line Type

Type: string
Possible length: max. 31 characters
Returns in a string the name of the line type used to draw the element in the Floor Plan Window (e.g. ‘Solid Line” or ‘Dot & Dashed’) as set in the element’s Settings Dialog.
Note: In case of Beams it returns the name of the line type used to draw the contours of the Beam (and not the one for its axis).

Listing_Parameters010425-03.png
Values returned in a list under the heading of ‘Line Type’


Fill Name / Composite Name

Type: string
Possible length: max. 31 characters
Returns in a string the name of the simple Fill (such as ‘solid fill’ or ‘roof, insulated’) or the name of the Composite Structure (in case of Walls, Slabs and Roofs) assigned to the element. This Fill or Composite will be used in the Section/Elevation Windows and/or in the Floor Plan Window (for Walls, Columns and Fills).
Note: in case of Columns it returns the Fill assigned to the Column core (the Fill assigned to the veneer is not returned).


Composite Fill Names

Type: string
Possible length: max. 31 characters
Returns in strings the names of the Fills used for each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many Fill names as the number of skins in the composite structure used for that Wall/Slab/Roof. In case of other types of elements one Fill name is returned (since they are assigned a single Fill) and it is the same string as the one returned under ‘Fill Name’.
Note: the Fill names are returned from top to bottom as defined in the Composite Structures Dialog (Fill for top skin of the composite structure first, Fill for second top skin second and so on).

Listing_Parameters010425-04.png
The values returned in a list under ‘Composite Fill Names’


Fill Pen

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen assigned to draw the fill pattern of the cut surfaces of the element in the Section/Elevation Windows.
Note: in case of Column the Fill assigned to draw the fill pattern of the core is returned (the Fill of the veneer is not). In case of Walls/Slabs/Roofs the default Fill pen index assigned to the section of the element in the Settings Dialog is returned regardless of whether the ‘Use Fill Colors of Composite’ checkbox is checked or not. In case of Fills the index number of the pen used to draw the fill pattern of the Fill in the Floor Plan Window is returned (since it is not a 3D element).


Composite Fill Pens

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index numbers of the pens used to draw the fill pattern of each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many pen index numbers as the number of skins in the composite structure used for that Wall/Slab/Roof. Just as in the case of ‘Composite Section Pens’ the pen index values defined in the Composite Structures Dialog are used when the ‘Use Fill Colors of Composite’ checkbox is checked in the Wall/Slab/Roof Settings Dialog. Otherwise the values set in the elements’ Dialog are returned. In case of other types of elements one pen index number is returned (since they are assigned a single Fill) and it is the same string as the one returned under ‘Fill Pen’.
Note: the pen index numbers are returned from top to bottom as defined in the Composite Structures Dialog (pen index number of fill of top skin of the composite structure first, pen index number of second top skin second and so on).

Listing_Parameters010425-05.png
The values returned in a list under ‘Composite Fill Pens’ (‘Use Line & Fill Colors of Composite’ is checked in the Wall Settings Dialog).


Fill Background Pen

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen assigned to draw the background of the fill pattern of the cut surfaces of the element in the Section/Elevation Windows.
Note: in case of Column the Fill assigned to draw the background of the fill pattern of the core is returned (the fill background pen of the veneer is not). In case of Walls/Slabs/Roofs the index of the default fill background pen assigned to the section of the element in the Settings Dialog is returned regardless of whether the ‘Use Background Colors of Composite’ checkbox is checked or not. In case of Fills the index number of the pen used to draw the background of the fill pattern of the Fill in the Floor Plan Window is returned (since it is not a 3D element).


Composite Fill Background Pens

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index numbers of the pens used to draw the background of the fill pattern of each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many pen index numbers as the number of skins in the composite structure used for that Wall/Slab/Roof. The pen index values defined in the Composite Structures Dialog are used when the ‘Use Background Colors of Composite’ checkbox is checked in the Wall/Slab/Roof Settings Dialog. Otherwise the values set in the elements’ Dialog are returned. In case of other types of elements one pen index number is returned (since they are assigned a single Fill) and it is the same string as the one returned under ‘Fill Background Pen’.
Note: the pen index numbers are returned from top to bottom as defined in the Composite Structures Dialog (pen index number of fill background of top skin of the composite structure first, pen index number of second top skin second and so on).

Listing_Parameters010425-06.png
The values returned in a list under ‘Composite Fill Background Pens’ (‘Use Background Colors of Composite’ is checked in the Wall Settings Dialog).


Material

Type: string
Possible length: max. 31 characters
Returns in strings the names of materials (such as ‘Whitewash’ or ‘Plaster, smooth’) assigned to various surfaces of the element as seen in the 3D Window. For each element as many material names will be returned as the total number of materials definable in the Settings Dialog of that element. The following table shows the number of materials returned in case of each element type and the order in which they are returned:

Element type
Number of materials returned
Order in which
Materials are returned
Wall
3
  1. Reference Line side of Wall
  2. side of Wall opposite to Reference line side
  3. edges of Wall
Column
1
N/A
Beam
5
  1. left side of Beam relative to its Reference line
  2. top of Beam
  3. right side of Beam relative to its Reference line
  4. bottom of Beam
  5. ends of Beam
Window
1
N/A
Door
1
N/A
Slab
3
  1. top of Slab
  2. bottom of Slab
  3. edges of Slab
Roof
3
  1. top of Roof
  2. bottom of Roof
  3. edges of Roof
Object
1
N/A
Lamp
1
N/A
Mesh
3
  1. surface (top) of Mesh
  2. bottom of Mesh
  3. skirt (edges) of Mesh
Fill
N/A
N/A

Note: no material is returned for a Fill since it is not a 3D-element type.
In case of Mesh all three materials are returned even in case the Mesh doesn’t actually have a skirt and/or a bottom as set in its Settings Dialog.

Listing_Parameters010425-07.png
The values returned in a list under ‘Material’


Layer Name

Type: string
Possible length: max. 31 characters
Returns in a string the name of the layer (such as ‘ArchiCAD’ or ‘Exterior walls’) the element is assigned to appear on.
Note: no value is returned in case of Doors/Windows since they are always assigned to the layer of the Wall they as placed into.

Listing_Parameters010425-08.png
The values returned in a list under ‘Layer Name’, “User ID’ and ‘Internal ID’


User ID

Type: string
Possible length: max. 15 characters
Returns in a string the User ID assigned to the element as set in the Listing Attributes portion of its Settings Dialog.


Internal ID

Type: numerical (positive integer value)
Possible range: 1 and up
Returns the number internally assigned to each created element by ArchiCAD. This is a unique ID in case of each and every element and can not be modified.


Surface

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the size of the various surfaces of each element. The surface sizes are returned in the order stated at ‘Material’ in this writing.
Notes: in case of Meshes, when no bottom surface/skirt is present as set in its Settings Dialog, zero is returned for the surfaces of these. In case of Library Parts, zero is returned if the Library Part has no such 3D parts generated which can have a 3D surface size. In case of Fills the area of the Fill in the Floor Plan Window is returned. In case of Roofs the calculated surfaces are the slanted surfaces not the areas of the Roof surface projected to the horizontal plane).
In case of Walls the surface area of Windows/Doors/holes is deducted from the full surface of the Wall if they are larger then the value set in the List Setup Dialog. In case of other elements containing holes all surface areas of holes are deducted.

Listing_Parameters010425-09.png
The field in the List Setup Dialog where you can set how large a Wall opening must be to be deducted from the Wall’s surface/volume in lists


Volume

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns in numerical form the volume of each element.
Note: in case of Meshes, when no bottom surface/skirt is present as set in its Settings Dialog, zero is returned for the volume of these. In case of Library Parts, zero is returned if the Library Part has no such 3D parts generated which can have a 3D surface size. In case of Fills no value returned since it is not a 3D element so this category doesn’t apply.
In case of Walls – similarly to ‘Surface’ - the volume of Windows/Doors/holes is deducted from the total volume of the Wall if they are larger then the value set in the List Setup Dialog. In case of other elements containing holes all volumes of holes are deducted.


Composite Volumes

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns the volumes of each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many volumes as the number of skins in the composite structure used for that Wall/Slab/Roof. If you add up the volumes returned you will get the number returned under ‘Volume’ (the total volume of the Wall/Slab/Roof). In case of other types of elements one volume amount is returned and it is the same value as the one returned under ‘Volume’.
Note: the volumes are returned from top to bottom as defined in the Composite Structures Dialog (volume for top skin of the composite structure first, volume for second top skin second and so on). Hole volumes are deducted the same way as in case of ‘Volume’.


Thickness/Size

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns either one or two numbers for each element giving information about the thickness or x-y size of the element. The following table shows which measurements the parameter returns in case of each element type:

Element type
Number of values returned
Measurements returned
Wall
1
Thickness of Wall
Column
2
  1. Horizontal size of Column (including veneer)
  2. Vertical size of Column (including veneer)
Beam
1
Width of Beam
Window
2
  1. Width of Window
  2. Frame depth of Window (defined among parameters)
Door
2
  1. Width of Door
  2. Frame thickness of Door (defined among parameters)
Slab
1
Thickness of Slab
Roof
1
Thickness of Roof perpendicular to is slope (not its vertical thickness)
Object
2
  1. Horizontal size of Object (X coordinate)
  2. Vertical size of Object (Y coordinate)
Lamp
2
  1. Horizontal size of Lamp (X coordinate)
  2. Vertical size of Lamp (Y coordinate)
Mesh
1
Thickness of skirt of Mesh
Fill
N/A
N/A

Note: if the Mesh is only a surface zero is returned by this parameter. In case of Fills no value is returned as it is not a 3D element.

Listing_Parameters010425-10.png
The values returned in a list under ‘Thickness-Size’


Composite Thicknesses

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the thickness of each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many thickness values as the number of skins in the composite structure used for that Wall/Slab/Roof. If you add up the thicknesses returned you get the number returned under ‘Thickness/Size’ (the total thickness of the Wall/Slab/Roof). In case of other types of elements one or two thickness amounts are returned and are the same values as the ones returned under ‘Thickness/Size’.
Note: the thicknesses are returned from top to bottom as defined in the Composite Structures Dialog (thickness for top skin of the composite structure first, thickness for second top skin second and so on).


Height

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the height of the element.
Note: in case of Fills the parameter returns zero as it is not a 3D element. In case of Slabs, Roofs and Meshes the parameter returns zero, as these element types do not have a ‘height’ (they have a thickness). In case of Objects/Lamps it returns zero unless a ‘zzyzx’ variable is defined for the Object/Lamp in its Library Part Editor as the first parameter in which case the height field appears in its Settings Dialog and can be set to a value other than zero.

Listing_Parameters010425-11.png
The values returned in a list under ‘Height’


Library Part Name

Type: string
Possible length: max. 27 characters
Returns in a string the name of the Library Part type element.
Note: The parameter returns a valid string in case of Doors, Windows Objects and Lamps. In case of all other elements this parameter doesn’t apply.

Listing_Parameters010425-12.png
The values returned in a list under ‘Library Part Name’


Associated Property Object

Type: string
Possible length: max. 27 characters
Returns in a string the name of the Property Object that was individually linked to the element in the ‘Listing Attributes’ tab page of the element’s Settings Dialog.

Listing_Parameters010425-13.png
The field in an element’s Settings Dialog where the Property Object can be linked to the element.

Listing_Parameters010425-14.png
The values returned in a list under ‘Associated Property Object’


Property Part(s) by Criteria

Type: string
Possible length: max. 27 characters
Returns in string the names of those Property Objects that were linked to the element automatically by the program because they fulfilled certain selection criteria. The list of these is shown on ‘Listing Attributes’ tab page of the element’s Settings Dialog.

Listing_Parameters010425-15.png
The values returned in a list under ‘Property Part(s) by Criteria’


Base Elevation

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the base elevation of the element relative to the elevation of the story the element is placed on.
Note: this means different things in case of various element types. In case of Walls and Columns it means the elevation of the bottom surface of the element. In case of Beams and Slabs it means the elevation of the top surface of the element. In case of Doors and Windows it means the elevation of the bottom of the Door/Window relative to the Wall they are placed into. In case the Door/Window has dimensions, the ‘Subfloor thickness’ value of the Door/Window Dimension Subdialog can modify this value. In case of Roof it means the elevation of the pivot line of the Roof. In case of Objects and Lamps it is the elevation of the Object/Lamp’s local origin. For a Mesh it is the elevation of the top of the Mesh’s skirt. For Fills it is always zero because it is not a 3D element.

Listing_Parameters010425-16.png
The values returned in a list under ‘Base Elevation’


Associated Label

Type: string
Possible length: approx. 30000 characters
Returns in a string the text of the Label associated with the element. It returns a valid string if ‘Text’, ‘ID’ or Internal ID’ is selected for Label Content in the top of the Label Settings Dialog. It returns no value if any other Label object is selected. The returned string will be the string generated by ArchiCAD (with ‘ID’ or ‘Internal ID’) or typed by the user (with ’Text’).


Associated Label Object

Type: string
Possible length: max. 27 characters
Returns in a string the name of the Label Object that has been associated with the element. It returns no value when ‘Text’, ‘ID’ or Internal ID’ is selected for Label Content in the top of the Label Settings Dialog.

Listing_Parameters010425-17.png
The values returned in a list under ‘Associated Label’ and ‘Associated Label Object’


Zone Category Code

Type: string
Possible length: max. 31 characters
Returns in a string the category code (such as ‘2 HNF’) of the Zone in which the element type is located as they are defined in the Zone Categories Dialog. The parameter returns a valid string for Columns, Beams, Objects and Lamps, maximum two strings for Walls, Doors and Windows.

Listing_Parameters010425-18.png
The values returned in a list under ‘Zone Category Code’, ‘Zone Category Name’, ‘Zone Name’ and ‘Zone Number’


Zone Category Name

Type: string
Possible length: max. 31 characters
Returns in a string the category name (such as ‘2 Office’) of the Zone in which the element type is located as they are defined in the Zone Categories Dialog. The parameter returns a valid string for Columns, Beams, Objects and Lamps, maximum two strings for Walls, Doors and Windows.


Zone Name

Type: string
Possible length: max. 31 characters
Returns in a string the name (such as ‘Living Room’) of the Zone in which the element type is located as they are defined in the Zone Categories Dialog. The parameter returns a valid string for Columns, Beams, Objects and Lamps, maximum two strings for Walls, Doors and Windows.


Zone Number

Type: string
Possible length: max. 31 characters
Returns in a string the number (such as ‘001’) of the Zone in which the element type is located as they are defined in the Zone Categories Dialog. The parameter returns a valid string for Columns, Beams, Objects and Lamps, maximum two strings for Walls, Doors and Windows.


Split Zone Number 1/ Split Zone Number 2/ Split Zone Number 3/ Split Zone Number 4

Type: string
Possible range: the total length of all 4 variable added together (with the 3 dots in between) is max. 31 characters
A Zone Number can be set in such a way that it is composed of a maximum of 4 numbers (or strings for that matter) separated by dots (‘.’) and these be used to express relationships between Zones and the Project itself. For example, “B.C.06.45” might mean Room 45 on Story 6 in Wing ‘C’ of Building ‘B’. These four listing parameters return for each Zone the first, second, third and fourth portion, respectively, of such a Zone Number. These four listing parameters return for each Wall, Column, Window/Door, Object or Lamp the first, second, third and fourth portion of such a Zone Number (‘B’, ‘C’, ‘06’ and ‘45’, respectively) of that Zone located next to them (for Walls, Windows/Doors) or in which they are located (for Columns, Objects and Lamps).


Story Index

Type: numerical (integer value)
Possible range: approx. -15000 – approx. 15000
Returns a number corresponding to the index of the Story the element is placed on.
Note: in case of Doors/Windows the same Story Index will be returned as that of the Wall into which they are placed.

Listing_Parameters010425-19.png
The values returned in a list under ‘Story Index’ and ‘Story Name’


Story Name

Type: string
Possible length: max. 25 characters
Returns in a string the name of the Story the element is placed on.
Note: in case of Doors/Windows the same Story Name will be returned as that of the Wall into which they are placed.

Extra Parameters of the Selected Types:

Sill of the Window/Door

Type: numerical (real value)
Possible range: positive, negative or zero (in meters)
Returns the sill depth of Window/Door as was set in their Settings Dialog. If the Window/Door has a reveal the parameter will return the Reveal Depth value.
Note: the value can be even negative which means the body of the Window/Door can be outside the body of the Wall enclosing them.

Listing_Parameters010425-20.png
The value returned in a list under ‘Sill of the Window/Door’


Window/Door jamb on the left side/ Window/Door jamb on the right side

Type: numerical (positive value)
Possible range: zero and up (in meters)
These two parameters return in the list the width of jamb on the left side and right side of the Window/Door, respectively. These are the values set in the Reveal Setup Subdialog of the Window/Door Settings Dialog (‘Jamb Depth 2’ for the left side and ‘Jamb Depth’ for the right).
Note: the parameters return these values even if no reveal is set for the Windows/Doors.

Listing_Parameters010425-21.png
The values returned in a list under ‘Window/Door jamb on the left side’ and ‘Window/Door jamb on the right side’


Window/door sill/threshold depth

Type: numerical (positive value)
Possible range: zero and up (in meters)
This parameter returns in the list the depth (height) of the sill/threshold of the Window/Door. This value is set in the ‘Sill/Threshold Depth’ field of the Reveal Setup Subdialog of the Window/Door Settings Dialog.


Window/door head depth

Type: numerical (positive value)
Possible range: zero and up (in meters)
This parameter returns in the list the depth (height) of the head of the Window/Door as set in the ‘Sill/Threshold Depth’ field of the Reveal Setup Subdialog of the Window/Door Settings Dialog.

Listing_Parameters010425-22.png
The values returned in a list under ‘Window/door sill/threshold depth’ and ‘Window/door head depth’


Reveal side is opposite to the opening side

Type: numerical (integer)
Possible values: 0 or 1
Returns in the list a number corresponding to state of the Window/Door as regards to the location of its reveal side relative to its opening side. It reflects changes caused by checking the ‘Flip’ checkbox in the Window/Door Settings Dialog. ‘0’ is returned when the reveal side is the same as the opening side (Window/Door is not flipped) and ‘1’ is returned when it is not the same side (its side is opposite to it).


Listing_Parameters010425-23.png
The values returned in a list under ‘Reveal side is opposite to opening side’


Frame thickness of window/door

Type: numerical (real value)
Possible range: any value (in meters)
Returns the nominal thickness of the Window/Door frame. This value can be set in the ‘Nominal Frame Thickness’ field in the Details Subdialog of the Library Part Editor when a Window/Door is open for editing. For most ArchiCAD Library Objects the ‘frame depth’ or ‘frame thickness’ parameter of the Window/Door is returned by this value.
Note: the value returned can be negative as well meaning the body of the Window/Door extends toward the opposite direction.

Listing_Parameters010425-24.png
The values returned in a list under ‘Frame thickness of window/door’


Offset of the door/window

Type: numerical (real value – in case of straight walls; angle value in case of curved walls)
Possible range: -[Door/Window size]/2 and up in case of straight walls (in meters); approx. -360.0000° – approx. 360.0000° in case of curved walls
Returns the offset value of the axis of the Door/Window relative to the normal vector of its enclosing wall projecting at the starting point of the wall. With straight walls this is a distance and with curved walls it is an angle value.


Window/door opening orientation

Type: string
Possible length: max. 31 characters
Returns in the list a string corresponding to the orientation of the Window/Door (L – left, R – right, or any other custom value). This value can be set in the ‘Orientation Displaying’ portion of the Details Subdialog of the Library Part Editor when a Window/Door is open for editing.

Listing_Parameters010425-25.png
The values returned in a list under ‘Offset of the door/window’ and ‘Window/door opening orientation’


Window/door marker text

Type: string
Possible length: max. 3 characters
Returns in the list the marker text of the dimension of the Window/Door as set in the Window/Door Dimension Settings Subdialog accessible from the Door/Window Settings Dialog.

Listing_Parameters010425-26.png
The values returned in a list under ‘Window/door marker text’, ‘Subfloor thickness (sill correction)’ and ‘Window/door sill height prefix’


Subfloor thickness (sill correction)

Type: numerical (positive value)
Possible range: 0 or up (in meters)
Returns in the list the subfloor thickness (sill correction value) of the Window/Door as set in the Window/Door Dimension Subdialog of the Door/Window Settings Dialog. The parapet height of the Window/Door is decreased by this value to give the final Window/Door sill height.


Window/door sill height prefix

Type: string
Possible length: max. 7 characters
Returns the string that is used as a prefix when the sill height of the Window/Door is displayed in its dimensioning. It can be set in the Window/Door Dimension Subdialog of the Window/Door Settings Dialog.


Distance of the local origin from the end of the wall

Type: numerical (real value)
Possible range: positive, negative or 0 (in meters)
Returns the distance of the center point of the curved Wall into which the Door/Window was placed from the local origin of the Door/Window. Since the variable applies only to curved walls, when the Door/Window is placed into a straight wall the returned value is 0.
The direction of the plus (+) range of the Window/Door’s local origin changes with the opening direction of the Door which is defined at the time of its placement. Depending on this the variable returns positive or negative values.

Listing_Parameters010425-27.png
The values returned in a list under ‘Distance of the local origin from the end of the wall’ and ‘Parapet wall inset’


Parapet wall inset

Type: numerical (real value)
Possible range: any value (in meters)
Returns the distance by which the parapet wall is set in (or set back) from the outer surface of the Wall in case a parapet wall is present. The parapet wall is a small wall just below the Window/Door and is usually less in width than the Wall it is part of and into which the Window/Door is placed.


User ID of the wall

Type: string
Possible length: max. 15 characters
Returns in a string the user ID of the Wall into which the Window/Door is placed as it was set in the Wall Settings Dialog box or automatically generated for the Wall by the program.

Listing_Parameters010425-28.png
The values returned in a list under ‘User ID of the wall’ and ‘Internal ID of the wall’


Internal ID of the wall

Type: numerical (positive integer value)
Possible range: 0 and up
Returns a number that is the internal ID number of the Wall into which the Window/Door was placed. This number is automatically generated and internally used by ArchiCAD. It can not be changed.


Thickness of the wall

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns in the list the thickness of the Wall into which the Window/Door was placed as it was set in the Wall Settings Dialog box. In the case of inclined Walls the thickness of the inclined Wall at the centerline of the Window/Door is returned. It is measured perpendicularly to the reference line of the Wall

Listing_Parameters010425-29.png
The values returned in a list under ‘Thickness of the wall’ and ‘Inclination of the wall surfaces’


Inclination of the wall surfaces

Type: numerical (angle value)
Possible range: -90.0000º – 90.0000º
Returns the angle at which the Wall inclines. A valid value is returned for both Walls themselves and for Windows/Doors as well (the value for the Wall into which they are placed). As a rule, the returned angle value is positive if the thickness at the end of the Wall is larger than its thickness at its beginning. In the reverse case the returned value is negative. For straight and curved Walls the returned value is ‘0’.


Height of the wall

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the height of the Wall into which the Window/Door is placed as set in the Wall Settings Dialog box.

Listing_Parameters010425-30.png
The values returned in a list under ‘Height of the wall’, ‘3D resolution of a curved wall’ and ‘Direction of the wall’


3D resolution of a curved wall

Type: numerical (positive integer value)
Possible range: 3 and up
Returns the resolution of the Wall at which it is drawn in the 3D Window. A valid value is returned for both Walls themselves and for Windows/Doors as well (the value for the Wall into which they are placed). For straight and inclined Walls the default value of 36 is returned.


Direction of the wall

Type: numerical (angle value)
Possible range: 0.0000º – 359.9999º
Returns the direction of the reference line of the Wall or the reference line of the Wall into which the Window/Door is placed relative to the horizontal direction (positive direction goes counter-clockwise). The direction goes from the starting point of the reference line to its ending point. If the Window/Door is placed into a curved Wall the direction of the tangent of the Wall at the half of the Wall will be returned.


Length of the wall on the reference line side

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the length of the Wall on the reference side of the Wall.
Note: unlike in the case of previous listing parameters, this parameter doesn’t return a value for Windows/Doors (information about their enclosing Walls).

Listing_Parameters010425-31.png
The values returned in a list under ‘Length of the wall on the reference line side’ and ‘Length of the wall on the side opposite to the reference line’


Length of the wall on the side opposite to the reference line

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the length of the Wall on its side that is opposite to its reference side.
Note: unlike in the case of previous listing parameters, this parameter doesn’t return a value for Windows/Doors (information about their enclosing Walls).


No. of doors in the wall

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Wall the total number of Door openings/Doors placed into the Wall.

Listing_Parameters010425-32.png
The values returned in a list under ‘No. of doors in the wall’, ‘No. of windows in the wall’ and ‘No. of empty openings’


No. of windows in the wall

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Wall the total number of Window openings/Windows placed into the Wall.


No. of empty openings

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Wall the total number of empty openings placed into the Wall.


Surface of doors in the wall

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all Doors that are placed into the Wall. This is the area by which the surface of the Wall is reduced on its sides by reason of placement of Doors into it.
Note: the surface area of each opening is counted only if it is larger than the area limit that can be set for Wall openings in the Setup List Schemes Dialog.

Listing_Parameters010425-33.png
The values returned in a list under ‘Surface of doors in the wall’, ‘Surface of windows in the wall’ and ‘Surface of empty openings in the wall’


Surface of windows in the wall

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all Windows that are placed into the Wall. This is the area by which the surface of the Wall is reduced on its sides by reason of placement of Windows into it.
Note: the surface area of each opening is counted only if it is larger than the area limit that can be set for Wall openings in the Setup List Schemes Dialog.


Surface of empty openings in the wall

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all Doors that are placed into the Wall. This is the area by which the surface of the Wall is reduced on its sides by reason of placement of Doors into it.
Note: the surface area of each opening is counted only if it is larger than the area limit that can be set for Wall openings in the Setup List Schemes Dialog.


Combined width of the windows in the wall

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total of the nominal widths of all Windows that are placed into the Wall.
Note: the widths of empty Window openings are not added to the value as these are listed as ‘empty openings’.

Listing_Parameters010425-34.png
The values returned in a list under ‘Combined width of the windows in the wall’ and ‘Combined width of the doors in the wall’


Combined width of the doors in the wall

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total of the nominal widths of all Doors that are placed into the Wall.
Note: the widths of empty Door openings are not added to the value as these are listed as ‘empty openings’.


No. of columns in the wall

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Wall the total number of Columns that are placed into that Wall.

Listing_Parameters010425-35.png
The values returned in a list under ‘No. of columns in the wall’


Thickness of the veneer

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns for each Column in the list the thickness of the Column veneer as it was set in the Column Settings Dialog.

Listing_Parameters010425-36.png
The values returned in a list under ‘Thickness of the veneer’, ‘Fill of the veneer’ and ‘Pen of the veneer fill’


Fill of the veneer

Type: string
Possible length: max. 31 characters
Returns for each Column the name of the Fill that is assigned to the Floor Plan and Section cut surfaces of the veneer as it was set in the Column Settings Dialog.


Pen of the veneer fill

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns for each Column the index number of the pen with which the fill pattern of the fill assigned to the veneer is drawn as it was set in the Column Settings Dialog.


Pen of the veneer fill background

Type: numerical (positive integer value)
Possible range: 0 – 255
Returns for each Column the index number of the pen with which the background of the fill pattern of the fill assigned to the veneer is drawn as it was set in the Column Settings Dialog. 0 can be returned as a value meaning that it is a transparent fill background.

Listing_Parameters010425-37.png
The values returned in a list under ‘Pen of the veneer fill background’, ‘Surface of the veneer’ and ‘Volume of the veneer’


Surface of the veneer

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all four outer sides of the veneer of the Column.
Note: placing a Column into a Wall does not change the value returned by this listing parameter.


Volume of the veneer

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns the volume of the veneer part of the Column.
Note: placing a Column into a Wall does not change the value returned by this listing parameter.


Beam Reference Line Offset

Type: numerical (real value)
Possible range: any value (in meters)
Returns for each Beam the offset of its reference line. This is the perpendicular distance between the reference line of the Beam and its axis. If – when looking at the Beam from the starting point of its reference line toward its ending point – the Beam extends to the right side of its reference line the returned value is negative, if it extends to the left the returned value is negative.

Listing_Parameters010425-38.png
The values returned in a list under ‘Beam Reference Line Offset’, ‘Beam to Beam Priority Number’ and ‘Beam Reference Line Direction’


Beam to Beam Priority Number

Type: numerical (positive odd integer value)
Possible values: 4300, 4500, 4700, 4900, 5100, 5300, 5500 and 5700
Returns for each Beam a number that will determine which Beam takes precedence when generating intersections between Beams in 3D. The Beam with the higher priority number will cut into the body of the Beam will a lower number. In the Beam Settings Dialog you can set odd numbers between 1 and 15. The above values are calculated with the following formula:

Beam-to-Beam Priority= 4200 + Number*100

So in case of 7, it will return 4900 and so on.
Note: this number determines only Beam-to-Beam priority. Wall/Column-to-Beam priority is set somewhere else.


Beam Reference Line Direction

Type: numerical (angle value)
Possible range: -180.0000º – 179.9999º
Returns for each Beam the direction of its reference line relative to the horizontal direction. The direction goes from the starting point of the reference line to its ending point.


Beam Right Side Length

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the length of the right side of the Beam. Its right side means the side to the right of its axis when looking from the beginning point of its reference line to its ending point.
Note: if another Beam or a Wall/Column cuts into the body of the Beam in 3D, it will not change the value returned by this listing parameter.

Listing_Parameters010425-39.png
The values returned in a list under ‘Beam Right Side Length’, ‘Beam Left Side Length’ and ‘No. of holes in the beam’


Beam Left Side Length

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the length of the left side of the Beam. Its left side means the side to the left of its axis when looking from the beginning point of its reference line to its ending point.
Note: if another Beam or a Wall/Column cuts into the body of the Beam in 3D, it will not change the value returned by this listing parameter.


No. of holes in the beam

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Beam the total number of holes that are placed into that Beam.


Surface of holes in the beam

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns for each Beam the total surface area of all holes placed into the Beam.

Listing_Parameters010425-40.png
The values returned in a list under ‘Surface of holes in the beam’, ‘Surface of hole edges in the beam’ and ‘Volume of holes in the beam’


Surface of hole edges in the beam

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns for each Beam the total surface area of all inside edges of all holes placed into the Beam. The edges of the Beam hole mean either the sides of the circular hole or the four inner sides of the rectangular hole


Volume of holes in the beam

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns the total volume of all holes placed into the Beam (the amount by which they decrease the volume of the Beam)


Perimeter of the slab

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of all edges of the Slab. This includes the total perimeter of the Slab polygon itself plus the total perimeter of all holes cut into the Slab body.

Listing_Parameters010425-41.png
The values returned in a list under ‘Perimeter of the slab’ and ‘No. of segments of the slab’


No. of segments of the slab

Type: numerical (positive integer value)
Possible range: 2 and up
Returns the total amount of segments in the Slab. This includes the total number of segments of the Slab polygon plus the number of all segments of all holes placed into the Slab. The smallest possible return value is ‘2’ which happens in the case of a circle (generated as two half circles) or a circle segment (a chord and an arc).


No. of holes of the slab

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Slab the total number of holes that are placed into that Slab.

Listing_Parameters010425-42.png
The values returned in a list under ‘No. of holes of the slab’, ‘Area of holes of the slab’ and ‘Perimeter of holes of the slab’


Area of holes of the slab

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns for each Slab the total surface area of all holes placed into the Slab.


Perimeter of holes of the slab

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of all holes of the Slab.
Note: in case there are holes in a Slab you can obtain the perimeter of the Slab polygon itself by deducting ‘Perimeter of holes of the slab’ from ‘Perimeter of the slab’.


Slope of the roof

Type: numerical (angle value)
Possible range: -89.0000º – 89.0000º
Returns for each Roof the angle at which it slopes as it was defined in the Roof Settings Dialog.

Listing_Parameters010425-43.png
The values returned in a list under ‘Slope of the roof’, ‘Perimeter of the roof’ and ‘No. of segments of the roof’


Perimeter of the roof

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of all edges of the Roof. This includes the total perimeter of the Roof polygon itself plus the total perimeter of all holes cut into the Roof body. The returned value reflects the sloped dimensions not their lengths projected to a horizontal plane.


No. of segments of the roof

Type: numerical (positive integer value)
Possible range: 2 and up
Returns the total amount of segments in the Roof. This includes the total number of segments of the Roof polygon plus the number of all segments of all holes placed into the Roof. The smallest possible return-value is ‘2’ just as in the case of Slabs.


No. of holes of the roof

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Roof the total number of holes that are placed into that Roof.

Listing_Parameters010425-44.png
The values returned in a list under ‘No. of holes of the roof’, ‘Area of holes of the roof’ and ‘Perimeter of holes of the roof’


Area of holes of the roof

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns for each Roof the total surface area of all holes placed into the Roof.


Perimeter of holes of the roof

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of all holes of the Roof. The returned value reflects the sloped dimensions not their lengths projected to a horizontal plane.
Note: in case there are holes in a Roof you can obtain the perimeter of the Roof polygon itself by deducting ‘Perimeter of holes of the roof’ from ‘Perimeter of the roof’.


Perimeter of the fill

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of all segments of the Fill. This includes the total perimeter of the Fill polygon itself plus the total perimeter of all holes cut into the Fill.

Listing_Parameters010425-45.png
The values returned in a list under ‘Perimeter of the fill’ and ‘No. of segments of the fill’


No. of segments of the fill

Type: numerical (positive integer value)
Possible range: 2 and up
Returns the total amount of segments in the Fill. This includes the total number of segments of the Fill polygon plus the number of all segments of all holes placed into the Fill. The smallest possible return-value is ‘2’ just as with Slabs.


No. of holes of the fill

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Fill the total number of holes that are placed into that Fill.

Listing_Parameters010425-46.png
The values returned in a list under ‘No. of holes of the fill’, ‘Perimeter of holes of the fill’ and ‘Area of holes of the fill’


Perimeter of holes of the fill

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of all holes of the Fill.
Note: in case there are holes in a Fill you can obtain the perimeter of the Fill polygon itself by deducting ‘Perimeter of holes of the fill’ from ‘Perimeter of the fill’.


Area of holes of the fill

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns for each Fill the total surface area of all holes placed into the Fill.


Type of the mesh

Type: numerical (positive integer value)
Possible values: see below table
Returns for each Mesh an integer number corresponding to the type of Mesh generated.

Type of Mesh
Value returned
Mesh with skirt and bottom
1
Mesh with skirt and without bottom
2
Mesh without skirt and bottom (only top surface)
3

Listing_Parameters010425-47.png
The values returned in a list under ‘Type of the mesh’ and ‘Relative offset of the bottom surface of the mesh’


Relative offset of the bottom surface of the mesh

Type: numerical (real value)
Possible range: any value (in meters)
Returns the thickness of the skirt from the reference plane of the skirt to its bottom. A positive number means the skirt extends downward. It is also possible that it extends upward from its reference plane in which case the returned value is negative.


Pen of the user defined ridges of the mesh

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen used to draw those ridges of the top surface of the Mesh that were defined by the user. This pen can be set in the Mesh Settings Dialog.

Listing_Parameters010425-48.png
The values returned in a list under ‘Pen of the user defined ridges of the mesh’ and ‘Pen of the triangulated edges of the mesh’


Pen of the triangulated edges of the mesh

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen used to draw those ridges of the top surface of the Mesh that are automatically generated by the program when creating the surface by dividing it into triangles. This pen can also be set in the Mesh Settings Dialog.


Perimeter of the mesh

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of all edges of the Mesh. This includes the total perimeter of the Mesh polygon itself plus the total perimeter of all holes cut into the Mesh body. Although the top surface of the Mesh is changing in height this value returns its dimensions projected to a horizontal plane.

Listing_Parameters010425-49.png
The values returned in a list under ‘Perimeter of the mesh’ and ‘No. of segments of the mesh’


No. of segments of the mesh

Type: numerical (positive integer value)
Possible range: 2 and up
Returns the total amount of segments in the Mesh. This includes the total number of segments of the Mesh polygon itself plus the number of all segments of all holes placed into the Mesh. The user-defined ridges are not added for the calculation of this value. The smallest possible return-value is ‘2’ as in case of Slabs.


No. of holes of the mesh

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Mesh the total number of holes that are placed into that Mesh.

Listing_Parameters010425-50.png
The values returned in a list under ‘No. of holes of the mesh’, ‘Area of holes of the mesh’ and ‘Perimeter of holes of the mesh’


Area of holes of the mesh

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns for each Mesh the total surface area of all holes placed into the Mesh. The surface area is measured not on the surface of the Mesh but is the area projected to the horizontal plane.


Perimeter of holes of the mesh

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total perimeter length of all holes of the Mesh. The perimeter is measured not on the surface of the Mesh but is the perimeter projected to the horizontal plane.
Note: in case there are holes in a mesh you can obtain the perimeter of the mesh polygon itself by deducting ‘Perimeter of holes of the mesh’ from ‘Perimeter of the mesh’.

Zone Parameters:


Zone Story Index

Type: numerical (integer value)
Possible range: approx. -15000 – approx. 15000
Returns the index number of the story on which the Zone is placed. The available index numbers are displayed in the Story Settings Dialog.

Listing_Parameters010425-51.png
The values returned in a list under ‘Zone Story Index’, ‘Zone Story Name’, ‘Zone Category Code’ and ‘Zone Category Name’


Zone Story Name

Type: string
Possible length: max. 25 characters
Returns the name of the story on which the Zone is placed. The available story names are displayed and can be set in the Story Settings Dialog.


Zone Category Code

Type: string
Possible length: max. 31 characters
Returns for each Zone its assigned category code. These are set in the Zone Categories Dialog.


Zone Category Name

Type: string
Possible length: max. 31 characters
Returns for each Zone its assigned category name. These are set in the Zone Categories Dialog.


Zone Name

Type: string
Possible length: max. 31 characters
Returns the name of the Zone. The value can be set in the Zone Settings Dialog.

Listing_Parameters010425-52.png
The values returned in a list under ‘Zone Name’, ‘Zone Number’, ‘Zone Number 1’, ‘Zone Number 2’, ‘Zone Number 3’, and ‘Zone Number 4’


Zone Number

Type: string
Possible length: max. 31 characters
Returns the number of the Zone. Although the name implies a number it actually returns a string that can contain numbers (such as: AB105). This value can be set in the Zone Settings Dialog.


Zone Number 1, Zone Number 2, Zone Number 3, Zone Number 4

Type: string
Possible range: the total length of all 4 variable added together (with the 3 dots in between) is max. 31 characters
A Zone Number can be set in such a way that it is composed of a maximum of 4 numbers (or strings for that matter) separated by dots (‘.’) and these be used to express relationships between Zones and the Project itself. For example, “B.C.06.45” might mean Room 45 on Story 6 in Wing ‘C’ of Building ‘B’. These four listing parameters return for each Zone the first, second, third and fourth portion, respectively, of such a Zone Number.


Zone Floor Level

Type: numerical (real value)
Possible range: any value (in meters)
Returns the level (height) at which the bottom of the Zone ‘body’ is located. It can be set in the Zone Settings Dialog.

Listing_Parameters010425-53.png
The values returned in a list under ‘Zone Floor Level’, ‘Zone Subfloor Thickness’, ‘Zone Height’, ‘Measured Area’ and ‘Measured Net Area’


Zone Subfloor Thickness

Type: numerical (positive value)
Possible range: 0 or up (in meters)
Returns the subfloor thickness of the Zone as it can be set in the Zone Settings Dialog.


Zone Height

Type: numerical (real value)
Possible range: any value (in meters)
Returns the height of the Zone ‘body’. It can be set in the Zone Settings Dialog. It can return a negative value as well.


Measured Area

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area of the Zone polygon as measured automatically by the program. When generating a Zone polygon the program can be set to extend the boundaries of the Zone to the reference lines of enclosing Walls or to extend them only to the inside surfaces of the enclosing Walls. In the former case ‘Measured Area’ will include the area of enclosing Walls on the inner side of their reference lines.


Measured Net Area

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total net area of the Zone as measured automatically by the program. It is the area of the Zone within the inner sides of its enclosing Walls of other boundaries minus the holes that are created into the Zone by Walls or Columns by setting ‘Zone boundary’ role for these elements in their Settings Dialog. A hole can also be created into a Zone polygon by drawing one into it using the ‘Polygon’ Zone creation method (not automatically finding its boundaries at Walls etc.)


Zone Perimeter

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of the perimeter of the Zone polygon. The perimeter of holes is also taken into consideration with this listing parameter. Please note that if the Zone is set to find the reference lines of its surrounding Walls than that portion of Zone Perimeter will be measured along these reference lines.

Listing_Parameters010425-54.png
The values returned in a list under ‘Zone Perimeter’, ‘Zone Net Perimeter’, ‘Zone Holes Perimeter’ and ‘Walls along Perimeter’


Zone Net Perimeter

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the ’net’ perimeter of the Zone. This is obtained by calculating the perimeter of the Zone polygon and adding to it the perimeter of all holes generated by Walls that are within the Zone area and are Zone boundaries (thereby generating holes into the Zone).


Zone Holes Perimeter

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the perimeter of all holes within the Zone polygon. These holes can be created by Walls or Columns that are inside the Zone polygon and are set in their Dialogs to be Zone boundaries (thereby generating holes into the Zone) or by holes placed into the Zone when it is drawn manually (not automatically finding boundaries).


Walls along Perimeter

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of Walls along the outside perimeter of the Zone polygon. This means that those Wall lengths will be added which run on the Zone side of the Walls. If there are recesses in the Wall because of Windows/Doors or otherwise the perimeter of these recesses are not added to the value returned by this listing parameter.


Surround. Wall Surface

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface of Walls along the outside perimeter of the Zone polygon. This means that those Wall lengths will be added which run on the Zone side of the Walls. If there are recesses in the Wall because of Windows/Doors or otherwise the surfaces of these recesses are not added to the value returned by this listing parameter. The Wall surfaces will be reduced by the area of those Window/Door openings or empty holes placed in them which are larger than the limit set in the ‘Reduce Wall quantities if an Opening is larger than’ field of the Setup List Schemes Dialog.

Listing_Parameters010425-33.png
The values returned in a list under ‘Surround. Wall Surface’, ‘Total Doors Surface’, ‘Total Doors Width’, ‘Total Windows Surface’ and ‘Total Windows Width’


Total Doors Surface

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface of all Doors that are placed into Walls along the outside perimeter of the Zone polygon.


Total Doors Width

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of the widths of all Doors that are placed into Walls along the outside perimeter of the Zone polygon.


Total Windows Surface

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface of all Windows that are placed into Walls along the outside perimeter of the Zone polygon.


Total Windows Width

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total length of the widths of all Windows that are placed into Walls along the outside perimeter of the Zone polygon.


Number of All Corners

Type: numerical (positive integer value)
Possible range: 2 (in case of a circle sector) and up
Returns the total number of corners of the Zone. This includes the number of corners of the Zone polygon plus the number of corners of any holes within the Zone polygon. Holes may also be generated into the Zone if a Wall or Column stands in the Zone and the ‘Zone Boundary’ setting is selected in its Settings Dialog for its relation to Zones. Also, the number of corners in the Zone polygon created because of Wall recesses or Window/Door recesses in Walls will be added for the final sum. When you select the Zone you will not see these corners generated by recesses but on the Floor Plan you will see then in the Zone polygon’s shape. The existence of these is controlled from the ‘Zones’ Tab page of the Preferences Dialog.

Listing_Parameters010425-55.png
The values returned in a list under ‘Number of All Corners’ and ‘Number of Concave Corners’


Number of Concave Corners

Type: numerical (positive integer value)
Possible range: 2 (in case of a circle sector) and up
Returns from the Number of All Corners of the Zone the number of corners that are concave (larger than 180°) if measured within the Zone side of the angle at the corner.


Wall Inset Top Surface

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
If there is a Door/Window in a Wall and its sill height is zero an inset is generated into the Wall the body of which is added to the Zone body. This listing parameter returns the top surface of this inset. Since the inset does not follow the shape of the Door/Window but always extends a rectangular body from the Zone’s main body, the value is obtained by multiplying the depth of the Door/Window in the Wall by its width.

Listing_Parameters010425-56.png
The values returned in a list under ‘Wall Inset Top Surface’, Wall Inset Back Side Surface and ‘Wall Inset Side Surface’


Wall Inset Back Side Surface

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the back surface of the wall inset, which is the size of the rectangular hole the Door/Window cuts into the Wall. It is obtained by multiplying the width of the Door/Window by its height.


Wall Inset Side Surface

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total of side surfaces of the wall inset, which is the size of the two sides of the rectangular hole the Door/Window cuts into the Wall. It is obtained by multiplying by two the product of the depth of the Door/Window in the Wall and its width.


Extracted Wall Area

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is reduced from the Zone’s measured net area because there are Walls there in the Zone. The ‘Reduce Zone Area’ option has to be selected for these Walls in the ‘Relation to Zones’ field of the ‘Listing Attributes’ portion of the Wall Settings Dialog for their areas to be reduced from the Zone area.

Listing_Parameters010425-57.png
The values returned in a list under ‘Extracted Wall Area’, ‘Extracted Column Area’, ‘Extracted Fill Area’ and ‘Extracted Low Areas’


Extracted Column Area

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is reduced from the Zone’s measured net area because Columns are placed there in the Zone. The ‘Reduce Zone Area’ option has to be selected for these Columns in the Column Settings Dialog just as in case of Walls.


Extracted Fill Area

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is reduced from the Zone’s measured net area because Fills are placed there in the Zone. The ‘Subtract from Zones’ checkbox has to be selected for these Fills in the ‘Listing Attributes’ portion of the Fill Settings Dialog for their areas to be reduced from the Zone area. The defined percentage of the areas will be deducted.


Extracted Low Areas

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is reduced from the Zone’s measured net area because their height is lower than the predefined values. These limits can be set in the ‘Low Ceiling Reduction’ portion of the ‘Zones’ tab page of the Preferences Dialog. The predefined percentages of these areas will be deducted from the Zone area.


Extracted Area Total

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total area that is deducted from the Zone’s measured net area. This is obtained by adding the values returned under ‘Extracted Wall Area’, ‘Extracted Column Area’, ‘Extracted Fill Area; and ‘Extracted Low Area’.

Listing_Parameters010425-58.png
The values returned in a list under ‘Extracted Area Total’, ‘Reduced Area’, ‘Zone Area Reducement’ and ‘Zone Calculated Area’ (“Measured Net Area’ is also displayed for reference)


Reduced Area

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the area of the Zone that remains after deducting all areas (‘Extracted Area Total’) that are decreased from the measured area of the Zone (‘Measured Net Area’). This value is also displayed in the ‘Area Calculation’ Tab page of the Zone Settings Dialog.


Zone Area Reducement

Type: numerical (positive value)
Possible range: 0.00 – 1.00
Returns a number corresponding to the reducement value of the Zone. Reducement is calculated the following way: In the ‘Area Calculation’ Tab page of the Zone Settings Dialog you can set a percentage in the field next to the ‘Reduce by’ checkbox when the checkbox is enabled. The percentage value can be between 0–100 %. The are remaining after this reducement relative to the ‘Reduced Area’ is expressed by this number. It is calculated by the following formula:

Zone Area Reducement = Listing_Parameters010425-59.png

For example, if no reduction is set, ‘Zone Area Reducement’ returns 1.00, in case of 10% reduction it returns 0.90.


Zone Calculated Area

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the area which remains from the Zone (and is reported on the Zone stamp) as final calculated area of the Zone. It is obtained by multiplying “Reduced Area’ with ‘Zone Area Reducement’. Naturally, ‘Zone Calculated Area’ is never larger than ‘Reduced Area’.


Zone Volume

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns the total volume of the Zone. When calculating the volume, holes of the Zone are deducted in their full height, Wall recesses are added, portions of the Zone body trimmed by Roofs, Slabs and Beams are deducted to calculate the final value of the volume.


Listing_Parameters010425-60.png
The values returned in a list under ‘Zone Volume’, ‘Zone Pen’, ‘Zone Layer Name’, ‘Zone User ID’ and ‘Zone Internal ID’


Zone Pen

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen used to draw the Zone stamp on the Floor Plan as set in the Zone Settings Dialog.


Zone Layer Name

Type: string
Possible length: 31 characters
Returns the name of the Layer on which the Zone is placed as set in the Zone Settings Dialog.


Zone User ID

Type: string
Possible length: max. 15 characters
Returns in a string the User ID assigned to the Zone as set in the Listing Attributes portion of the Zone Settings Dialog.


Zone Internal ID

Type: numerical (positive integer value)
Possible range: 1 and up
Returns the number internally assigned to each Zone created by ArchiCAD. This is a unique ID in case of each and every element and cannot be modified.


Zone Library Part Name

Type: string
Possible length: max. 27 characters
Returns for each Zone the name of the Library Part (Zone Stamp – with *.rsm extension) that is assigned to be used with the Zone as set in the Zone Categories Dialog (e.g. Zone_Stamp_01).


Zone Associated Property Part

Type: string
Possible length: max. 27 characters
Returns the name of the Library Part (Properties Object – with *.gps extension) that is assigned individually to be used with the Zone for listing purposes as linked to the Zone in the ‘Listing Attributes’ Tab page of the Zone Settings Dialog.



Table of Listing Parameters and their corresponding GDL Global Variables




Name of Listing Parameter
Name of GDL Global Variable
Element Type
-
View Pen
Wall:
Column:
Window/Door:
Slab:
Roof:
Object/Lamp:
Mesh:
Fill:
WALL_VIEW_PEN
COLU_VIEW_PEN
SYMB_VIEW_PEN
SLAB_VIEW_PEN
ROOF_VIEW_PEN
SYMB_VIEW_PEN
MESH_VIEW_PEN
-
Section Pen
Wall:
Column:
Beam:
Window/Door:
Slab:
Roof:
Object/Lamp:
Mesh:
Fill:
WALL_SECT_PEN
COLU_SECT_PEN
BEAM_SECT_PEN
SYMB_SECT_PEN
SLAB_SECT_PEN
ROOF_SECT_PEN
SYMB_SECT_PEN
MESH_SECT_PEN
-
Composite Section Pens¹
Wall:

Slab:

Roof:
WALL_FILL_PEN or WALL_SKINS_PARAMS[3][x]
SLAB_FILL_PEN or SLAB_SKINS_PARAMS[3][x]
ROOF_FILL_PEN or
ROOF_ SKINS_PARAMS[3][x]
Line Type
Wall:
Column:
Beam:
Window/Door:
Slab:
Roof:
Object/Lamp:
Mesh:
Fill:
WALL_LINETYPE
COLU_ LINETYPE BEAM_OUTLINE_ LINETYPE
SYMB_ LINETYPE
SLAB_ LINETYPE
ROOF_ LINETYPE
SYMB_ LINETYPE
MESH_ LINETYPE
FILL_ LINETYPE
Fill Name / Composite Name
Wall:
Slab:
Roof:
WALL_COMPS_NAME
SLAB_ COMPS_NAME
ROOF_ COMPS_NAME
Composite Fill Names1,2
Wall:


Slab:


Roof:
REQUEST ("Name_of_fill", WALL_SKINS_PARAMS[1][x], Name)
REQUEST ("Name_of_fill", SLAB_SKINS_PARAMS[1][x], Name)
REQUEST ("Name_of_fill", ROOF_SKINS_PARAMS[1][x], Name)
Fill Pen
Wall:
Column:
Beam:
Window/Door:
Slab:
Roof:
Object/Lamp:
Mesh:
Fill:
WALL_FILL_PEN
COLU_ CORE_ FILL_PEN BEAM_ FILL_PEN
SYMB_ FILL_PEN
SLAB_ FILL_PEN
ROOF_ FILL_PEN
SYMB_ FILL_PEN
MESH_ FILL_PEN
FILL_ FILL_PEN
Composite Fill Pens¹
Wall:
Slab:
Roof:
WALL_SKINS_PARAMS[4][x]
SLAB_SKINS_PARAMS[4][x]
ROOF_SKINS_PARAMS[4][x]
Fill Background Pen
Wall:
Column:
Beam:
Window/Door:
Slab:
Roof:
Object/Lamp:
Mesh:
Fill:
WALL_FBGD_PEN
COLU_ CORE_ FBGD_PEN BEAM_ FBGD_PEN
SYMB_ FBGD_PEN
SLAB_ FBGD_PEN
ROOF_ FBGD_PEN
SYMB_ FBGD_PEN
MESH_ FBGD_PEN
FILL_ FBGD_PEN
Composite Fill Background Pens¹
Wall:
Slab:
Roof:
WALL_SKINS_PARAMS[5][x]
SLAB_SKINS_PARAMS[5][x]
ROOF_SKINS_PARAMS[5][x]
Material
Wall:


Column:
Beam:




Window/Door:
Slab:


Roof:


Object/Lamp:
Mesh:


Fill:
 1. WALL_MAT_A
 2. WALL_MAT_B
 3. WALL_MAT_EDGE
COLU_MAT
 1. BEAM_MAT_LEFT
 2. BEAM_MAT_TOP
 3. BEAM_MAT_RIGHT
 4. BEAM_MAT_BOTTOM
 5. BEAM_MAT_END<
SYMB_MAT
 1. SLAB_MAT_TOP
 2. SLAB_MAT_BOTT
 3. SLAB_MAT_EDGE
 1. ROOF_MAT_TOP
 2. ROOF_MAT_BOTT
 3. ROOF_MAT_EDGE
SYMB_MAT
 1. MESH_MAT_TOP
 2. MESH_MAT_BOTT
 3. MESH_MAT_EDGE
-
Layer Name
GLOB_LAYER
User ID
GLOB_ID
Internal ID
GLOB_INTID
Surface
Wall:


Column:
Beam:




Window/Door:
Slab:


Roof:


Object/Lamp:
Mesh:


Fill:
 1. WALL_SURFACE_A
 2. WALL_SURFACE_B
 3. WALL_EDGE_SURF
COLU_CORE_SURF
 1. BEAM_ LEFT_SURF
 2. BEAM_ TOP_SURF
 3. BEAM_ RIGHT_SURF
 4. BEAM_ BOTTOM_SURF
 5. BEAM_END_SURF
-
 1. SLAB_ TOP_SURF
 2. SLAB_ BOTT_SURF
 3. SLAB_ EDGE_SURF
 1. ROOF_ TOP_SURF
 2. ROOF_ BOTTOM_SURF
 3. ROOF_EDGE_SURF
-
 1. MESH_ TOP_SURF
 2. MESH_ BOTTOM_SURF
 3. MESH_EDGE_SURF
-
Volume
Wall:
Column:
Beam:
Window/Door:
Slab:
Roof:
Object/Lamp:
Mesh:
Fill:
WALL_VOLUME
COLU_CORE_VOL
BEAM _VOLUME
-
SLAB_VOLUME
ROOF_VOLUME
-
MESH_VOLUME
-
Composite Volumes
-
Thickness/Size
Wall:
Column:
Beam:
Window/Door:

Slab:
Roof:
Object/Lamp:

Mesh:
Fill:
WALL_THICKNESS
-
BEAM _THICKNESS
 1.SYMB_A_SIZE
 2.-
SLAB_THICKNESS
ROOF_THICKNESS
 1.SYMB_A_SIZE
 2.SYMB_B_SIZE
MESH_BASE_OFFSET
-
Composite Thicknesses¹
Wall:
Slab:
Roof:
WALL_SKINS_PARAMS[2][x]
SLAB_SKINS_PARAMS[2][x]
ROOF_SKINS_PARAMS[2][x]
Height
Wall:
Column:
Beam:
Window/Door:
Slab:
Roof:
Object/Lamp:
Mesh:
Fill:
WALL_HEIGHT
COLU_HEIGHT
BEAM _HEIGHT
SYMB_B_SIZE
-
-
SYMB_Z_SIZE
-
-
Library Part Name
-
Associated Property Object
-
Property Part(s) by Criteria
-
Base Elevation
-
Associated Label
-
Associated Label Object
-
Zone Category Code
-
Zone Category Name
-
Zone Name
-
Zone Number
-
Split Zone Number 1/ Split Zone Number 2/ Split Zone Number 3/ Split Zone Number 4
-
Story Index
-
Story Name
-
Sill of the Window/Door
WIDO_SILL
Window/Door jamb on the left side
WIDO_RIGHT_JAMB
Window/Door jamb on the right side
WIDO_LEFT_JAMB
Window/door sill/threshold depth
WIDO_THRES_DEPTH
Window/door head depth
WIDO_HEAD_DEPTH
Reveal side is opposite to the opening side
WIDO_REVEAL_ON
Frame thickness of window/door
WIDO_FRAME_THICKNESS
Offset of the door/window
WIDO_POSITION
Window/door opening orientation
WIDO_ORIENTATION
Window/door marker text
WIDO_MARKER_TXT
Subfloor thickness (sill correction)
WIDO_SUBFL_THICKNESS
Window/door sill height prefix
WIDO_PREFIX
Distance of the local origin from the end of the wall
WIDO_ORIG_DIST
Parapet wall inset
WIDO_PWALL_INSET
User ID of the wall
GLOB_ID
Internal ID of the wall
GLOB_INTID
Thickness of the wall
WALL_THICKNESS
Inclination of the wall surfaces
WALL_INCL
Height of the wall
WALL_HEIGHT
3D resolution of a curved wall
WALL_RESOL
Direction of the wall
WALL_DIRECTION
Length of the wall on the reference line side
WALL_LENGTH_A
Length of the wall on the side opposite to the reference line
WALL_LENGTH_B
No. of doors in the wall
WALL_DOORS_NR
No. of windows in the wall
WALL_WINDS_NR
No. of empty openings
WALL_HOLES_NR
Surface of doors in the wall
WALL_DOORS_SURF
Surface of windows in the wall
WALL_WINDS_SURF
Surface of empty openings in the wall
WALL_HOLES_SURF
Combined width of the windows in the wall
WALL_DOORS_WID
Combined width of the doors in the wall
WALL_WINDS_WID
No. of columns in the wall
WALL_COLUMNS_NR
Thickness of the veneer
COLU_VENEER_WIDTH
Fill of the veneer
COLU_VENEER_FILL
Pen of the veneer fill
COLU_VENEER_FILL_PEN
Pen of the veneer fill background
COLU_VENEER_FBGD_PEN