Help:Jqplotseries format
| Jqplotseries format | |
|---|---|
| enable sets of numerical data to be displayed as a chart series using the jqPlot Javascript library | |
| Scenarios, examples, demos | |
| Example: | Jqplotseries |
| Collection | |
| Further Information | |
| Provided by: | Semantic Result Formats |
| Added: | 1.8.0 |
| Removed: | still supported |
| Requirements: | none |
| Format name: | jqplotseries |
| Enabled? Indicates whether the result format is enabled by default upon installation of the respective extension. | Yes |
| Authors: | James Hong Kong |
| Categories: | charts |
| Group: | , |
| Table of Contents | |
The result format jqplotseries, enables a set of numerical data to be displayed as a chart series using the jqPlot Javascript library.
The ['group'] (property, subject) parameter is used as indicator to distinguish between different sets of data within the same result set.
jqplotseries is an experimental printer supporting different chart layouts such as bar, line, stacked bar/line, and bubble charts.
Parameters
| ⧼validator-describe-header-parameter⧽ | ⧼validator-describe-header-type⧽ | ⧼validator-describe-header-default⧽ | ⧼validator-describe-header-description⧽ |
|---|---|---|---|
| min | ⧼validator-type-integer⧽ | no | The minimum value to show on the Y-axis |
| direction | ⧼validator-type-string⧽ | vertical | Specify the direction of a chart or graph |
| charttitle | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The title of the chart |
| charttext | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Descriptive chart text |
| numbersaxislabel | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The label for the numbers axis |
| labelaxislabel | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | The label for the label axis |
| height | ⧼validator-type-integer⧽ | 400 | Specify the height (in pixels) of a chart or graph |
| width | ⧼validator-type-string⧽ | 100% | Specify the width (in pixels or percent) of a chart or graph |
| smoothlines | ⧼validator-type-boolean⧽ | no | Apply a smoothing algorithm on line charts |
| valueformat | ⧼validator-type-string⧽ | %d | Specify formatting rule for values |
| ticklabels | ⧼validator-type-boolean⧽ | yes | Enable display of tick labels |
| highlighter | ⧼validator-type-boolean⧽ | no | Display a data point highlighter |
| theme | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Select a grid theme |
| filling | ⧼validator-type-boolean⧽ | yes | Individual filling option |
| chartlegend | ⧼validator-type-string⧽ | none | Chart legend position |
| datalabels | ⧼validator-type-string⧽ | none | Chart/graph data labels |
| colorscheme | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Select a color scheme |
| chartcolor | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Assign individual chart colors |
| class | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Specify an additional cascading style sheet class |
| infotext | ⧼validator-type-string⧽ | ⧼validator-describe-empty⧽ | Display additional information on a corresponding info tab |
| stackseries | ⧼validator-type-boolean⧽ | no | Display chart as stacked series |
| group | ⧼validator-type-string⧽ | subject | Series grouped by |
| grouplabel | ⧼validator-type-string⧽ | subject | Determine the group label |
| charttype | ⧼validator-type-string⧽ | bar | Available chart type |
| trendline | ⧼validator-type-string⧽ | none | Enable simultaneous display of a chart and its trendline |
| cursor | ⧼validator-type-string⧽ | none | Chart cursor display option |
| gridview | ⧼validator-type-string⧽ | none | Display chart and data sets simultaneously. Allowed values: "none" and "tabs". Default: "none" |
| hidezeroes | ⧼validator-type-boolean⧽ | no | Hide zero values from the chart |
Parameter options
- chartlegend ( 'none', 'nw','n', 'ne', 'e', 'se', 's', 'sw', 'w' )
- charttype( 'bar', 'line', 'donut', 'bubble', 'scatter' )
- colorscheme ( see
$srfgColorScheme) - datalabels ( 'none', 'value', 'label', 'percent' )
- direction ( 'horizontal', 'vertical' )
- group ( 'property' , 'subject' )
- grouplabel ( 'property' , 'subject' )
- startangle ( '10', etc. ) some number between 0 and 359 for charttype donut
- theme ( 'vector', 'simple' )
How to group data sets
Depending of its source (page as subject, or property as subject marker), data can be grouped either as "property" or "subject" with some chart types require a certain order of how data are presented as rows/columns.
How to influence display and styling
The height and width parameter are responsible for specifying a charts dimension while the class parameter can be used to adjust its position within page (float right, float left etc. see some examples here)
Another possibility to influence the display is to use the parameter "tableview" showing a chart and its corresponding datatable next to each other using a tabs ui (see here).
Usage
Bubble chart
The bubble chart is expecting data in a pre-defined order with properties representing a specific container class of content. Each data row is expected to be defined by four columns including a label (string type), x value (number type), y value (number type), and radius value (number type).
Data model
| Column 0 | Column 1 | Column 2 | Column 3 | |
|---|---|---|---|---|
| Purpose | Label | X value | Y value | Radius |
| Data Type | string | number | number | number |
| Role | data | data | data | data |
Scatter plot
The scatter plot requires that x-axis values are of type string therefore a data set declaration should include [x as (string), x as(number), y(number), y2 ... ). A regression (trendline) will be generated for available data sets.
Data model
| Column 0 | Column 1 | ... | Column N | |
|---|---|---|---|---|
| Purpose | Data point X values | Series 1 Y values | ... | Series N Y values |
| Data Type | number | number | ... | number |
| Role | data | data | ... | data |
Examples
See also
- jqplotseries and jqplotchart do not support the display in tabs (or headertabs), if you are interested in a solution please visit the following website.
Property "Namespace" has a restricted application area and cannot be used as annotation property by a user.Property "Docinfo editor" (as page type) with input value "User:>Planetenxin" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process.
