> For the complete documentation index, see [llms.txt](https://developers.felt.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.felt.com/js-sdk-api-reference/elements/linkelementread.md).

# LinkElementRead

***

## Properties

### id

> **id**: `string`

The unique identifier for the element.

***

### groupId

> **groupId**: `null` | `string`

The ID of the element group that the element belongs to.\
For elements that are not part of a group, this will be null.

***

### color

> **color**: `string`

The color of the element in some CSS-like format.

#### Example

```typescript
"#ABC123";
"rgb(255, 0, 0)";
"hsl(200, 100%, 50%)";
```

#### Default

```ts
"#C93535"
```

***

### name

> **name**: `null` | `string`

The element's name. For elements that can show a label or text on\
the map (e.g. a Place or Text element) this is the text that will be shown.

For elements such as Polygons or Paths, the name is what is shown when\
the element is selected by clicking on it.

***

### description

> **description**: `null` | `string`

Text describing the element, which is shown in an element's popup when it\
is selected.

Note that some elements are not selectable on the map, such as Notes, Text\
and Markers, so their description will not be shown.

***

### attributes

> **attributes**: `Record`<`string`, `unknown`>

A set of key-value pairs that can be used to store arbitrary data about the element.

This is most useful for associating additional data with an element that is not\
part of the element's core data, such as a Place's address or some other\
data.

***

### type

> **type**: `"Link"`

***

### url

> **url**: `string`

The URL of the link that is rendered in this element.

***

### interaction?

> `optional` **interaction**: `"default"` | `"locked"`

Whether the element is interactive.

The `default` interaction mode means that the element can be selected and edited by\
the user, if it was created by the SDK or by the user using a tool.

If the interaction mode is `locked`, the element will not be editable by the user,\
which is often used for elements that you don't want the user to edit or move by\
accident.

Elements that were created by the map author (i.e. not during an SDK "session") are\
not editable and have special behaviour depending on their name, description and\
attributes.

#### Default

```ts
"default"
```


---

# 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://developers.felt.com/js-sdk-api-reference/elements/linkelementread.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.