plotCriteriaValues

Provider:PyXMCDA
Version:1.3

Description

Generate plots from provided criteriaValues as well as the scripts generating these plots.

Colormap can be defined by the user, by giving a list of colors in the parameters.xml file. The number of colors is not restrained, and the colormap will linearly distribute the color in their provided order and interpolate between them. If only one is provided, it will be used for all data plot. Each color is either one of the color names predefined in matplotlib (See https://matplotlib.org/stable/gallery/color/named_colors.html#sphx-glr-gallery-color-named-colors-py) or a RGB color defined in hexadecimal ‘#RRGGBB’.

N.B.: when plotting a pie chart, negative and null values are not represented!

Inputs

(For outputs, see below)

criteria

Optional: yes, enabled by default

Description:

The criteria to be plotted. All are plotted if not provided.

criteria values

Description:

The criteria values.

XMCDA related:

  • Tag: criteriaValues

parameters

Description:

Parameters of the method

GUI information:

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

  • Name: X-axis label

    X-axis name to display below each plot.

    • Type: string
    • Default value: “criteria”
  • Name: Y-axis label

    Y-axis name to display on the left of each plot.

    • Type: string
    • Default value: “values”
  • Name: Chart title

    Title of the chart to be plotted.

    • Type: string
    • Default value: “Criteria Values”
  • Name: Chart type

    Type of chart to be plotted.

    • Type: drop-down list
    • Possible values:
      • bar chart (XMCDA label : barChart) (default)
      • pie chart (XMCDA label : pieChart)
  • Name: Colormap

    Type of the colormap.

    • Type: drop-down list
    • Possible values:
      • Monochrome (XMCDA label : monochrome) (default)
      • Bicolor (XMCDA label : bicolor)
      • Multi-color (advanced) (XMCDA label : multicolor (advanced))
  • Name: Nb of colors

    The number of colors supplied to define the colormap.

    • Constraint description: The value should be between 2 and 10.
    • Type: integer
    • Default value: 2
  • Name: Color

    Color to use.

    • Type: drop-down list

    • Possible values:
      • black (XMCDA label :
        <value>

        <label>black</label>

        </value>) (default)

      • red (XMCDA label :
        <value>

        <label>red</label>

        </value>)

      • green (XMCDA label :
        <value>

        <label>green</label>

        </value>)

      • blue (XMCDA label :
        <value>

        <label>blue</label>

        </value>)

      • orange (XMCDA label :
        <value>

        <label>orange</label>

        </value>)

      • green (XMCDA label :
        <value>

        <label>green</label>

        </value>)

      • purple (XMCDA label :
        <value>

        <label>purple</label>

        </value>)

      • cyan (XMCDA label :
        <value>

        <label>cyan</label>

        </value>)

      • magenta (XMCDA label :
        <value>

        <label>magenta</label>

        </value>)

      • yellow (XMCDA label :
        <value>

        <label>yellow</label>

        </value>)

      • salmon (XMCDA label :
        <value>

        <label>salmon</label>

        </value>)

      • orangered (XMCDA label :
        <value>

        <label>orangered</label>

        </value>)

      • chocolate (XMCDA label :
        <value>

        <label>chocolate</label>

        </value>)

      • greenyellow (XMCDA label :
        <value>

        <label>greenyellow</label>

        </value>)

      • aquamarine (XMCDA label :
        <value>

        <label>aquamarine</label>

        </value>)

      • pink (XMCDA label :
        <value>

        <label>pink</label>

        </value>)

      • grey (XMCDA label :
        <value>

        <label>grey</label>

        </value>)

      • whitesmoke (XMCDA label :
        <value>

        <label>whitesmoke</label>

        </value>)

  • Name: 1st color

    First color to use for the colormap.

    • Type: drop-down list

    • Possible values:
      • black (XMCDA label :
        <value>

        <label>black</label>

        </value>) (default)

      • red (XMCDA label :
        <value>

        <label>red</label>

        </value>)

      • green (XMCDA label :
        <value>

        <label>green</label>

        </value>)

      • blue (XMCDA label :
        <value>

        <label>blue</label>

        </value>)

      • orange (XMCDA label :
        <value>

        <label>orange</label>

        </value>)

      • green (XMCDA label :
        <value>

        <label>green</label>

        </value>)

      • purple (XMCDA label :
        <value>

        <label>purple</label>

        </value>)

      • cyan (XMCDA label :
        <value>

        <label>cyan</label>

        </value>)

      • magenta (XMCDA label :
        <value>

        <label>magenta</label>

        </value>)

      • yellow (XMCDA label :
        <value>

        <label>yellow</label>

        </value>)

      • salmon (XMCDA label :
        <value>

        <label>salmon</label>

        </value>)

      • orange-red (XMCDA label :
        <value>

        <label>orangered</label>

        </value>)

      • chocolate (XMCDA label :
        <value>

        <label>chocolate</label>

        </value>)

      • green-yellow (XMCDA label :
        <value>

        <label>greenyellow</label>

        </value>)

      • aquamarine (XMCDA label :
        <value>

        <label>aquamarine</label>

        </value>)

      • pink (XMCDA label :
        <value>

        <label>pink</label>

        </value>)

      • grey (XMCDA label :
        <value>

        <label>grey</label>

        </value>)

      • whitesmoke (XMCDA label :
        <value>

        <label>whitesmoke</label>

        </value>)

      • white (XMCDA label :
        <value>

        <label>white</label>

        </value>)

  • Name: 2nd color

    Second color to use for the colormap.

    • Type: drop-down list

    • Possible values:
      • black (XMCDA label :
        <value>

        <label>black</label>

        </value>) (default)

      • red (XMCDA label :
        <value>

        <label>red</label>

        </value>)

      • green (XMCDA label :
        <value>

        <label>green</label>

        </value>)

      • blue (XMCDA label :
        <value>

        <label>blue</label>

        </value>)

      • orange (XMCDA label :
        <value>

        <label>orange</label>

        </value>)

      • green (XMCDA label :
        <value>

        <label>green</label>

        </value>)

      • purple (XMCDA label :
        <value>

        <label>purple</label>

        </value>)

      • cyan (XMCDA label :
        <value>

        <label>cyan</label>

        </value>)

      • magenta (XMCDA label :
        <value>

        <label>magenta</label>

        </value>)

      • yellow (XMCDA label :
        <value>

        <label>yellow</label>

        </value>)

      • salmon (XMCDA label :
        <value>

        <label>salmon</label>

        </value>)

      • orangered (XMCDA label :
        <value>

        <label>orangered</label>

        </value>)

      • chocolate (XMCDA label :
        <value>

        <label>chocolate</label>

        </value>)

      • greenyellow (XMCDA label :
        <value>

        <label>greenyellow</label>

        </value>)

      • aquamarine (XMCDA label :
        <value>

        <label>aquamarine</label>

        </value>)

      • pink (XMCDA label :
        <value>

        <label>pink</label>

        </value>)

      • grey (XMCDA label :
        <value>

        <label>grey</label>

        </value>)

      • whitesmoke (XMCDA label :
        <value>

        <label>whitesmoke</label>

        </value>)

  • Name: Color 1 (ex.: cyan or #00FFFF)

    1st color (ex.: cyan or #00FFFF)

    • Type: string
    • Default value: “black”
  • Name: Color 2

    2nd color

    • Type: string
    • Default value: “black”
  • Name: Color 3

    3rd color

    • Type: string
    • Default value: “black”
  • Name: Color 4

    4th color

    • Type: string
    • Default value: “black”
  • Name: Color 5

    5th color

    • Type: string
    • Default value: “black”
  • Name: Color 6

    6th color

    • Type: string
    • Default value: “black”
  • Name: Color 7

    7th color

    • Type: string
    • Default value: “black”
  • Name: Color 8

    8th color

    • Type: string
    • Default value: “black”
  • Name: Color 9

    9th color

    • Type: string
    • Default value: “black”
  • Name: Color 10

    10th color

    • Type: string
    • Default value: “black”
  • Name: Image file extension

    File extension of generated image figure.

    • Type: drop-down list
    • Possible values:
      • .eps (Encapsulated PostScript) (XMCDA label : eps)
      • .jpg (Joint Photographic Experts Group) (XMCDA label : jpg)
      • .pdf (Portable Document Format) (XMCDA label : pdf)
      • .pgf (Progressive Graphics File) (XMCDA label : pgf)
      • .png (Portable Network Graphics) (XMCDA label : png) (default)
      • .ps (PostScript) (XMCDA label : ps)
      • .raw (Raw RGBA bitmap) (XMCDA label : raw)
      • .rgba (Silicon Graphics RGB) (XMCDA label : rgba)
      • .svg (Scalable Vector Graphics) (XMCDA label : svg)
      • .svgz (Compressed Scalable Vector Graphics) (XMCDA label : svgz)
      • .tif (Tagged Image File Format) (XMCDA label : tif)
  • Name: Image file extension

    File extension of generated image figure.

    • Type: drop-down list
    • Possible values:
      • .eps (Encapsulated PostScript) (XMCDA label : eps)
      • .jpg (Joint Photographic Experts Group) (XMCDA label : jpg)
      • .pdf (Portable Document Format) (XMCDA label : pdf)
      • .png (Portable Network Graphics) (XMCDA label : png) (default)
      • .svg (Scalable Vector Graphics) (XMCDA label : svg)
  • Name: Plotter

    Plotter used to generate image.

    • Type: drop-down list
    • Possible values:
      • Matplotlib (XMCDA label : matplotlib) (default)
      • Gnuplot (XMCDA label : gnuplot)
  • Name: Order by

    Defines how criteria will be sorted on the figure.

    • Type: drop-down list
    • Possible values:
      • ids (XMCDA label : id) (default)
      • names (XMCDA label : name)
      • values (XMCDA label : value)
  • Name: Reverse order

    Defines if order direction should be reversed (descending order) or not.

    • Default value: false
  • Name: Mix colors

    Defines if colors should be mixed for a better contrast (more color-blind friendly) or not.

    • Default value: false
  • Name: Naming conventions

    How categories and alternatives are labelled on the graph.

    • Type: drop-down list
    • Possible values:
      • Only ids are shown (XMCDA label : id)
      • Only names are shown (disambiguated by appending the ids, if needed) (XMCDA label : name) (default)
      • Names and ids are shown in that order (XMCDA label : name (id))
      • Ids and names are shown in that order (XMCDA label : id (name))

XMCDA related:

  • Tag: programParameters

  • Code:

    <programParameters>
        <programParameter id="x_axis" name="X-axis label">
            <values>
                <value>
                    <label>%1</label>
                </value>
            </values>
        </programParameter>
        <programParameter id="y_axis" name="Y-axis label">
            <values>
                <value>
                    <label>%2</label>
                </value>
            </values>
        </programParameter>
        <programParameter id="chart_title" name="Chart title">
            <values>
                <value>
                    <label>%3</label>
                </value>
            </values>
        </programParameter>
        <programParameter id="chart_type" name="Chart type">
            <values>
                <value>
                    <label>%4</label>
                </value>
            </values>
        </programParameter>
        <programParameter id="colors" name="Colors">
            <!-- colormap: %colormap / nb colors: %nb_colors -->
            <values>%color-mono%color-A%color-B%color-a%color-b%color-c%color-d%color-e%color-f%color-g%color-h%color-i%color-j
            </values>
        </programParameter>
        <programParameter id="image_file_extension" name="Image file extension">
            <values>
                <value>
                    <label>%8a%8b</label>
                </value>
            </values>
        </programParameter>
        <programParameter id="plotter" name="Plotter">
            <values>
                <value>
                    <label>%9</label>
                </value>
            </values>
        </programParameter>
        <programParameter id="order_by" name="Order by">
            <values>
                <value>
                    <label>%10</label>
                </value>
            </values>
        </programParameter>
        <programParameter id="reverse_order" name="Reverse order">
            <values>
                <value>
                    <boolean>%11</boolean>
                </value>
            </values>
        </programParameter>
        <programParameter id="mix_colors" name="Mix colors">
            <values>
                <value>
                    <boolean>%12</boolean>
                </value>
            </values>
        </programParameter>
        <programParameter id="naming_conventions" name="Naming conventions">
            <values>
                <value>
                    <label>%13</label>
                </value>
            </values>
        </programParameter>
    </programParameters>
    

Outputs

criteria values plot

Description:

Image containing all selected criteria values plots. Format corresponds to the one given in parameters (default is .png).

XMCDA related:

  • Tag: None

criteria values plot script

Description:

Generated Python or Gnuplot script that made the image. Given to enable users to later customize the appearance of the plots. Extension is .py if matplotlib is used, .plt if gnuplot.

XMCDA related:

  • Tag: None

messages

Description:

Status messages.

XMCDA related:

  • Tag: programExecutionResult

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