jFocalPoint
Image
ImageMetaData
DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!
Class Image
This class represents an image with additional configuration capabilities (e.g. optional focal point). Furthermore it provides access to meta data of the referenced image file.
See Also:
Property Summary
| Property | Description |
|---|---|
file: MediaFile (read-only) | Returns the image media file from the current site’s library. |
focalPoint: FocalPoint (read-only) | Returns the focal point of the image. |
metaData: ImageMetaData (read-only) | Returns the meta data of the physical image file. |
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
| Method | Description |
|---|---|
| getFile() | Returns the image media file from the current site’s library. |
| getFocalPoint() | Returns the focal point of the image. |
| getMetaData() | Returns the meta data of the physical image file. |
Methods inherited from class Object
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Property Details
file
- file: MediaFile
(read-only) Returns the image media file from the current site's library.
focalPoint
- focalPoint: FocalPoint
(read-only) Returns the focal point of the image.
metaData
- metaData: ImageMetaData
(read-only) Returns the meta data of the physical image file. This meta data is obtained when the respective component attribute was saved from Page Designer, i.e. the underlying image is not queried for the meta data every time getMetaData() is called but only on store of the related component attribute.
Method Details
getFile()
- getFile(): MediaFile
Returns the image media file from the current site's library.
Returns:
- the image media file, or null if not found
getFocalPoint()
- getFocalPoint(): FocalPoint
Returns the focal point of the image.
Returns:
- the focal point, or null if not found
getMetaData()
- getMetaData(): ImageMetaData
Returns the meta data of the physical image file. This meta data is obtained when the respective component attribute was saved from Page Designer, i.e. the underlying image is not queried for the meta data every time getMetaData() is called but only on store of the related component attribute.
Returns:
- the meta data of the image, or null if no meta data was provided with the respective component attribute
jDID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!