11# Usage
22
3- This documentation is written for Excel-to-JSON version 1.5 .0.0
3+ This documentation is written for Excel-to-JSON version 2 .0.0
44
55Reading [ Get Started] ( getstarted.md ) section first is strongly recommended.
66
77 Line break in an Excel cell will be rendered as <br>
8+
89 <a name =" Conversiontypes " ></a >
910## Conversion
1011
@@ -15,7 +16,17 @@ Reading [Get Started](getstarted.md) section first is strongly recommended.
1516* The first row will be interpreted as header.
1617* The following rows will be mapped with header as you can see in the following example.
1718
18- ** Example Excel sheet**
19+ ## Conversion Mode
20+ * Flat JSON mode
21+ * Simply convert Excel datasheet to a flat JSON.
22+ * Nested JSON mode
23+ * First convert Excel datasheet to a flat JSON
24+ * then, unflatten an object with delimited keys using "Flat" [ https://www.npmjs.com/package/flat ] ( https://www.npmjs.com/package/flat )
25+ * unflatten() is called by Excel-to-JSON, with delimiter as ".", overwrite as true.
26+
27+ ## Examples
28+
29+ ** Example Excel sheet 1**
1930
2031
2132| Name| Age| Company|
@@ -26,6 +37,7 @@ Reading [Get Started](getstarted.md) section first is strongly recommended.
2637| Linda| 30| Microsoft|
2738| Joe| 40| Github|
2839
40+ > Using Flat JSON mode
2941
3042** Example JSON**
3143
@@ -59,6 +71,62 @@ Reading [Get Started](getstarted.md) section first is strongly recommended.
5971]
6072```
6173
74+ ** Example Excel sheet 2**
75+
76+ | id| student.name| student.familyname| student.age|
77+ | ---| ---| ---| ---|
78+ | 1| Meimei| Han| 12|
79+ | 2| Lily| Jaskson| 15|
80+ | 3| Elon| Mask| 18|
81+
82+ > Using Flat JSON Mode
83+
84+ ``` json
85+ [{
86+ "id" : 1 ,
87+ "student.name" : " Meimei" ,
88+ "student.familyname" : " Han" ,
89+ "student.age" : 12
90+ }, {
91+ "id" : 2 ,
92+ "student.name" : " Lily" ,
93+ "student.familyname" : " Jaskson" ,
94+ "student.age" : 15
95+ }, {
96+ "id" : 3 ,
97+ "student.name" : " Elon" ,
98+ "student.familyname" : " Mask" ,
99+ "student.age" : 18
100+ }]
101+ ```
102+
103+ > Using Nested JSON mode
104+
105+ ``` json
106+ [{
107+ "id" : 1 ,
108+ "student" : {
109+ "name" : " Meimei" ,
110+ "familyname" : " Han" ,
111+ "age" : 12
112+ }
113+ }, {
114+ "id" : 2 ,
115+ "student" : {
116+ "name" : " Lily" ,
117+ "familyname" : " Jaskson" ,
118+ "age" : 15
119+ }
120+ }, {
121+ "id" : 3 ,
122+ "student" : {
123+ "name" : " Elon" ,
124+ "familyname" : " Mask" ,
125+ "age" : 18
126+ }
127+ }]
128+
129+ ```
62130
63131
64132<a name =" jsonOutput " ></a >
0 commit comments