Parameters for a Wall Cabinet
This table contains all the possible or required parameters to set up a wall cabinet in the Kitchen applications (3DCloud, Assembly Editor).
➡️ See the tutorial Create a Base Cabinet for a concrete case on the use of parameters in 3DCloud and Assembly Editor.
Mandatory Parameters
The following parameters are mandatory and must be set for a wall cabinet.
Parameter Name | Parameter Type | Status | Default Value | Possible Values | Function |
---|---|---|---|---|---|
width | real | mandatory | – | [0 ;∞] | Defines the product size of the model on the X-axis (from left to right of the cabinet). |
depth | real | mandatory | – | [0 ;∞] | Defines the product size of the model on the Y-axis (from front to back of the cabinet). |
height | real | mandatory | – | [0 ;∞] | Defines the product size of the model on the Z-axis (from bottom to top of the cabinet). |
Optional Parameters
Reserved name parameter
The following parameters are optional and the name of the parameter are reserved words (can not be modified). To set up these parameters you should use the exact name of the parameter.
Parameter Name | Parameter Type | Status | Default Value | Possible Values | Function |
---|---|---|---|---|---|
bottomCoverPanel | product | optional | – | – | Dedicated parameter for the bottom cover panel. |
commercialDepth | integer | optional | – | – | Contains commercial depth used as filters in the catalog browser (e.g."60 cm"). Needs to use parameter display fields for translation. (See more details about searchable parameters translation) |
commercialDimensions | string | optional | – | – | Contains commercial descriptions for dimensions displayed in the product information panel (e.g. "W400 x D600 x H880"). Needs to use parameter display fields for translation. |
commercialWidth | integer | optional | – | – | Contains commercial width used as filters in the catalog browser (e.g." 40 cm"). Needs to use parameter display fields for translation. (See more details about searchable parameters translation) |
corniceOption | boolean | optional | FALSE | TRUE / FALSE | Enables the customer to activate and choose a cornice. |
coverPanelDepth | real | DEPRECATED | 13 | [0 ;∞] | DEPRECATED Defines the thickness of the cover panels for cover panel building and cabinet placement. |
decoStripOption | boolean | optional | FALSE | TRUE / FALSE | Enables the customer to activate and choose a deco strip. |
leftCorniceBack | boolean | optional | TRUE | TRUE / FALSE | Enables the customer to activate cornice return to the wall on the left side of the cabinet. Requires corniceOption [boolean] . |
leftCoverOption | boolean | optional | FALSE | TRUE / FALSE | Enables to activate the automatic behavior of the left side cover panel of a cabinet if this one is the last cabinet on the right. Requires leftCoverPanel [product] . |
leftCoverPanel | product | optional | – | – | Dedicated parameter for the left side cover panel. |
leftDecoStripBack | boolean | optional | FALSE | TRUE / FALSE | Enables the customer to activate a deco strip return to the wall on the left side of the cabint. Requires decoStripOption [boolean] . |
railOption | product | optional | – | – | Enables the customer to activate and define a suspension rail product. |
rightCorniceBack | boolean | optional | TRUE | TRUE / FALSE | Enables the customer to activate cornice return to the wall on the right side of the cabinet. Requires corniceOption [boolean] . |
rightCoverOption | boolean | optional | FALSE | TRUE / FALSE | Enables to activate the automatic behavior of the right side cover panel of a cabinet if this one is the last cabinet on the left. Requires rightCoverPanel [product] . |
rightCoverPanel | product | optional | – | – | Dedicated parameter for the right side cover panel. |
rightDecoStripBack | boolean | optional | FALSE | TRUE / FALSE | Enables the customer to activate a deco strip return to the wall on the right side of the cabinet. Requires decoStripOption [boolean] . |
sectionOrientation | integer | optional | 0 | 0 / 1 | Enables the customer to choose a deco strip orientation; this orientation can change size of contiguous side panels if enabled. Possible values are: ▪️ 0 (Horizontal) ▪️ 1 (Vertical) Requires decoStripOption [product] . |
topCoverPanel | product | optional | – | – | Dedicated parameter for the top cover panel. |
topLight | product | optional | – | – | Dedicated parameter for the top light. |
Recommended name parameter
The following parameters are optional and the name of the parameter are recommended (can be modified). To set up these parameters you can chose whatever the name you want.
Parameter Name | Parameter Type | Status | Default Value | Possible Values | Function |
---|---|---|---|---|---|
box | product | optional | – | – | Dedicated parameter for the box. |
boxAssembly | product | optional | – | – | Dedicated parameter for the box at assembly level. |
doorAssembly | product | optional | – | – | Dedicated parameter for the door at assembly level. |
damper | product | optional | – | – | Dedicated parameter for the damper. |
front | product | optional | – | – | Dedicated parameter for the front. |
function | string | optional | – | – | Contains commercial functionnal description used as filters in the catalog browser (e.g."Door & drawer"). Needs to use parameter display fields for translation. (See more details about searchable parameters translation) |
handle | product | optional | – | – | Dedicated parameter for the handle. |
handleLayout | integer | optional | 1 | 0/1 | Enables the customer to define the position of the handle: either centered or on a side. To define which side, the side parameter is required. Values are :▪️ 0 = Force the position to center ▪️ 1 = Keep the position defined by the side parameter. |
handleOrientation | integer | optional | 1 | 0/1 | Enables the customer to change the handle orientation Available only if handleLayout = 1.Values are: ▪️ 0 = horizontal ▪️ 1 = vertical |
hinge | product | optional | – | – | Dedicated parameter for the hinge. |
shelf | product | optional | – | – | Dedicated parameter for the shelf. |
side | integer | optional | -1 | -1 / 1 | Enables the customer to change the door opening side of the cabinet, and the handle position in the same time. Values are: ▪️ -1 (Left) ▪️ 1(Right) |
spotLight | product | optional | – | – | Dedicated parameter for the spot light. |
worktopLight | product | optional | – | – | Dedicated parameter for the worktop light. |