ImgFormat_GetInfo_JSN¶
Return information about an image format.
ImgFormat_GetInfo_JSN(formatID) ➔ formatInfoJSON
→ | formatID |
Text | Image format identifier |
↩︎ | formatInfoJSON |
Text | The image format information in JSON. |
Return information about an image format.
Parameter formatID
is the identifier of the image format. If formatID
is not a valid image format identifier or empty, an empty string is returned.
Information about the image format is returned in formatInfoJSON
as a
JSON-serialized 4D object containing the following properties:
Property name | Type | Description |
---|---|---|
ID |
String |
The identifier of the format. |
Name |
String |
The name of the format. |
UTI |
String |
The Universal Type Identifier of the format. |
MIMETypes |
array string |
A list of MIME types associated with the format. |
Extensions |
array string |
A list of filename extensions associated with the format. |
CanEncode |
Boolean |
Set to True if the format supports encoding/exporting. |
IsRaster |
Boolean |
Set to True if the format raster-based. |
IsVector |
Boolean |
Set to True if the format vector-based. |
HasThumbnails |
Boolean |
Set to True if the format supports embedded thumbnails. |
HasXMP |
Boolean |
Set to True if the format supports XMP. |
Note
The ImgFormat_GetInfo
method in the Q2PixLib component is a
convenience wrapper for this method that returns the format information directly as
a 4D object instead of a JSON serialization.