mirror of
https://github.com/inventree/InvenTree.git
synced 2025-04-29 12:06:44 +00:00
6d3978ea28
* Add database model for defining custom units - Database model - DRF serializer - API endpoints * Add validation hook * Custom check for the 'definition' field * Add settings page for custom units - Table of units - Create / edit / delete buttons * Allow "unit" field to be empty - Not actually required for custom unit definition * Load custom unit definitions into global registry * Docs: add core concepts page(s) * Add some back links * Update docs * Add unit test for custom unit conversion * More unit testing * remove print statements * Add missing table rule
108 lines
4.6 KiB
Markdown
108 lines
4.6 KiB
Markdown
---
|
|
title: Part Parameters
|
|
---
|
|
|
|
## Part Parameters
|
|
|
|
A part *parameter* describes a particular "attribute" or "property" of a specific part.
|
|
|
|
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. 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 "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.
|
|
|
|
To add a parameter, navigate to a specific part detail page, click on the "Parameters" tab then click on the "New Parameters" button, the `Create Part Parameter` form will be displayed:
|
|
|
|
{% with id="create_part_parameter", url="part/create_part_parameter.png", description="Create Part Parameter Form" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|
|
|
|
Select the parameter `Template` you would like to use for this parameter, fill-out the `Data` field (value of this specific parameter) and click the "Submit" button.
|
|
|
|
## Parametric Tables
|
|
|
|
Parametric tables gather all parameters from all parts inside a particular [part category](./part.md#part-category) to be sorted and filtered.
|
|
|
|
To access a category's parametric table, click on the "Parameters" tab within the category view:
|
|
|
|
{% with id="parametric_table_tab", url="part/parametric_table_tab.png", description="Parametric Table Tab" %}
|
|
{% 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:
|
|
|
|
{% with id="sort_by_param", url="part/part_sort_by_param.png", description="Sort by Parameter" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|
|
|
|
## Parameter Units
|
|
|
|
The *units* field (which is defined against a [parameter template](#parameter-templates)) defines the base unit of that template. Any parameters which are created against that unit *must* be specified in compatible units.
|
|
|
|
The in-built conversion functionality means that parameter values can be input in different dimensions - *as long as the dimension is compatible with the base template units*.
|
|
|
|
!!! info "Read Mode"
|
|
Read more about how InvenTree supports [physical units of measure](../concepts/units.md)
|
|
|
|
### Incompatible Units
|
|
|
|
If a part parameter is created with a value which is incompatible with the units specified for the template, it will be rejected:
|
|
|
|
{% with id="invalid_units", url="part/part_invalid_units.png", description="Invalid Parameter Units" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|
|
|
|
This behaviour can be disabled if required, so that any parameter value is accepted:
|
|
|
|
{% with id="enforce_units", url="part/part_parameters_enforce.png", description="Enforce part parameters" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|
|
|
|
### Parameter Sorting
|
|
|
|
Parameter sorting takes unit conversion into account, meaning that values provided in different (but compatible) units are sorted correctly:
|
|
|
|
{% with id="sort_by_param_units", url="part/part_sorting_units.png", description="Sort by Parameter Units" %}
|
|
{% include 'img.html' %}
|
|
{% endwith %}
|