plotAlternativesAssignments

Provider:ITTB
Version:1.1

Description

This web service generates a plot representing the alternatives assignments. Colors can be used. You can specify how to display the different categories: by line, by column or in a grid. The plots can also be ordered: alphabetical order, its inverse or by categories.

Inputs

(For outputs, see below)

alternatives

Description:

A list of alternatives. Alternatives can be activated or desactivated via the <active> tag (true or false). By default (no <active> tag), alternatives are considered as active.

categories

Optional: yes, enabled by default

Description:

The list of categories and their rank (required!).

XMCDA related:

  • Tag: categories

  • Code:

    <categories>
        <category id=[...]>
            <active>[...]</active>
            <rank>
                                                <integer>[...]</integer>
                                        </rank>
        </category>
        [...]
    </categories>
    

alternativesAffectations

Description:

Assignment of reference alternatives

XMCDA related:

  • Tag: alternativesAffectations

  • Code:

    <alternativesAffectations>
        <alternativeAffectation>
           <alternativeID>[...]</alternativeID>
           <categoryID>[...]</categoryID>
       </alternativeAffectation>
        [...]
      </alternativesAffectations>
    

options

Description:

None

GUI information:

  • Parameter values can be defined via the GUI or the XMCDA file, by default via GUI.

  • Name: Plot title:

    String for the title of the plot. The default value is an empty field.

    • Type: string
  • Name: Number of images

    In a unique plot, only one image is generated containing all the alternatives affectations. Multiple plots can be obtained. The default value is true.

    • Type: drop-down list
    • Possible values:
      • 1 per plot (XMCDA label : true) (default)
      • Multiple images (XMCDA label : false)
  • Name: Plots arrangement

    In the case of a unique plot, you can specify how to display the categories: by line, by column or in a grid. The default value is by column.

    • Type: drop-down list
    • Possible values:
      • Column (XMCDA label : Column) (default)
      • Line (XMCDA label : Line)
      • Grid (XMCDA label : Grid)
  • Name: Order:

    The parameter which says if the categories are sorted out. Choose between “increasing” (alphabetical order), “decreasing” or “categories”.

    • Type: drop-down list
    • Possible values:
      • increasing (XMCDA label : increasing) (default)
      • decreasing (XMCDA label : decreasing)
      • categories (XMCDA label : categories)
  • Name: Use Colors?

    The use of colors: true for colored categories.

    • Type: drop-down list
    • Possible values:
      • Yes (XMCDA label : true)
      • No (XMCDA label : false) (default)
  • Name: Choose color:

    Choose between “Black”, “Red”, “Blue”, “Green”, “Yellow”, “Magenta” and “Cyan”.

    • Type: drop-down list
    • Possible values:
      • Black (XMCDA label : Black) (default)
      • Red (XMCDA label : Red)
      • Blue (XMCDA label : Blue)
      • Green (XMCDA label : Green)
      • Yellow (XMCDA label : Yellow)
      • Magenta (XMCDA label : Magenta)
      • Cyan (XMCDA label : Cyan)
  • Name: Plot alternatives in:

    The categories can be plotted in a rectangle, an oval or a diamond.

    • Type: drop-down list
    • Possible values:
      • rectangle (XMCDA label : rectangle)
      • oval (XMCDA label : oval) (default)
      • diamond (XMCDA label : diamond)

XMCDA related:

  • Tag: methodParameters

  • Code:

               <methodParameters>
            <parameter id="plot_title" name="Unique plot">
                    <value>
                            <label>%2</label>
                    </value>
            </parameter>
            <parameter id="unique_plot" name="Unique plot">
                    <value>
                            <label>%3</label>
                    </value>
            </parameter>
            <parameter id="plots_display" name="Plots' display">
                    <value>
                            <label>%4</label>
                    </value>
            </parameter>
            <parameter id="order" name="Order">
                    <value>
                            <label>%5</label>
                    </value>
            </parameter>
            <parameter id="use_color" name="Colors in the plots">
                    <value>
                            <label>%6</label>
                     </value>
            </parameter>
            <parameter id="selected_color" name="Selected color">
                    <value>
                            <label>%7</label>
                     </value>
                     </parameter>
            <parameter id="categories_shape" name="Categories shape">
                    <value>
                            <label>%8</label>
                    </value>
            </parameter>
    </methodParameters>
    

Outputs

alternativesAffectationsPlot

Description:

A string containing the base64 representation of the png image of the generated plot.

XMCDA related:

  • Tag: alternativeValue

messages

Description:

A list of messages generated by the algorithm.

XMCDA related:

  • Tag: methodMessages

For further technical details on the web service underlying this program, have a look at its documentation here.