Skip to main content

Image field and/or patch with clipping support for Plone/Archetypes.

Project description

Image field for Archetypes with different behavior at time of scaling.

Introduction

Archtypes default ImageField scales down the image until the whole image fits into the given scale. It keeps it aspect ratio. I.e. scaling down a 400x300 image to a 200x200 scale result in a 200x150 image.

Same with ClippingImageField results in a 200x200 image! It centers the image horizontal or vertical and tries to keep as much as possible from the original.

Tested with Plone 3.3.x and Plone 4.

Usage:

Field

Specify the sizes as documented for the classic Archetypes ImageField. If you want specific scales to get clipped, add a field-property crop_scales=['image_large','other_scale']. It expects a list of scale names to include into clipping.

Patch

By including patch.zcml in your package archetypes.clippingimage will patch Products.Archetypes.Field.ImageField so it is able to generate cropped scales.

You can define which scales shall be cropped by adding a property crop_scales to your ImageField:

ImageField('image',
    sizes= {'large'   : (768, 768),
            'preview' : (400, 400),
            'listing' :  (16, 16),
            },
    crop_scales = ['listing'],
    ...

Note that if you want to use clipped images within ATCTImage and have plone.app.imaging installed you need to set a property crop_scales at plone.app.blob.subtypes.image.SchemaExtender.fields[0].

Blob

In case of using the patch everythings fine. No further action needed. If you use the field, you need to include the blob.zcml to make the fields scales blobs.

Changelog

2.1

  • use the format of original image for computing the crop. the field used to convert everything to png which resulted in relatively large files [fRiSi]

2.0

  • make plone.app.imaging and plone.app.blob aware. Works now with Plone 4. [jensens]

  • sizes can be a callable or a dictionary (instance method not supported)

    background: plone.app.imaging uses the sizes defined in imaging_properties in case sizes is a dictionary. so you need to define sizes via a callable to make your custom sizes take effect. [fRiSi]

  • added monkeypatch for ImageField.scale to add croppingsupport to any ImageField [jensens, fRiSi]

License

Copyright (c) 2008-2009, BlueDynamics Alliance, Austria All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

  • Neither the name of the BlueDynamics Alliance nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY BlueDynamics Alliance ‘’AS IS’’ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BlueDynamics Alliance BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

archetypes.clippingimage-2.1.zip (13.2 kB view details)

Uploaded Source

Built Distribution

archetypes.clippingimage-2.1-py2.6.egg (8.8 kB view details)

Uploaded Source

File details

Details for the file archetypes.clippingimage-2.1.zip.

File metadata

File hashes

Hashes for archetypes.clippingimage-2.1.zip
Algorithm Hash digest
SHA256 b350f07ea170696f33c89bb37437a00e11511d1097606737198a1f28da38d31e
MD5 a02e9e5d62382035f8ac0281c3c80d39
BLAKE2b-256 8073d5fdd9031de67bb4fdc6ebe7341f37c20643250755a1b48a2c376e0db84f

See more details on using hashes here.

File details

Details for the file archetypes.clippingimage-2.1-py2.6.egg.

File metadata

File hashes

Hashes for archetypes.clippingimage-2.1-py2.6.egg
Algorithm Hash digest
SHA256 fda522319f5df1591590dde68a45f69100fe0ed0ca251eb60305e8f3a92e7869
MD5 ef9503c4f9e08576448b7917d52eb6c7
BLAKE2b-256 f51679a874caee2210e509fe980369d9cab9a8f0640aa02d55d077837811b290

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page