.. _`Manually Create JSON Parameters`:

.. _`org.sysess.sympathy.create.createparameters`:

Manually Create JSON Parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. image:: create_json.svg
   :width: 48


Manually Create a Sympathy parameter structure by writing a python
expression which modifies the parameters variable using the sympathy
parameter api (same class as nodes use to create their parameters).

Example:

.. code-block:: python

    parameters.set_integer(
        'number',
        description='Description of the number parameter.',
        value=1)
    parameters.set_string(
        'string',
        description='Description of the string parameter.',
        value="1")
    parameters.set_integer(
        'bounded_number',
        label='Bounded number',
        description='Description of the bounded_nummber parameter.',
        value=0,
        editor=synode.editors.bounded_lineedit_editor(
            0, 4))

In order to create editors and doing some other operations, synode
is defined when the code is evaluated.

Optional input port, named arg, can be used in the code. Have a look
at the :ref:`Data type APIs<datatypeapis>` to see what methods and
attributes are available on the data type that you are working with.

The Evaluation context contains *parameters* of type ParameterRoot,
*synode* - which is the module obtained from sympathy.api.node, and
optionally *arg* which is a sympathy datatype subclass of TypeAlias or
sybase (builtin).

*Input ports*:
    :arg: <a>

        Input

*Output ports*:
    :output: json

        Output

*Configuration*:
    **Parameters:** (code)
        Python code that modifies the parameter structure.

.. automodule:: node_create_json

.. class:: CreateParameters


Example flows
#############

* :download:`JSONParameters.syx </_examples/Sympathy/InputOutputGenerate/JSONParameters.syx>`