arrow-left
All pages
gitbookPowered by GitBook
1 of 17

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

FeltBoundary


FeltBoundary: [number, number, number, number]

The edges of the map in the form of a bounding box.

The boundary is a tuple of the form [west, south, east, north].

Shared


These are generic types that are used across multiple modules.

hashtag
Other

  • LatLng

hashtag
Visibility

GeoJsonFeature
PointGeometry
MultiPointGeometry
PolygonGeometry
MultiPolygonGeometry
LineStringGeometry
MultiLineStringGeometry
SortConfig
LngLatTuple
GeoJsonProperties
GeoJsonGeometry
FeltZoom
FeltBoundary
SortDirection
SetVisibilityRequest

SortDirection


SortDirection: "asc" | "desc"

Specifies the direction to sort data in

GeoJsonFeature


A GeoJSON feature object, compliant with:https://datatracker.ietf.org/doc/html/rfc7946#section-3.2arrow-up-right

hashtag
Properties

hashtag
type

type: "Feature"


hashtag
geometry

geometry:

The feature's geometry


hashtag
properties

properties:

Properties associated with this feature.


hashtag
bbox?

optional bbox: [number, number, number, number]

The bounding box of the feature in [west, south, east, north] order.


hashtag
id?

optional id: string | number

A value that uniquely identifies this feature in a.

GeoJsonGeometry
GeoJsonProperties
https://tools.ietf.org/html/rfc7946#section-3.2arrow-up-right

SortConfig


Configuration for sorting data by a specific attribute

hashtag
Properties

hashtag
direction

direction: "asc" | "desc"

The direction to sort in


hashtag
attribute

attribute: string

The attribute to sort by. What this represents depends on the context. For instance, when sorting features in a data table, the attribute is the column to sort by.

FeltZoom


FeltZoom: number

The zoom level of the map.

It is a floating-point number between 1 and 23, where 1 is the most zoomed out and 23 is the most zoomed in.

GeoJsonGeometry


GeoJsonGeometry: PointGeometry | PolygonGeometry | LineStringGeometry | MultiLineStringGeometry | MultiPolygonGeometry | MultiPointGeometry

A GeoJSON geometry of any type

LatLng


Represents a point in world coordinates.

hashtag
Properties

hashtag
latitude

latitude: number


hashtag
longitude

longitude: number

GeoJsonProperties


GeoJsonProperties: Record<string, unknown>

A GeoJSON properties object.

LngLatTuple


LngLatTuple: [number, number]

A tuple representing a longitude and latitude coordinate.

This is used hen serializing geometry because that's the standard used in GeoJSON.

SetVisibilityRequest


The parameters for the methods that change the visibility of entities.

hashtag
Properties

hashtag

PolygonGeometry


hashtag
Properties

hashtag
type

MultiLineStringGeometry


A GeoJSON multi-line string geometry.

hashtag
Properties

hashtag
type

show?

optional show: string[]

The ids of the entities you want to change the visibility of.


hashtag
hide?

optional hide: string[]

type: "Polygon"

hashtag
coordinates

coordinates: [number, number][][]

The coordinates of a polygon. The first array is the exterior ring, and any subsequent arrays are the interior rings.

Each ring must have at least 4 points: 3 to make a valid triangle and the last to close the path, which must be identical to the first.

type: "MultiLineString"


hashtag
coordinates

coordinates: LngLatTuple[][]

LineStringGeometry


A GeoJSON line string geometry.

hashtag
Properties

hashtag
type

type: "LineString"


hashtag
coordinates

coordinates: []

MultiPolygonGeometry


A GeoJSON multi-polygon geometry.

hashtag
Properties

hashtag
type

type: "MultiPolygon"


hashtag
coordinates

coordinates: [number, number][][][]

LngLatTuple

PointGeometry


hashtag
Properties

hashtag
type

type: "Point"


hashtag
coordinates

coordinates:

LngLatTuple

MultiPointGeometry


A GeoJSON multi-point geometry.

hashtag
Remarks

You shouldn't expect this to come from Felt - it is here for completeness of the GeoJSON spec.

hashtag
Properties

hashtag
type

type: "MultiPoint"


hashtag
coordinates

coordinates: []

LngLatTuple