FileSaver

An instance of the FileSaver class enables the user to save one or more instances of the FileWrapper class to disk using the system-provided file picking interface.

Properties

Here are the properties of the FileSaver class.

• message (String) • A message to display describing what file is being saved. This is currently only supported on macOS.

• nameLabel (String) • The label shown next to the user-editable file name field. This is currently only supported on macOS.

• prompt (String) • The prompt shown on the the save button. This is currently only supported on macOS.

• types (Array of TypeIdentifier) • The file types that will be allowed. If null, all file types will be allowed. Defaults to null.

Constructors

The mechanism for creating a new instance of the FileSaver class.

• new FileSaver() → (FileSaver) • Returns a new file saver with default settings.

Instance Functions

The functions that can be executed on an instance of the FileSaver class.

• show(fileWrapper:FileWrapper) → (Promise) • Presents the system file saving interface to the user, allowing them to choose a location and file name to save the file wrapper. The returned Promise will yield the chosen URL on success. If the user cancels chosing, the Promise will be rejected.

Default Document Export
Copy  OmniPlan OmniGraffle OmniOutliner OmniFocus

var wrapperPromise = document.makeFileWrapper("Default Name")

wrapperPromise.then(wrapper => {
	filesaver = new FileSaver()
	fileSaverPromise = filesaver.show(wrapper)

	fileSaverPromise.then(urlObj => {
		console.log(urlObj.string)
		new Alert("FILE URL", urlObj.string).show()
	})

	fileSaverPromise.catch(err => {
		console.log(err.message)
	})
})

wrapperPromise.catch(err => {
	console.log(err.message)
})

Saving/Exporting a Specific Document Type

The following Omni Automation script demonstrates how to save an OmniPlan document to file. Similar procedures are used by all Omni applications to export data and documents to file.

Detailed documentation regarding the TypeIdentifer class, and its use to generate application-specific FileWrappers, can be found in the TypeIdentifer topic.

Save OmniPlan Document
Copy Run Script

var fileTypeID = 'com.omnigroup.omniplan2.planfile'
var dc = Calendar.current.dateComponentsFromDate(new Date())
var dateSlug = dc.month + "-" + dc.day + "-" + dc.year
var defaultName = "Backup" + "-" + dateSlug //--> 8-23-21
var wrapperPromise = document.makeFileWrapper(defaultName, fileTypeID)

wrapperPromise.then(wrapper => {
	var filesaver = new FileSaver()
	filesaver.message = "Choose the location for the saved file:" // macOS
	filesaver.nameLabel = "Name:" // macOS
	filesaver.prompt = "Continue" // macOS
	filetype = new FileType(fileTypeID)
	filesaver.types = [filetype]
	var fileSaverPromise = filesaver.show(wrapper)

	fileSaverPromise.then(urlObj => {
		console.log(urlObj.string)
	})

	fileSaverPromise.catch(err => {
		console.log(err.message)
	})
})

wrapperPromise.catch(err => {
	console.error(err.message)
})

Multiple Exports

In an application such as OmniGraffle, the need to export multiple instances of a canvas in various formats, in not an unusal occurence. The FileWrapper class includes a function for creating a folder wrapper that contains other file wrappers as its contents. The folder wrapper is passed to the FileSaver instance and when executed, a new directory containing the exported files is created on disk.

• withChildren(name:String or null, children:Array of FileWrapper) → (FileWrapper r/o) • Returns a new file wrapper that represents a directory with the given child file wrappers. Each child file wrapper must have a unique name specified.

In the following script example, the current OmniGraffle canvas is exported as both an image in PNG format, and as a PDF file, both placed within a created directory.

Multiple Export to Folder
Copy Run Script

// EXPORT CANVAS TO TWO FILES IN FOLDER
cnvsName = document.windows[0].selection.canvas.name

var PNGwrapperPromise = document.makeFileWrapper(cnvsName, "public.png")
var PDFwrapperPromise = document.makeFileWrapper(cnvsName, "com.adobe.pdf")
var promises = [PNGwrapperPromise, PDFwrapperPromise]

