Parameters for a Plinth
This document contains all the possible or required parameters to set up plinths in the Kitchen application.
➡️ See the tutorial Set Up Plinths 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 plinth.
| Name | Type | Default Value | Possible Values | Visible | Function |
|---|---|---|---|---|---|
width | real | – | [0 ;∞] | NO | Defines the product size of the model on the X-axis (from left to right). |
depth | real | – | [0 ;∞] | NO | Defines the product size of the model on the Y-axis (from front to back). |
height | real | – | [0 ;∞] | NO | Defines the product size of the model on the Z-axis (from bottom to top). |
Optional Parameters
Reserved names
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.
| Name | Type | Default Value | Possible Values | Visible | Function |
|---|---|---|---|---|---|
backPlinthOptionVisible | boolean | TRUE | TRUE / FALSE | NO | Option to control whether the back plinth toggle is displayed in the planner edit panel. By default if "backPlinthOptionVisible" is not set, the back plinth toggle is visible, when applicable. |
ecoFeeCategory | string | – | – | NO | Defines the category id of linear product to find the weight of linear in range and retrieve the ecoFee value. It is used in EcoFeeRule. |
linearWeight | real or integer | – | – | NO | Defines the weight per length of the plinth to calculate the overall weight. It should be in kilograms per meter, supporting either 2 or 3 decimals (with 3 decimals the retailer can be precise to the gram). It is used in EcoFeeRule. |
plinthPositionType | string | onLeg | onLeg onFrame onFront | NO | Defines if the plinth is generated on the path defined on the box frame or on the cabinet front, or if the plinth is generated by taking the offset values defined on the top-assembly into account. |
regularPlinth | product | – | – | any | Defines an additional plinth product. When this parameter is present, the plinth is considered as a "decorative plinth", and regularPlinth is a link to the associated regular plinth product. Both plinths are then priced in the bill of material (BOM) and are then part of the item list. |
section | product | – | – | NO | Defines the shape to use for the plinth instead of the default rectangular one obtained via the depth and height parameters. The product pointed by this parameter must have an output data named section in its assembly file, containing the actual section data.By default and if "section" parameter is not set, the section of the plinth is automatically rectangular. |