apostrophe-attachments (browser)

Inherits from: apostrophe-context‚Äč

Methods

url(file, options)

Given an attachment field value, return the file URL. If options.size is set, return the URL for that size (one-third, one-half, two-thirds, full). full is "full width" (1140px), not the original.

If you don't pass the options object, or options does not have a size property, you'll get the URL of the original.

You can also pass a crop object (the crop must already exist).

crop(attachment, options, callback)

Invoke with an attachment, options (such as minSize), and a callback. Callback receives (err, crop). If no err, crop has coordinates and can be stored as the crop property of the attachment (when there is one and only one crop ever for this attachment), or stored as part of a relationship to the doc containing the attachment; that part is up to you.

focalPoint(attachment, options, callback)

Invoke with an attachment, options (such as minSize), and a callback. Callback receives (err, focalPoint). If no err, focalPoint has x and y properties and can be stored as the focalPoint property of the attachment (when there is one and only one focal point ever for this attachment), or stored as part of a relationship to the doc containing the attachment; that part is up to you.

addFieldType()

populate(object, name, $field, $el, field, callback)

convert(data, name, $field, $el, field, callback)

addHandlers()

updateExisting($fieldset, info, field)