Parameters for a Sink

This document contains all the possible or required parameters to set up sinks in the Kitchen application.

➡️ See the tutorial Set Up Sinks and Taps 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 sink product.

Name	Type	Default Value	Possible Values	Visible	Function
width	real	–	[0 ;∞]	any	Defines the product size of the model on the X-axis (from left to right).
depth	real	–	[0 ;∞]	any	Defines the product size of the model on the Y-axis (from front to back).
height	real	–	[0 ;∞]	any	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 (cannot be modified).

Parameters for worktop export data

The following parameters are used to configure the worktop export data. It you do not use the linear export feature, none of these parameters are required.

Name	Type	Default Value	Possible Values	Visible	Function
addDrainerGrooves	boolean	–	TRUE / FALSE	any	Defines whether the sink has drainer grooves.
drainerGrooves	product	–	–	any	Defines the drainer grooves product. Requires addDrainerGrooves [boolean].
drainerGroovesPosition	integer	–	–	any	Defines whether the drainer grooves is on the left or the right side, or both. Requires addDrainerGrooves [boolean].
sinkBowlCenterX	real	–	[-∞;∞]	any	Defines the position of the bowls on the X-axis.
sinkBowlCenterY	real	–	[-∞;∞]	any	Defines the position of the bowls on the Y-axis.

Parameters for full-depth sinks

The following parameters are used to configure the full-depth feature for your sink. Full-depth sinks behave differently in the planner.

Name	Type	Default Value	Possible Values	Visible	Function
isFullDepth	boolean	–	TRUE / FALSE	any	Must be true if the sink is full depth.
fullDepthCutWidth	real	–	[0;∞]	any	Defines the cut width on which there is no worktop. If not defined, the width of the sink is used instead.
fullDepthThicknessCompatibility	real	–	[0;∞]	any	Defines the list (or range) of the compatible worktop thickness on the left and right of the sink. It is used in the FullDepthSinkThickness

Recommended names

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.

Name	Type	Default Value	Possible Values	Visible	Function
numberOfBowls	integer	2	[1;2]	any	Defines the number of bowls for a sink. This parameter can be used in sink assemblies to impact number of lids.
sinkThick	real	–	[-∞;∞]	any	Defines the size of the visible part of the sink on the top of the worktop. This thickness parameter is used to define the position of the sink into a cabinet.
xTapOffset	real	–	[-∞;∞]	any	Defines the position of the tap on the X-axis. Depending on your data, it can be necessary even if the tap is outside the sink.
yTapOffset	real	–	[-∞;∞]	any	Defines the position of the tap on the Y-axis. Depending on your data, it can be necessary even if the tap is outside the sink.
zTapOffset	real	–	[-∞;∞]	any	Defines the position of the tap on the Z-axis. Depending on your data, it can be necessary even if the tap is outside the sink.