Ceiling Distance
CeilingDistanceRule
Distance between an item and ceiling.
Notification level: ℹ
Key | Value |
---|---|
ID | CeilingDistanceRule |
Translation key | ceiling_distance_rule_title ceiling_distance_rule_error_message |
Behavior
This rule checks if the distance between an item and the ceiling is more than the chosen minimum distance, in order to prevent the user from creating a dangerous bathroom.
Trigger Conditions
It is triggered if the distance between an item and the ceiling is less than the chosen minimum distance, the rule is triggered and the application recommends to modify the position of the item.
Overload Parameter
The Overload is an array of groups, with each group having the parameters as described below:
Key name | Type | Default value | Description |
---|---|---|---|
minDistance | number | – | This parameter defines the necessary minimum distance between the item of this group and the ceiling. Mandatory. |
groupProducts | object | – | This parameter defines the list of items that are to be considered for this group. Mandatory. |
Also in the overloads, the value in the object groupProducts has the following attributes:
Key name | Type | Default value | Description |
---|---|---|---|
typeIDs | array | [] | This parameter defines the list of closed tags. Optional. |
includedProducts | array | [] | This parameter defines the list of individual product ids of the items that need to be included if its closed tag is not present in typeIDs. Optional. |
excludedProducts | array | [] | This parameter defines the list of individual product ids of the items that need to be excluded even if its closed tag is present in typeIDs. Optional. |
Sample
[
{
"minDistance":200,
"groupProducts":{
"typeIDs":[
57
],
"includedProducts":[
],
"excludedProducts":[
]
}
},
{
"minDistance":250,
"groupProducts":{
"typeIDs":[
],
"includedProducts":[
"BathValidation_SwingDoorShower_01"
],
"excludedProducts":[
]
}
}
]
Illustration
The distance between an item and the ceiling is less than its corrosponding specified minimum distance, the rule is triggered and informs the user to change the position of the item.
Once the user has moved the item to atleast its corrosponding specified minimum distance from the ceiling(the overload value in this example); after clicking Refresh the check on the Help center, the design is error free.