Promise.all(promises).then(fileWrappers => {

	// Create and Show File Saver
	var filesaver = new FileSaver()
	var folderType = new FileType("public.folder")
	filesaver.types = [folderType, FileType.png, FileType.pdf]
	var fldrwrapper = FileWrapper.withChildren("Export Folder", fileWrappers)
	var fileSaverPromise = filesaver.show(fldrwrapper)

	// Process File Saver Result
	fileSaverPromise.then(urlObj => {
		console.log(urlObj.string)
	})

	fileSaverPromise.catch(err => {
		console.log(err.message)
	})
	
}).catch(err => {
	console.log("Error", err.message)
})

Export Layers

Here’s another example plug-in that exports the layers of the current canvas as either individual PNG files, or as images composited from the bottom to the topmost layer.

Export Layers to Images
Copy Download Plug-In

/*{
	"type": "action",
	"targets": ["omnigraffle"],
	"author": "Otto Automator",
	"identifier": "com.omni-automation.og.export-layers-current-vanvas",
	"version": "1.0",
	"description": "Exports the layers of the current canvas as either individual PNG files, or as images composited from the bottom to the topmost layer.",
	"label": "Export Current Canvas Layers",
	"shortLabel": "Export Layers",
	"paletteLabel": "Export Layers",
	"image": "gearshape"
}*/
(() => {
	var action = new PlugIn.Action(function(selection, sender){
		var exportOptions = ["Individual Images","Composited Images"]
		var exportOptionsMenu = new Form.Field.Option(
			"exportOption", 
			null, 
			[0,1], 
			exportOptions, 
			0
		)

		var inputForm = new Form()
		inputForm.addField(exportOptionsMenu)

		var formPrompt = "Choose the export style:"
		var buttonTitle = "Continue"
		var formPromise = inputForm.show(formPrompt,buttonTitle)

		formPromise.then(formObject => {
			var exportOptionIndex = formObject.values["exportOption"]

			var cnvs = document.windows[0].selection.canvas
			cnvs.layers.forEach(layer => layer.visible = false)
			var wrapperPromises = new Array()
			cnvs.layers.slice().reverse().forEach((layer, index) => {
				layer.visible = true
				var exportName = encodeURIComponent(index + "-" + layer.name)
				var fileTypeID = "public.png"
				var promise = document.makeFileWrapper(exportName, fileTypeID)
				wrapperPromises.push(promise)
				if (exportOptionIndex === 0){layer.visible = false}
			})
			cnvs.layers.forEach(layer => layer.visible = true)
			
			Promise.all(wrapperPromises).then(wrappers => {
				// Create and Show File Saver
				var filesaver = new FileSaver()
				var folderType = new FileType("public.folder")
				filesaver.types = [folderType, FileType.png, FileType.pdf]
				var docName = document.name
				var fldrwrapper = FileWrapper.withChildren(`${docName} Export Folder`, wrappers)
				var fileSaverPromise = filesaver.show(fldrwrapper)
				// Process File Saver Result
				fileSaverPromise.then(urlObj => {urlObj.open()})
			})
		})		
	});

	action.validate = function(selection, sender){
		return true
	};
	
	return action;
})();

Exporting Text to File

Here’s an example OmniGraffle action plug-in that will save the text contents of the selected shape to a file on disk:

Save Shape Text to File
Copy Download Plug-In

/*{
	"type": "action",
	"targets": ["omnigraffle"],
	"author": "Otto Automator",
	"identifier": "com.omni-automation.og.shape-text-to-file",
	"version": "1.1",
	"description": "This action will save the text contents of the selected shape to a file on disk.",
	"label": "Save Shape Text to File",
	"shortLabel": "Text to File"
}*/
(() => {
	var action = new PlugIn.Action(function(selection, sender){
		// action code
		// selection options: canvas, document, graphics, lines, solids, view
		
		var shape = selection.solids[0]
		var shapeText = shape.text
		
		var wrapper = FileWrapper.withContents('Shape Text.txt', Data.fromString(shapeText))
		var filesaver = new FileSaver()
		var fileSaverPromise = filesaver.show(wrapper)
		
		fileSaverPromise.then(urlObj => {
			console.log(urlObj.string)
			urlObj.open()
		})

		fileSaverPromise.catch(err => {
			console.log(err.message)
		})
	});

	action.validate = function(selection, sender){
		// validation code
		// selection options: canvas, document, graphics, lines, solids, view
		
		if (selection.solids.length === 1){
			return (selection.solids[0].text != "")
		}
		return false
	};
	
	return action;
})();