> For the complete documentation index, see [llms.txt](https://docs.sharinpix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sharinpix.com/documentation/lightning-web-component/sharinpix-sketcher.md).

# SharinPix Sketcher

The **SharinPix Sketcher** component enables users to annotate sketches. Common annotation features provided by this component include the addition of polygons, lines, shapes, text, and many more. [This functionality is also available for offline use in Salesforce Field Service (SFS).](/documentation/lightning-web-component/sharinpix-sketch-components-for-salesforce-field-service-usage.md)

{% hint style="info" %}
**Information:**

This feature is only available on Lightning. It can be used:

* On Page Builder
* On Desktop
* Field Service Mobile (accessible both online and offline)
  {% endhint %}

## Getting Started

To use the SharinPix Sketcher component, simply need to drag and drop the component from the Lightning App Builder onto your page layout.

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

## SharinPix Sketcher Setting

To use SharinPix Sketch on both desktop and mobile, you should ensure the following for the SharinPix Sketch component:

* Assign the permission set, **SharinPix Sketch Permission** , to the users.
* Follow the steps below to set up a SharinPix Sketch Template and use of SharinPix Sketcher:
  1. Go to the App Launcher and find the **Sketch Template**.
  2. Create a new template and insert the **SVG** of an image into the **template** field.
  3. Go to the object where you will add the SharinPix Sketcher and edit the record page to add the component.
  4. In the SharinPix Sketcher component, select the Sketch Template.
  5. Begin adding annotation and text to the Sketch as needed.

## Demo

The diagram below depicts the creation of a sketch template with the SVG metadata of an image integrated into the template.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-2bb91fa2e6c9329f963f6acf22e9595f664b5249%2FScreenshot%20from%202024-04-02%2023-14-32%20\(1\)%20\(1\).png?alt=media)

The screenshot below depicts the Sketcher Component with a sketch template.

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

The diagram below shows the SharinPix Sketcher with Sketch Template created above.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-18d3d2d4bb55088977ade2436be2ea116da3840a%2FScreenshot%20from%202024-04-10%2015-06-21%20\(1\)%20\(1\).png?alt=media)

The picture below shows sketches that has been annotated and saved in SharinPix Sketcher.

![](https://2221230591-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5EvYRrLbUyvRh8o1jmMG%2Fuploads%2Fgit-blob-729a12317ef06cc544bab4c0c7b98dbb52c8dae2%2FScreenshot%20from%202024-04-10%2016-03-45%20\(1\)%20\(1\).png?alt=media)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sharinpix.com/documentation/lightning-web-component/sharinpix-sketcher.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.