export

Typecommand
DictionaryLCS
LibraryLiveCode Script
Syntax
export [<format>] [with metadata <metadata>] to {file <filePath> | <container>} [with mask <maskFile>]
export <image> [with metadata <metadata>] to {file <filePath> | <container>} [as <format>] [with mask <maskFile>]
Summary

Exports the selected image as a PBM, JPEG, GIF, BMP or PNG file.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, mobile
Parameters
NameTypeDescription
format

The desired file format to export.

paint: PBM, PGM, or PPM
JPEG: Joint Photographic Experts Group
GIF: Graphics Interchange Format
BMP: device independent bitmap
PNG: Portable Network Graphics
metadata
filePath

The filePath specifies the name and location of the file you want to export to. If you specify a name but not a location, the file is created in the defaultFolder.

container

A reference to a container, usually another image or a URL.

maskFile

The maskFile specifies the name and location of a file to export as an image mask. You can use a maskFile only when exporting in PBM format (paint).

image

A reference to an image. The metadata is an array of metadata. Currently the only key supported is "density" with a value in pixels per inch (ppi).

Example
export paint to file "Picture" with mask "../circlemask"
export JPEG to URL "binfile:next.jpg"
export image "Parachute" to myVariable as GIF
export image thisImage to file "Thumbnail" as PNG
RelatedKeyword: file, image, paint, as
Property: JPEGQuality, selected
Command: export, export snapshot, import
Glossary: JPEG, GIF, export, PBM, container, PPM, PNG, BMP, command
Securitydisk
Description

Use the export command to export an image to a file or container.

If you use the form export format to..., the selected image is exported.

The export paint form exports the image as a PBM, PGM, or PPM file, depending on the image's colors. (Optionally, you can specify a location for the mask file.) The export JPEG form exports as a JPEG file, the export PNG form exports as a PNG file and the export BMP form exports as a BMP. If you don't specify a format, the file is exported as PBM, PGM, or PPM.