mirror of
				https://github.com/inventree/InvenTree.git
				synced 2025-10-31 13:15:43 +00:00 
			
		
		
		
	Parameter types (#4935)
* Add fields to PartParameterTemplateModel - checkbox: Is the field a 'checkbox' - choices: List of valid options * Update javascript * Adds unit test for PartParameterTemplate - Checkbox cannot have units - Checkbox cannot have choices - Choices must be unique * Improve API filtering - Add "has_choices" filter - Add "has_units" filter * Prune dead code * Update js functions for creating / editing parameters * Update part parameter form - Rebuild the "data" field based on the selected template - Supports "string" / "boolean" / "select" * Adjust data input based on parameter type - Choice displays available options - Checkbox displays boolean switch - Otherwise displays text input - Adds more unit testing - Updates to forms.js for improved functionality * Calculate numeric value for boolean parameters * Update docs * Bump API version
This commit is contained in:
		
							
								
								
									
										
											BIN
										
									
								
								docs/docs/assets/images/part/parameter_template_edit.png
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								docs/docs/assets/images/part/parameter_template_edit.png
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							| After Width: | Height: | Size: 80 KiB | 
										
											Binary file not shown.
										
									
								
							| Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 84 KiB | 
| @@ -10,25 +10,41 @@ Part parameters are located in the "Parameters" tab, on each part detail page. | ||||
| There is no limit for the number of part parameters and they are fully customizable through the use of [parameters templates](#parameter-templates). | ||||
|  | ||||
| Here is an example of parameters for a capacitor: | ||||
|  | ||||
| {% with id="part_parameters_example", url="part/part_parameters_example.png", description="Part Parameters Example List" %} | ||||
| {% include 'img.html' %} | ||||
| {% endwith %} | ||||
|  | ||||
| ## Parameter Templates | ||||
|  | ||||
| Parameter templates are used to define the different types of parameters which are available for use. These are edited via the [settings interface](../settings/global.md). | ||||
| Parameter templates are used to define the different types of parameters which are available for use. The following attributes are defined for a parameter template: | ||||
|  | ||||
| | Attribute | Description | | ||||
| | --- | --- | | ||||
| | Name | The name of the parameter template (*must be unique*) | | ||||
| | Description | Optional description for the template | | ||||
| | Units | Optional units field (*must be a valid [physical unit](#parameter-units)*) | | ||||
| | Choices | A comma-separated list of valid choices for parameter values linked to this template. | | ||||
| | Checkbox | If set, parameters linked to this template can only be assigned values *true* or *false* | | ||||
|  | ||||
| ### Create Template | ||||
|  | ||||
| Parameter templates are created and edited via the [settings interface](../settings/global.md). | ||||
|  | ||||
| To create a template: | ||||
|  | ||||
| - Navigate to the "Settings" page | ||||
| - Click on the "Parts" tab | ||||
| - Scroll down to the "Part Parameter Templates" section | ||||
| - Click on the "Part Parameters" tab | ||||
| - Click on the "New Parameter" button | ||||
| - Fill out the `Create Part Parameter Template` form: `Name` (required) and `Units` (optional) fields | ||||
| - Click on the "Submit" button. | ||||
|  | ||||
| An existing template can be edited by clicking on the "Edit" button associated with that template: | ||||
|  | ||||
| {% with id="part_parameter_template", url="part/parameter_template_edit.png", description="Edit Parameter Template" %} | ||||
| {% include 'img.html' %} | ||||
| {% endwith %} | ||||
|  | ||||
| ### Create Parameter | ||||
|  | ||||
| After [creating a template](#create-template) or using the existing templates, you can add parameters to any part. | ||||
| @@ -51,12 +67,6 @@ To access a category's parametric table, click on the "Parameters" tab within th | ||||
| {% include 'img.html' %} | ||||
| {% endwith %} | ||||
|  | ||||
| Below is an example of capacitor parametric table filtered with `Package Type = 0402`: | ||||
|  | ||||
| {% with id="parametric_table_example", url="part/parametric_table_example.png", description="Parametric Table Example" %} | ||||
| {% include 'img.html' %} | ||||
| {% endwith %} | ||||
|  | ||||
| ### Sorting by Parameter Value | ||||
|  | ||||
| The parametric parts table allows the returned parts to be sorted by particular parameter values. Click on the header of a particular parameter column to sort results by that parameter: | ||||
|   | ||||
		Reference in New Issue
	
	Block a user