Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -424,12 +424,12 @@

"ae-unresolved-link": {
"logLevel": "none"
}
},

// "ae-extra-release-tag": {
// "logLevel": "warning",
// "addToApiReportFile": true
// },
"ae-missing-release-tag": {
"logLevel": "none",
"addToApiReportFile": false
}
//
// . . .
},
Expand Down
63 changes: 63 additions & 0 deletions docs/Elements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
***

The Felt SDK lets you read, create and update elements on the map.

Elements that are created via the SDK are only available to the current
session - they are not persisted to the map and not available to other users
of the map.

> If you want to let your users create elements (as opposed to using the SDK to
> create them programmatically), you can use the [ToolsController](Tools/ToolsController.md) to
> select and configure the drawing tools in Felt.

# Controller

* [ElementsController](Elements/ElementsController.md)

# Interfaces

* [PlaceElementCreate](Elements/PlaceElementCreate.md)
* [PathElementCreate](Elements/PathElementCreate.md)
* [PolygonElementCreate](Elements/PolygonElementCreate.md)
* [CircleElementCreate](Elements/CircleElementCreate.md)
* [MarkerElementCreate](Elements/MarkerElementCreate.md)
* [HighlighterElementCreate](Elements/HighlighterElementCreate.md)
* [TextElementCreate](Elements/TextElementCreate.md)
* [NoteElementCreate](Elements/NoteElementCreate.md)
* [ImageElementCreate](Elements/ImageElementCreate.md)
* [PlaceElementRead](Elements/PlaceElementRead.md)
* [PathElementRead](Elements/PathElementRead.md)
* [PolygonElementRead](Elements/PolygonElementRead.md)
* [CircleElementRead](Elements/CircleElementRead.md)
* [MarkerElementRead](Elements/MarkerElementRead.md)
* [HighlighterElementRead](Elements/HighlighterElementRead.md)
* [TextElementRead](Elements/TextElementRead.md)
* [NoteElementRead](Elements/NoteElementRead.md)
* [ImageElementRead](Elements/ImageElementRead.md)
* [LinkElementRead](Elements/LinkElementRead.md)
* [PlaceElementUpdate](Elements/PlaceElementUpdate.md)
* [PathElementUpdate](Elements/PathElementUpdate.md)
* [PolygonElementUpdate](Elements/PolygonElementUpdate.md)
* [CircleElementUpdate](Elements/CircleElementUpdate.md)
* [MarkerElementUpdate](Elements/MarkerElementUpdate.md)
* [HighlighterElementUpdate](Elements/HighlighterElementUpdate.md)
* [TextElementUpdate](Elements/TextElementUpdate.md)
* [NoteElementUpdate](Elements/NoteElementUpdate.md)
* [ImageElementUpdate](Elements/ImageElementUpdate.md)

# Type Aliases

* [ElementCreate](Elements/ElementCreate.md)
* [ElementUpdate](Elements/ElementUpdate.md)

# Element Groups

* [ElementGroup](Elements/ElementGroup.md)
* [GetElementGroupsConstraint](Elements/GetElementGroupsConstraint.md)
* [ElementGroupChangeCallbackParams](Elements/ElementGroupChangeCallbackParams.md)

# Elements

* [GetElementsConstraint](Elements/GetElementsConstraint.md)
* [ElementChangeCallbackParams](Elements/ElementChangeCallbackParams.md)
* [Element](Elements/Element.md)
2 changes: 1 addition & 1 deletion docs/Elements/CircleElementCreate.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ and Markers, so their description will not be shown.

## attributes?

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/Elements/CircleElementRead.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ and Markers, so their description will not be shown.

## attributes

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/Elements/CircleElementUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ and Markers, so their description will not be shown.

## attributes?

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/Elements/Element.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
***

> **Element**: [`PlaceElementRead`](PlaceElementRead.md) | [`PathElementRead`](PathElementRead.md) | [`PolygonElementRead`](PolygonElementRead.md) | [`CircleElementRead`](CircleElementRead.md) | [`MarkerElementRead`](MarkerElementRead.md) | [`HighlighterElementRead`](HighlighterElementRead.md) | [`TextElementRead`](TextElementRead.md) | [`NoteElementRead`](NoteElementRead.md) | [`ImageElementRead`](ImageElementRead.md) | [`LinkElementRead`](LinkElementRead.md)
> **Element** = [`PlaceElementRead`](PlaceElementRead.md) | [`PathElementRead`](PathElementRead.md) | [`PolygonElementRead`](PolygonElementRead.md) | [`CircleElementRead`](CircleElementRead.md) | [`MarkerElementRead`](MarkerElementRead.md) | [`HighlighterElementRead`](HighlighterElementRead.md) | [`TextElementRead`](TextElementRead.md) | [`NoteElementRead`](NoteElementRead.md) | [`ImageElementRead`](ImageElementRead.md) | [`LinkElementRead`](LinkElementRead.md)
2 changes: 1 addition & 1 deletion docs/Elements/ElementCreate.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
***

> **ElementCreate**: [`PlaceElementCreate`](PlaceElementCreate.md) | [`PathElementCreate`](PathElementCreate.md) | [`PolygonElementCreate`](PolygonElementCreate.md) | [`CircleElementCreate`](CircleElementCreate.md) | [`MarkerElementCreate`](MarkerElementCreate.md) | [`HighlighterElementCreate`](HighlighterElementCreate.md) | [`ImageElementCreate`](ImageElementCreate.md) | [`TextElementCreate`](TextElementCreate.md) | [`NoteElementCreate`](NoteElementCreate.md)
> **ElementCreate** = [`PlaceElementCreate`](PlaceElementCreate.md) | [`PathElementCreate`](PathElementCreate.md) | [`PolygonElementCreate`](PolygonElementCreate.md) | [`CircleElementCreate`](CircleElementCreate.md) | [`MarkerElementCreate`](MarkerElementCreate.md) | [`HighlighterElementCreate`](HighlighterElementCreate.md) | [`ImageElementCreate`](ImageElementCreate.md) | [`TextElementCreate`](TextElementCreate.md) | [`NoteElementCreate`](NoteElementCreate.md)
2 changes: 1 addition & 1 deletion docs/Elements/ElementUpdate.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
***

> **ElementUpdate**: [`PlaceElementUpdate`](PlaceElementUpdate.md) | [`PathElementUpdate`](PathElementUpdate.md) | [`PolygonElementUpdate`](PolygonElementUpdate.md) | [`CircleElementUpdate`](CircleElementUpdate.md) | [`MarkerElementUpdate`](MarkerElementUpdate.md) | [`HighlighterElementUpdate`](HighlighterElementUpdate.md) | [`TextElementUpdate`](TextElementUpdate.md) | [`NoteElementUpdate`](NoteElementUpdate.md) | [`ImageElementUpdate`](ImageElementUpdate.md)
> **ElementUpdate** = [`PlaceElementUpdate`](PlaceElementUpdate.md) | [`PathElementUpdate`](PathElementUpdate.md) | [`PolygonElementUpdate`](PolygonElementUpdate.md) | [`CircleElementUpdate`](CircleElementUpdate.md) | [`MarkerElementUpdate`](MarkerElementUpdate.md) | [`HighlighterElementUpdate`](HighlighterElementUpdate.md) | [`TextElementUpdate`](TextElementUpdate.md) | [`NoteElementUpdate`](NoteElementUpdate.md) | [`ImageElementUpdate`](ImageElementUpdate.md)
Loading
Loading