# TextElementCreate

***

## Properties

### type

> **type**: `"Text"`

***

### text

> **text**: `string`

***

### groupId?

> `optional` **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?

> `optional` **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"
```

***

### description?

> `optional` **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?

> `optional` **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.

***

### 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"
```

***

### rotation?

> `optional` **rotation**: `number`

The rotation of the element in degrees.

#### Default

```ts
0
```

***

### scale?

> `optional` **scale**: `number`

The relative scale of the element from the default size. This is combined with the `zoom` to determine the actual size of the element.

#### Default

```ts
1
```

***

### zoom?

> `optional` **zoom**: `number`

The zoom level at which the element was created. This is combined with the `scale` to determine the actual size of the element.

When creating an element, if you don't supply this value it defaults to the current zoom of the map when you call `createElement`.

***

### align?

> `optional` **align**: `"center"` | `"left"` | `"right"`

The alignment of the text, either `left`, `center` or `right`.

#### Default

```ts
"center"
```

***

### style?

> `optional` **style**: `"light"` | `"italic"` | `"regular"` | `"caps"`

The style of the text, either `italic`, `light`, `regular` or `caps`.

#### Default

```ts
"regular"
```

***

### position?

> `optional` **position**: [`LngLatTuple`](/js-sdk-api-reference/shared/lnglattuple.md)

The geographical position of the center of the text element.

If this is omitted, the text will be placed at the center of the current viewport.


---

# Agent Instructions: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.felt.com/js-sdk-api-reference/elements/textelementcreate.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.