# SharinPix Abilities

This article covers the following.

* [What are SharinPix Image Abilities ?](#what-are-sharinpix-image-abilities)
* [Where are SharinPix Abilities used ?](#where-are-sharinpix-abilities-used)
* [Generate SharinPix abilities automatically](#generate-sharinpix-abilities-automatically)

## What are SharinPix Image Abilities ?

SharinPix abilities are designations that can expand or restrict the features enabled on the SharinPix Album.

## Where are SharinPix Abilities used ?

* On the SharinPix Visualforce Component: [Using on Classic with a Visualforce Page WITHOUT an Apex Controller (Admin Friendly version)](https://docs.sharinpix.com/documentation/features/main-integration/using-on-classic-with-a-visualforce-page-without-an-apex-controller-admin-friendly-version)
* On the SharinPix Canvas App: [Using on Classic with SharinPix Canvas App](https://docs.sharinpix.com/documentation/features/main-integration/using-on-classic-with-sharinpix-canvas-app)
* On the SharinPix Album within a web form: [Using on a Web Form](https://docs.sharinpix.com/documentation/features/main-integration/using-on-a-web-form)
* As a way to launch the SharinPix Offline Mobile App from Salesforce FSL mobile application: [Using on Field Service Lightning App](https://docs.sharinpix.com/documentation/features/main-integration/using-on-salesforce-field-service-app-field-service-lightning)

Find below a list of abilities and the features they enable.

## 1. see

The see ability allows the images on a SharinPix Album to be accessible and visible.

The screenshot below shows what happens when **see** is enabled on the SharinPix Album.

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FZO2OoEZj9yRwTOUbJGTX%2Fasimg2.png?alt=media&#x26;token=4833d253-cabd-4b38-bd00-dd3ed034d2c4" alt=""><figcaption></figcaption></figure>

## 2. image\_list

The **image\_list** ability allows the SharinPix Album to display images for all users.

The screenshot below shows what happens when the **image\_list** ability is enabled.

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FuGkNmi0yCa0vEgY9DqG0%2Fasimg3.png?alt=media&#x26;token=0e7cb3ad-1b43-4b48-92cc-f8e5182445aa" alt=""><figcaption></figcaption></figure>

## 3. image\_upload

The **image\_upload** ability allows images to be added to the SharinPix Album.

The result on the SharinPix Album when **image\_upload** is enabled.

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FageZWjPaUrHaqykKvbIu%2Fasimg4.png?alt=media&#x26;token=2cfc292f-e8c8-46fa-8bd5-8c0d5de45eb8" alt=""><figcaption></figcaption></figure>

## 4. image\_tag

The **image\_tag** ability allows images to be tagged with different labels.

The result on the SharinPix Album when the **image\_tag** ability is enabled.

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FXMwzxkMc7hGEyai0NEB5%2Fasimg7.png?alt=media&#x26;token=964b08b0-472b-4e29-b217-ed7a9b27e860" alt=""><figcaption></figcaption></figure>

The result on the SharinPix Album when the **image\_tag** ability is disabled.

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Ft89z8c5cPdiZkvDfiKqg%2Fasimg8.png?alt=media&#x26;token=56391f24-9fa1-4dfd-8565-feef245e1f21" alt=""><figcaption></figcaption></figure>

## 5. Share

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FISsyMLVGlHYC3S1C3Tz5%2Fasimg9.png?alt=media&#x26;token=6c01f815-0ced-4d90-9cee-b8162aefdb0d" alt=""><figcaption></figcaption></figure>

The **Share** ability allows the creation of a link that makes it possible for selected images to be shared publicly. For more information on how to use the Share feature, click [here](https://docs.sharinpix.com/documentation/features/menu-commands/share-link).

## 6. image\_copy

The **image\_copy** ability allows the user to select one or more images and copy them from one SharinPix Album and paste them onto another SharinPix Album.

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FO5RfPo22I1fgznmRFZ4Z%2Fimg9.png?alt=media&#x26;token=7fe87614-ab2f-46d9-8340-3cafb8d8fe8b" alt=""><figcaption></figcaption></figure>

## 7. image\_duplicate

The ability **image\_duplicate** makes an exact copy of a selected image.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-eb0457e21d844b3874309ef525e18c25924df49c%2Fduplicate.png?alt=media)

## 8. image\_annotate

The ability **image\_annotate** allows the user to attach an annotation to a given image. The annotation can be a geometric shape, a free-hand sketch, or even a sticker, etc..

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-da13aa4c18aca067d99609bf9a0338b5dafd9c96%2Fannotate.png?alt=media)

## 9. image\_rotate

The **image\_rotate** ability enables the user to rotate the image in a clockwise or anti-clockwise direction.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-c386eb99879c069bdf0f70ebdfdc23848b3c3a38%2Frotate.png?alt=media)

## 10. image\_crop

The **image\_crop** ability enables the user to crop out any part of a given image.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-54a36f8d76cd454b0b12a531a792a71f26fc5a84%2Fcrop.png?alt=media)

## 11. image\_download

The **image\_download** ability enables the user to download a given image on his/her own device.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-5c4caafaa4babd22f5c55735f87f7f7a65872746%2Fdownload%20\(1\).png?alt=media)

## 12. image\_delete

The **image\_delete** ability enables the user to delete an image or multiple images from the SharinPix Album.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-2f10c65412d48f5e6cd9756945f28cc9a2465a4f%2Fdelete.png?alt=media)

## 13. image\_caption

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-8fdbfc4a77f85d6a937ed2481a7171a888db211d%2Fcaption%20\(1\).png?alt=media)

The **image\_caption** ability enables the user to add a **Title** and **Description** to an image.

## 14. annotation\_toggle

The **annotation\_toggle** ability enables the user to toggle the visibility of the annotations which are already present on the given image.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-65b42cd003c4c0ea8001f9fd5608bfc415111695%2Fannotated.png?alt=media)

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-f8b353f0ca4a37c916e35db0b9f2bf57ede327ea%2Funannotated.png?alt=media)

