API Docs

Class: StairRules

BIM. StairRules

Defines the set of rules a stairway must comply with.

The data in this class define the standards that a staircase or ramp must comply with. This means that landings may be automatically inserted in long spans and that incline heights may be restricted, etc.

new StairRules( [config])

Creates a new stair rule set.

Parameters:
Name Type Argument Description
config object <optional>

An optional configuration object.
Properties of config:
Name Type Argument Description
name string <optional>

A human-readable name for this rule set.
riserMin number <optional>

The minimum height of each vertical riser in the stairway, in mm.
riserMax number <optional>

The maximum height of each vertical riser in the stairway, in mm.
riserNumberMin number <optional>

The minimum number of vertical risers in a single flight.
riserNumberMax number <optional>

The maximum number of vertical risers in a single flight.
riserVariationMax number <optional>

The maximum allowable variation between adjacent riser heights in a single flight, in mm.
riserDifferentMinMax number <optional>

The maximum allowable variation between the smallest and largest riser heights in a single flight, in mm.
goingMin number <optional>

The minimum width of each horizontal step in the stairway, in mm.
goingMax number <optional>

The maximum width of each horizontal step in the stairway, in mm.
nosingMin number <optional>

The minimum horizontal overlap between treads in the stairway, in mm.
nosingMax number <optional>

The maximum horizontal overlap between treads in the stairway, in mm.
landingMin number <optional>

The minimum horizontal landing size in a flight of stairs, in mm.
twoRplusGMin number <optional>

The minimum angle of the stairway, determined from risers and goings.
twoRplusGMax number <optional>

The maximum angle of the stairway, determined from risers and goings.
Author:
  • drajmarsh

Members

:number

goingMax

The maximum width of each horizontal step in the stairway, in mm.

Type
  • number
:number

goingMin

The minimum width of each horizontal step in the stairway, in mm.

Type
  • number
:boolean

isStairRules <readonly>

A flag identifying this object as a stair rule set.

Type
  • boolean
:number

landingMin

The minimum horizontal landing size in a flight of stairs, in mm.

Type
  • number
:string

name

A human-readable name for this rule set.

Type
  • string
:number

nosingMax

The maximum horizontal overlap between treads in the stairway, in mm.

The going value shall be not greater than the tread depth plus a maximum gap equal to this value between the rear edge of one tread and the nosing of the tread above.

Type
  • number
:number

nosingMin

The minimum horizontal overlap between treads in the stairway, in mm.

The going value shall be not less than the tread depth plus a gap equal to this value between the rear edge of one tread and the nosing of the tread above.

Type
  • number
:number

riserDifferentMinMax

The maximum allowable variation between the smallest and largest riser heights in a single flight, in mm.

Type
  • number
:number

riserMax

The maximum height of each vertical riser in the stairway, in mm.

Type
  • number
:number

riserMin

The minimum height of each vertical riser in the stairway, in mm.

Type
  • number
:number

riserNumberMax

The maximum number of vertical risers in a single flight.

Type
  • number
:number

riserNumberMin

The minimum number of vertical risers in a single flight.

Type
  • number
:number

riserVariationMax

The maximum allowable variation between adjacent riser heights in a single flight, in mm.

Type
  • number
:number

twoRplusGMax

The maximum elevation of the stairway, determined from risers and goings.

The combination of twice the riser plus the going (2R + G) shall be not more than this value.

Type
  • number
:number

twoRplusGMin

The minimum elevation of the stairway, determined from risers and goings.

The combination of twice the riser plus the going (2R + G) shall be not less than this value.

Type
  • number
:BIM.StairRules

Default <static>

Defines a default rule set for stairs.

Type

Methods

fromJSON(data)

Safely copy properties from a source object.

See the PD.Base#fromJSON method for more details.

Parameters:
Name Type Description
data object

The source object containing data to copy.
Returns:

Returns this instance to support method chaining.

Type
BIM.Component