source: orange/docs/widgets/rst/data/editdomain.rst @ 11431:72f443a7f6fc

Revision 11431:72f443a7f6fc, 1.5 KB checked in by Ales Erjavec <ales.erjavec@…>, 13 months ago (diff)

Added basic documentation for 'Edit Domain' widget.

Line 
1.. _Edit Domain:
2
3Edit Domain
4===========
5
6.. image:: ../../../../Orange/OrangeWidgets/Data/icons/EditDomain.svg
7   :alt: Edit Domain widget icon
8
9Signals
10-------
11
12Inputs:
13   - Data (Orange.data.Table)
14      Input data set
15
16Outputs
17   - Data (Orange.data.Table)
18      Edited output data set
19
20Description
21-----------
22
23.. image:: images/EditDomain.png
24   :alt: Edit domain widget with iris data set
25
26This widget can be used to edit/change the domain of the data set.
27
28All features (including meta attributes) from the :obj:`Data` input data set
29are listed in the :guilabel:`Domain Features` list box on the left. Selecting
30one feature displays an editor in the right part.
31
32The name of the feature can be changed in the :guilabel:`Name` line edit.
33
34For *Discrete* features the value names can also be changed in the
35:guilabel:`Values` list box.
36
37Additonal feature annotations can be added/removed/edited in the
38:guilabel:`Labels` box. To add a new label click the :guilabel:`+` button
39and add the :guilabel:`Key` and :guilabel:`Value` columns of the new entry.
40Selecting an existing label and pressing :guilabel:`-` will remove
41the annotation.
42
43To revert the changes made to a feature press :guilabel:`Reset Selected`
44button in the :guilabel:`Reset` box while the feature is selected in the
45:guilabel:`Domain Features` list. Pressing :guilabel:`Reset All` will reset
46all features in the domain at the same time.
47
48Pressing :guilabel:`Commit` button will send the changed domain data set on
49the :obj:`Data` output channel.
Note: See TracBrowser for help on using the repository browser.