## 15. color\_adjustment

The **color\_adjustment** ability enables the user to adjust the brightness, contrast and saturation of the image.

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FjAqVUOI6DxBmn91m17J1%2Fasimg10.png?alt=media&#x26;token=cd0bd975-fc3c-4bcb-84a3-77df5375a447" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FUnPnNEiENjOAt66EApLv%2Fasimg11.png?alt=media&#x26;token=d9ca4d9a-3823-4ddd-9a6e-2eef399d760e" alt=""><figcaption></figcaption></figure>

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-da6db2050dbc97a18b88932af52fb38ab21ad8c1%2F3%20\(7\).png?alt=media)

## Behavior abilities

Some abilities also permit changing the behavior of the SharinPix Album, such as sorting.

With  <mark style="color:$danger;">`Sort`</mark> you can use these 2 parameters:

* <mark style="color:$danger;">`field`</mark>- corresponds to the date used to sort the images of the search results. It takes two values:
  * <mark style="color:$danger;">`created_at`</mark> - It is the date on which the image has been uploaded to SharinPix.
  * <mark style="color:$danger;">`date_taken`</mark> - It is the date on which the photo has been captured by a device.
* <mark style="color:$danger;">`order`</mark>  - corresponds to the order in which the images appear in the search results. it takes these values:
  * <mark style="color:$danger;">`asc`</mark> - The images appear from the least recent to the most recent(based on the date defined in <mark style="color:$danger;">`field`</mark>)
  * <mark style="color:$danger;">`desc`</mark> - The images appear from the most recent to the least recent(based on the date defined in <mark style="color:$danger;">`field`</mark>)

You can use this as an example in a inline VF Page with this code to force the sort to be ascending and depending on the date on which the photo has been captured by the camera:

```
<SharinPix:SharinPix height="500px" 
                     parameters="{
                        'Id': '{!CASESAFEID($CurrentPage.parameters.Id)}',
                        'abilities':{
                        '{! CASESAFEID($currentPage.parameters.Id) }':{
                        'Access':{'see':true,
                                'image_list':true,
                                'image_upload':true,
                                'image_delete':true,
                                'fullscreen':true,
                                'image_caption':true}},
                        'Sort':{'field':'taken_at',
                                'order':'asc'}
                        }
                    }"
/>
```

### Generate SharinPix abilities automatically <a href="#generate-sharinpix-abilities-automatically" id="generate-sharinpix-abilities-automatically"></a>

&#x20;The **SharinPix Code Generator** offers a quick and easy user interface to select the different SharinPix Abilities and generate the corresponding Code to be used in:

* Canvas App
* Visualforce Component
* Apex Custom Controller
* Lightning Component
* SharinPix Permission

{% hint style="danger" %}
**Alert:**\
\
Where do we find the Standard Album Function? What I have that says this doesn't look like this.
{% endhint %}

From the **Standard album function** section, select the SharinPix Abilities you want to enable on the SharinPix Album.&#x20;

* **Default:** the default value is automatically assigned for each SharinPix Ability.
* **Yes for All options:** Enable all SharinPix Abilities.
* **No for All options:** Disable all SharinPix Abilities.
* Select **Default**/**Yes**/**No** for each SharinPix Ability to assign its default value or enable/disable it accordingly.

The screenshot below describes the **Standard album function** section:

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-648714160ba1775e6ebc66d33d971b7ae46da1a3%2Fstandard-album-function.png?alt=media)

After selecting the value for each SharinPix ability, the automatically-generated code for each component is shown in the following samples:

### Canvas

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-e09db2c879e32a6c4461cfa8f0ad4eb7a8daf4de%2Fcanvas.png?alt=media)

### Visualforce Component

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-f7d4f8f29ee8fe570737fc73e3b35a0a308be014%2Fvf_component.png?alt=media)

### SharinPix with Apex Custom Controller

<figure><img src="https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2FKuI49DDjGAjKKO1Hblf1%2Fasimg18.png?alt=media&#x26;token=4e7a3e26-20ef-40d6-a15e-30fcb6117995" alt=""><figcaption></figcaption></figure>

### Lightning Component

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-c3c2a6bc4f548f012d2c6b2884e6ff467017909a%2Flightning_component.png?alt=media)

### Date Format

If Empty, no dates are displayed on the thumbnail.

If not empty, the date is displayed (depending on the field used for sorting, the date could be either date taken or date uploaded).

More information about date formats can be found [here](https://docs.sharinpix.com/documentation/access-and-security/broken-reference).
