Excelerant API

Example JSON Payload

[
	{
		"name": "Sheet-One",
		"cols": [
			{
				"header": "ID",
				"id": "id",
				"format": {
					"color": "FF81A4FA",
					"bold": true
				}
			},
			{
				"header": "First Name",
				"id": "first_name",
				"format": {
					"color": "FF81A4FA",
					"bold": true
				}
			},
			{
				"header": "Last Name",
				"id": "last_name",
				"format": {
					"color": "FF81A4FA",
					"bold": true
				}
			},
			{
				"header": "Email Address",
				"id": "email",
				"format": {
					"color": "FF81A4FA",
					"bold": true
				}
			}
		],
		"rows": [
			{
				"id": "f477bb74fc8bbffb2910507545d48b41",
				"first_name": {
					"value": "Cornelius",
					"format": {
						"color": "FFC1C1C1"
					}
				},
				"last_name": "Hargrave",
				"email": "chargrave0@woothemes.com"
			},
			{
				"id": "13d499aa00b64e3c89edc28946ddac37",
				"first_name": "Jason",
				"last_name": "Mableson",
				"email": "jmableson1@hubpages.com",
				"format": {
					"color": "FFC1C1C1"
				}
			}
		]
	},
	{
		"name": "Sheet-Two",
		"cols": [
			{
				"header": "ID",
				"id": "id",
				"format": {
					"color": "FF81A4FA",
					"bold": true
				}
			},
			{
				"header": "First Name",
				"id": "first_name",
				"format": {
					"color": "FF81A4FA",
					"bold": true
				}
			},
			{
				"header": "Last Name",
				"id": "last_name",
				"format": {
					"color": "FF81A4FA",
					"bold": true
				}
			},
			{
				"header": "Email Address",
				"id": "email",
				"format": {
					"color": "FF81A4FA",
					"bold": true
				}
			}
		],
		"rows": [
			{
				"id": "f477bb74fc8bbffb2910507545d48b41",
				"first_name": "Cornelius",
				"last_name": "Hargrave",
				"email": "chargrave0@woothemes.com",
				"format": {
					"color": "FFC1C1C1"
				}
			},
			{
				"id": "13d499aa00b64e3c89edc28946ddac37",
				"first_name": "Jason",
				"last_name": "Mableson",
				"email": "jmableson1@hubpages.com",
				"format": {
					"color": "FFC1C1C1"
				}
			}
		]
	}
]

Table of contents

Type Aliases

• AlignmentJson
• BackgroundFillJson
• BorderFormatJson
• BorderJson
• BorderStyle
• FontFamily
• FormatCode
• FormatJson
• WorkbookJson
• WorksheetCellJson
• WorksheetColJson
• WorksheetJson
• WorksheetRowArrayJson
• WorksheetRowJson
• WorksheetRowObjectJson

Type Aliases

AlignmentJson

Ƭ AlignmentJson: Object

Type declaration

Name	Type
horizontal?	"left" | "center" | "right" | "justify"
vertical?	"top" | "middle" | "bottom" | "justify"

---

BackgroundFillJson

Ƭ BackgroundFillJson: Object

Type declaration

Name	Type	Description
color	string	Background fill color as a hex encoded AARRGGBB string. Example FF00FF00 would be bright green.

---

BorderFormatJson

Ƭ BorderFormatJson: Object

Type declaration

Name	Type	Description
color?	string	Border color as a hex encoded AARRGGBB string. Example FF00FF00 would be bright green.
style?	BorderStyle	Border style

---

BorderJson

Ƭ BorderJson: Object

Type declaration

Name	Type
bottom?	BorderFormatJson
left?	BorderFormatJson
right?	BorderFormatJson
top?	BorderFormatJson

---

BorderStyle

Ƭ BorderStyle: "thin" | "dotted" | "dashDot" | "hair" | "dashDotDot" | "slantDashDot" | "mediumDashed" | "mediumDashDot" | "mediumDashDotDot" | "medium" | "double" | "thick"

---

FontFamily

Ƭ FontFamily: string

Example: Arial, Calibri, Helvetica, Courier New, etc…

---

FormatCode

Ƭ FormatCode: string

See supported Excel format codes

---

FormatJson

Ƭ FormatJson: Object

Type declaration

Name	Type	Description
alignment?	AlignmentJson	Cell alignment
background?	string | BackgroundFillJson	Cell background fill
bold?	boolean	Cell value should be bold
border?	BorderJson	Cell border
color?	string	Cell value color as a hex encoded AARRGGBB string. Example FF808000 would be bright yellow.
font?	FontFamily	Cell font family name
formatCode?	FormatCode	Cell format code
italic?	boolean	Cell value should be italicized
size?	number	Cell font size

---

WorkbookJson

Ƭ WorkbookJson: WorksheetJson[]

---

WorksheetCellJson

Ƭ WorksheetCellJson: string | { format?: FormatJson ; value: string }

---

WorksheetColJson

Ƭ WorksheetColJson: Object

Type declaration

Name	Type	Description
format?	FormatJson	The format for every cell in the column. Row and cell-specific formatting rules will take precedence.
header	string	-
id	string	-

---

WorksheetJson

Ƭ WorksheetJson: Object

Type declaration

Name	Type
cols	WorksheetColJson[]
name	string
rows	WorksheetRowJson[]

---

WorksheetRowArrayJson

Ƭ WorksheetRowArrayJson: WorksheetCellJson[]

---

WorksheetRowJson

Ƭ WorksheetRowJson: WorksheetRowArrayJson | WorksheetRowObjectJson

A worksheet row can either be an array of WorksheetCellJson values or an object of key/value pairs.

---

WorksheetRowObjectJson

Ƭ WorksheetRowObjectJson: Record<string, WorksheetCellJson&gt; & { format?: FormatJson }