Uploaded image for project: 'ChartJS Integration'
  1. ChartJS Integration
  2. CHARTJS-42

Use number fields and lists of values for the parameters of the chartjs and tableToChartJS macros

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Major
    • None
    • 1.6.3
    • None
    • None
    • Unknown

    Description

      The chartjs and tableToChartJS macros take the chart type, the source table, a column and sizes in plain text fields of the Edit Macro dialog, so the user has to know the Chart.js identifiers and the ids of the page, and a wrong value draws nothing.

      The macros to change, with the file where most of the fix is done:

      The main problems:

      • The chart type is a short fixed list, which a wiki macro cannot declare, and would gain from a preview of each type.
      • The table is the id of a table of the same page, and the data set label a column of that table, so their values depend on the page and on another field.
      • The width and height are numbers of pixels declared as strings.

      Depends on

      Most of these fields cannot be offered before these generic changes, each giving the macro the means to declare the expected value:

      • XWIKI-25182, which gives a number input to the parameters of a numeric type.
      • XWIKI-25197, which lets a wiki macro parameter declare its minimum and maximum.
      • XWIKI-23045, which lets a parameter get its values from a provider, with or without custom values.
      • XWIKI-25180, which lets a parameter depend on another one, whose value its list of values follows.

      KOs covered

      Macro Criterion Parameter Problem Depends on
      chartjs C4 input-assistance type A free text field for a Chart.js chart type, where a select, ideally with a preview of each type, could be used: Pie is accepted and draws nothing. XWIKI-23045
      tableToChartJS C4 input-assistance type A free text field for a Chart.js chart type, where a select, ideally with a preview of each type, could be used: polararea is accepted and draws nothing. XWIKI-23045
      tableToChartJS C4 input-assistance table A free text field for the id of a table of the page, where a picker listing the tables of the page that have an id could be used: a misspelled id gives an empty chart. XWIKI-23045
      tableToChartJS C4 input-assistance dataSetLabel A plain text field for a column number, which a select of the columns of the chosen table, or a number field, would fit. XWIKI-23045, XWIKI-25180
      tableToChartJS C4 input-assistance width A plain text field for a number of pixels: width="abc" is accepted. XWIKI-25182, XWIKI-25197
      tableToChartJS C4 input-assistance height A plain text field for a number of pixels: height="-3" is accepted. XWIKI-25182, XWIKI-25197

      Impact found on macro fluidity

      These 6 KOs come from the WYSIWYG usability audit of the macros, under the criterion C4 input-assistance of its usability criteria. The page of each macro, linked in the table, has the full notes and the steps to reproduce. Fixing them means changing the declaration of the parameters in the macro definitions.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              Lucas C Charpentier Lucas
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: