Origami Frontend Components & Services

imageset.json

imageset.json is a JSON format file that is responsible for describing various aspects of an Origami Imageset. It is under active development and subject to change, required properties indicate those that Origami tools or services may still rely on.

Properties

sourceDirectory

Type String
Required true

The relative path to the folder which contains the images within the imageset.

{
	"sourceDirectory": "src"
}

scheme

Type String
Required true

Defines the custom url scheme for images in this imageset when requested via the Origami Image Service, with a unique name across all the imagesets:

{
	"scheme": "ftanimal"
}

images

Type Array
Required true

A list of image objects for each image in the imageset. This section is automatically generated by the Origami Image Set Tool. Each object in the list accepts the following properties:

required:

optional:

{
	"images": [
		{
			"name": "cat",
			"extension": "svg",
			"path": "src/cat.svg",
			"previousHash": "a6441d64330b058d829f17d515864c2a2b0a8232d69c0a547edbe4c959967dfabad9b91df9670b1126273880fd6648e9c62a88839ee0467f9aa9e5006f7e0406",
			"hash": "a6441d64330b058d829f17d515864c2a2b0a8232d69c0a547edbe4c959967dfabad9b91df9670b1126273880fd6648e9c62a88839ee0467f9aa9e5006f7e0406",
			"url": "https://origami-images.ft.com/ftanimal/v1/cat-a6441d64330b058d829f17d515864c2a2b0a8232d69c0a547edbe4c959967dfabad9b91df9670b1126273880fd6648e9c62a88839ee0467f9aa9e5006f7e0406"
		},
	]
}

Example

This example joins all of the property snippets outlined above:

{
	"sourceDirectory": "src",
	"scheme": "ftanimal",
	"images": [
		{
			"name": "cat",
			"extension": "src",
			"path": "src/cat.svg",
			"previousHash": "a6441d64330b058d829f17d515864c2a2b0a8232d69c0a547edbe4c959967dfabad9b91df9670b1126273880fd6648e9c62a88839ee0467f9aa9e5006f7e0406",
			"hash": "a6441d64330b058d829f17d515864c2a2b0a8232d69c0a547edbe4c959967dfabad9b91df9670b1126273880fd6648e9c62a88839ee0467f9aa9e5006f7e0406",
			"url": "https://origami-images.ft.com/ftanimal/v1/cat-a6441d64330b058d829f17d515864c2a2b0a8232d69c0a547edbe4c959967dfabad9b91df9670b1126273880fd6648e9c62a88839ee0467f9aa9e5006f7e0406"
		},
	]
}