Snow Flower Text supports drawing of more than 10 types of charts. In the AsciiDoc document, the template is inserted by selecting the chart type from the menu, and the chart can be easily embedded in the document simply by editing the CSV format data. Charts provide a visual representation of the characteristics of the data and are useful for getting a general overview of the data. By embedding charts in documents, anyone can easily create compelling reports.
The chart function is an extension of Snow Flower Text’s original AsciiDoc. This HTML document itself is also created using Snow Flower Text.
1. Features
The chart function of Snow Flower Text has the following features.
- Searchable
Labels on rendered charts remain text searchable. This feature is inherited after exporting to formats such as HTML, PDF, and DocBook. It has better Findability than embedding raster images.
- Change Trackable
Chart information is described in highly readable text. Thus, changes made in multiple versions can be easily found by comparing common texts. This is an excellent feature not found in office software that stores information in binary. Superior traceability compared to binary format files.
- Vector image
Charts are vector images, so they will render sharp and clean on any medium. No jaggies occur, no matter how large they are. It has better portability than embedding raster images.
- Universal color
The color palette used to color the charts uses a color universal design so that everyone can see the colors easily.
2. Chart classification
Snow Flower Text supports more than 10 chart types. Charts are classified by plotting method. Specifiable parameters and data description methods differ depending on the chart classification.
- Category Plot
A category plot is a two-dimensional plot of a continuous numeric value on one axis and a non-numeric (string) category on the other axis. The following charts belong to this category:
Bar graph (bar)
Stacked-bar (stacked-bar)
Line graph (line)
Area chart (area)
Stacked-area chart (stacked-area)
Radar chart (radar)
- XY plot
An XY plot is a two-dimensional plot of continuous numerical values on two axes. The following charts belong to this category:
XY graph (xy)
Histogram
Scatter chart
- Pie plot
This is a circular plot. This category includes pie charts and their variants.
Pie chart (pie)
Ring graph (ring)
3. How to use
Charts can be embedded in documents by writing CSV format text data in the [chart] block of AsciiDoc.
Select the AsciiDoc grammar (
Edit>Select grammer..>AsciiDoc).Use the
[chart]block to embed a chart. Insert the chart template into the document by operating theMenu>Insert>Chart…menu selection.Describe the data in CSV format. For details, refer to the following “How to write a chart block”.
4. How to write a chart block
By using the following syntax in the AsciiDoc document, you can embed the chart in the document at that position.
[chart, Type of Chart, List of chart parameters]
--------------------
Data notation
--------------------For example, a simple bar chart can be written as follows
[chart, bar, categoryLabel="category",valueLabel="value"]
-------------------------------------
A, 10
B, 20
C, 30
-------------------------------------This example is rendered as:
4.1. Type of Chart
The type of the chart is specified in the second parameter of the chart block. Refer to the following table for the parameters corresponding to the chart type.
| Parameter | Description |
|---|---|
| Bar chart |
| Stacked bar chart |
| Line chart |
| Area chart |
| Stacked area chart |
| Rader chart |
| XY chart |
| histogram |
| Scatter plot |
| Pie chart |
| Doughnut chart |
For example, if you want to embed a bar chart, specify bar as the second parameter of the [chart] block as follows
[chart, bar]- Bar chart
A bar chart is a graph that expresses some value by the length of a rectangular bar. Bar charts are used to compare two or more values. There are vertical and horizontal directions for the bar to extend. Bars are spaced in the Bar chart, but not in the histogram.
[chart,bar, …]
[chart, bar, orientation=horizontal, …]
[chart, bar,…]
[chart, bar, orientation=horizontal, …]- Stacked-bar chart
A stacked bar chart is a type of bar chart, and is a graph expressed by stacking elements in the same item on top. In the stacking bar chart, each element in the item is represented in a different color, which is suitable for grasping the total amount of each item and the ratio of each element in the item. For example, displaying the stacking bar chart for each day of the week or year makes it easier to understand the day of the week transition and annual transition of the element.
[chart, stacked-bar,…]
[chart, stacked-bar, orientation=horizontal,…]- Line chart
A line chart is a straight line connecting the plotted points. It is suitable for grasping the transition of data over a certain period of time.
[chart, line,…]
[chart, line, orientation=horizontal,…]- Area chart
Area chart is a type of line chart that displays quantitative data. Generally, two or more series of data groups are compared in a graph, and the area between the axis and the line is highlighted by color.
[chart, area,…]
[chart, area, orientation=horizontal,…]- Stacked-area chart
[chart,stacked-area,…]- Radar chart
A radar chart is a diagram in which multiple items are set on the vertical axis and the origins on the vertical axis are combined into a single radial chart. You can compare the sizes of multiple items at a glance. Also known as a spider web chart.
[chart, radar, grid=true,…]- Scatter plot
The scatter plot is a plot of data with dots corresponding to the amount and size of two items on the vertical and horizontal axes. The scatter plot has the feature of being able to grasp the distribution and correlation of the two items. If the data group tends to be distributed upward to the right, there is a positive correlation, and if the data group tends to be distributed downward to the right, there is a negative correlation. Scatter plots are often used to display and compare numerical data such as scientific, statistical, and engineering data.
[chart, scatter,…]- XY char
[chart, xy,…]- Histogram
A histogram is a type of statistical graph with frequencies on the vertical axis and classes on the horizontal axis. It is mainly used in statistics, mathematics, image processing, etc. to visually recognize the distribution of data. In the industrial field, it is known as the seven QC tools for quality control. In the histogram he specifies the number of bins as a parameter.
[chart, histogram, bins=10,…]- Pie chart
A pie chart is a graph in which a circle is the entire data (100%) and the composition ratio of the elements in it is represented by the area of a sector. In a pie chart, the length of a sector arc is proportional to the quantity represented by that sector. Some statisticians recommend not using pie charts because it is difficult to compare the size of individual regions compared to bar charts and the like.
Pie charts ignore negative values in the data.
[chart,pie]- Doughnut chart
[chart,ring]
4.2. Chart block parameters
The block parameters that can be used differ depending on the chart type. Refer to the following table for the combinations of chart types and parameters that can be used.
| width | fontSize | rotate | orientation | |
|---|---|---|---|---|
bar | Yes | Yes | Yes | Yes |
stacked-bar | Yes | Yes | Yes | Yes |
line | Yes | Yes | Yes | Yes |
area | Yes | Yes | Yes | Yes |
stacked-area | Yes | Yes | Yes | |
xy | Yes | Yes | Yes | |
scatter | Yes | Yes | Yes | |
histogram | Yes | Yes | Yes | |
pie | Yes | Yes | ||
ring | Yes | Yes | ||
radar | Yes | Yes |
| caption | xLabel | yLabel | categoryLabel | valueLabel | |
|---|---|---|---|---|---|
bar | Yes | Yes | Yes | ||
stacked-bar | Yes | Yes | Yes | ||
line | Yes | Yes | Yes | ||
area | Yes | Yes | Yes | ||
stacked-area | Yes | Yes | Yes | ||
xy | Yes | Yes | Yes | ||
scatter | Yes | Yes | Yes | ||
histogram | Yes | Yes | Yes | ||
pie | Yes | ||||
ring | Yes | ||||
radar | Yes |
| bins | grid | |
|---|---|---|
bar | ||
stacked-bar | ||
line | ||
area | ||
stacked-area | ||
xy | ||
scatter | ||
histogram | Yes | |
pie | ||
ring | ||
radar | Yes |
4.2.1. Parameter definition
widthChart width(75%, )
When displaying at 75% of the page widthwidth=75%When displaying at 400 pixelswidth=400rotateRotate the category label. Specify by degrees.
To rotate 45 degreesrotate=45To rotate 90 degreesrotate=90
rotate=45
rotate=90fontSizeFont size ratio (0 or greater). If you want to increase the font size, specify a value greater than 1. Specifying the font size affects all labels.
When increasing the font size by 1.8 timesfontSize=1.8
fontSize=1
fontSize=1.8orientationSpecifies the direction of the plot. You can set
verticalorhorizontal. The default isvertical.When plotting verticallyorientaion=verticalWhen plotting horizontallyorientaion=horizontal
orientation=vertical
orientation=horizontalcaptionChart caption
xLabelX-axis label
yLabelY-axis label
categoryLabelCategory label
valueLabelValue label
gridThis parameter controls the grid display. You can specify true or false. If not specified, it will be false and the grid will be hidden.
When hiding the gridgrid=falseWhen displaying the gridgrid=false
grid=false
grid=truebinsA histogram-specific parameter that specifies the number of bins.
When setting the number of bins to 5bins=5When setting the number of bins to 10bins=10
[chart, histogram, bins=5][chart, histogram, bins=10]
4.3. How to describe the data
The description format of chart data differs depending on the chart type classification.
- Category plot
Charts classified as category plots describe data in the following CSV format. If there is only one series, the series name can be omitted.
(//series-name)?
(category-name, numerical-value)+If you want to specify multiple series, specify the series name.
[chart, bar]
--------------------------------
//Series-A
Category1,1
Category2,2
//Series-B
Category1,1
Category2,2
--------------------------------
- XY Plots
Charts classified as XY plots describe data in the following CSV format. If there is only one series, the series name can be omitted.
(//Series-name)?
(X-value, Y-value)+If you want to specify multiple series, specify the series name.
[chart, xy]
--------------------------------
//SeriesA
1,1
2,2
//SeriesB
1,1.5
2,2.5
--------------------------------
- Pie chart
Charts classified as Pie plot describe data in the following CSV format.
(Caregory-name, numerical-value)+If you want to specify multiple series, specify the series name.
[chart, pie]
--------------------------------
Category1,1
Category2,2
--------------------------------
5. Sample source
Here are some complete sample sources for chart output. Please refer to them when editing the chart.
5.1. Bar chart
[chart,bar, categoryLabel="category",valueLabel="value"]
-------------------------------------
//A
1, 45.6
2, 45.6
3, 45.6
//B
1, 27.8
2, 27.8
3, 27.8
//C
1, 15.2
2, 15.2
3, 15.2
//D
1, 4.2
2, 4.2
3, 4.2
//E
1, 2
2, 2
3, 2
-------------------------------------[chart,bar, orientation=horizontal, categoryLabel="category",valueLabel="value"]
-------------------------------------
1, 10
2, 20
3, 30
4, 60
5, 45
6, 20
-------------------------------------
[chart,bar, orientation=horizontal, categoryLabel="category",valueLabel="value"]
-------------------------------------
//A
1, 45.6
2, 45.6
3, 45.6
//B
1, 27.8
2, 27.8
3, 27.8
//C
1, 15.2
2, 15.2
3, 15.2
//D
1, 4.2
2, 4.2
3, 4.2
//E
1, 2
2, 2
3, 2
-------------------------------------5.2. Stacked bar chart
.`[chart,stacked-bar,...]`
[chart,stacked-bar,categoryLabel="category",valueLabel="value"]
-------------------------------------
//A
1, 45.6
2, 45.6
3, 45.6
//B
1, 27.8
2, 27.8
3, 27.8
//C
1, 15.2
2, 15.2
3, 15.2
//D
1, 4.2
2, 4.2
3, 4.2
//E
1, 2
2, 2
3, 2
-------------------------------------[chart,stacked-bar,…][chart,stacked-bar,orientation=horizontal, categoryLabel="category",valueLabel="value"]
-------------------------------------
//A
1, 45.6
2, 45.6
3, 45.6
//B
1, 27.8
2, 27.8
3, 27.8
//C
1, 15.2
2, 15.2
3, 15.2
//D
1, 4.2
2, 4.2
3, 4.2
//E
1, 2
2, 2
3, 2
-------------------------------------5.3. Line chart
[chart,line,categoryLabel="category",valueLabel="value"]
-------------------------------------
//1x
1, 1
2, 2
3, 3
4, 4
5, 5
6, 6
7, 7
//4x
1, 4
2, 8
3, 12
4, 16
5, 20
6, 24
7, 28
//4^2
1, 1
2, 4
3, 9
4, 16
5, 25
6, 36
7, 49
-------------------------------------
5.4. Area chart
[chart,area, title="Area chart",categoryLabel="category",valueLabel="value"]
-------------------------------------
//April
1, 4
3, 10
6, 15
9, 8
12, 5
//May
1, 20
3, 15
6, 13
9, 12
12, 14
-------------------------------------
[chart,area, title="Area chart", orientation=horizontal, categoryLabel="category",valueLabel="value"]
-------------------------------------
//April
1, 4
3, 10
6, 15
9, 8
12, 5
//May
1, 20
3, 15
6, 13
9, 12
12, 14
-------------------------------------
5.5. Stacked area chart
[chart,stacked-area,categoryLabel="category",valueLabel="value"]
-------------------------------------
//April
1, 4
3, 10
6, 15
9, 8
12, 5
//May
1, 20
3, 15
6, 13
9, 12
12, 14
-------------------------------------
5.6. XY chart
[chart,xy,xLabel="x",yLabel="y"]
-------------------------------------
// A
0,95.599
100,95.785
200,95.550
300,95.145
400,95.598
500,95.729
600,95.600
700,95.564
800,94.919
900,95.533
1000,95.224
// B
0,95.499
100,95.785
200,95.550
300,95.445
400,95.298
500,95.729
600,95.400
700,95.564
800,95.756
900,95.500
1000,95.30
-------------------------------------5.7. Scatter plot
[chart,scatter,xLabel="x",yLabel="y"]
-------------------------------------
//April
1, 4
3, 10
6, 15
9, 8
12, 5
//May
1, 20
3, 15
6, 13
9, 12
12, 14
-------------------------------------
5.8. Histgram chart
[chart, histogram, bins=10,xLabel="x",yLabel="y"]
-------------------------------------
//April
1
1
1
1
2
3
3
3
3
4
5
6
6
7
7.8
8.2
9
10
11
12
12
13
14
15
//May
1
1
2
3
4
5
6
7
7.8
8.2
8
9
9
9
10
10
10
10
11
12
13
14
-------------------------------------5.9. Pie chart
[chart, pie]
--------------------------------
category1,1
category2,2
--------------------------------
5.10. Doughnut chart
[chart, ring]
--------------------------------
category1,1
category2,2
--------------------------------
[chart, ring, caption="Ring Chart"]
--------------------------------
category1,1
category2,2
--------------------------------
5.11. Rader chart
[chart,radar]
-------------------------------------
// X
A, 1
B, 2
C, 3
D, 4
E, 5
// Y
A, 5
B, 4
C, 3
D, 2
E, 1
-------------------------------------
[chart,radar, fontSize="1.6", grid=true]
-------------------------------------
// X
A, 1
B, 2
C, 3
D, 4
E, 5
// Y
A, 5
B, 4
C, 3
D, 2
E, 1
-------------------------------------