DataSource class
En datakälla som gör det enkelt att hantera former som visas på kartan. En datakälla måste läggas till i ett lager innan den visas på kartan. Klassen DataSource kan användas med SymbolLayer, LineLayer, PolygonLayer, BubbleLayer och HeatMapLayer.
- Extends
Konstruktorer
Data |
En datakälla som gör det enkelt att hantera former som visas på kartan.
En datakälla måste läggas till i ett lager innan den visas på kartan.
Klassen |
Metoder
add(Feature |
Lägger till former i datakällan. GeoJSON-objekt kommer att omslutas i en Shape-klass för att göra dem enklare att hantera. Du kan också ange ett index för att infoga funktionen mellan andra former/funktioner i lagren. |
clear() | Tar bort alla data i datakällan. |
dispose() | Rensar alla resurser som objektet förbrukar. |
get |
Hämtar underordnade till det angivna klustret på nästa zoomnivå. Detta kan vara en kombination av former och underkluster. Underklustren är funktioner med egenskaper som matchar ClusteredProperties. |
get |
Beräknar en zoomnivå där klustret börjar expandera eller brytas isär. |
get |
Hämtar former som finns i klustret. |
get |
Hämtar de alternativ som används av datakällan. |
get |
Hämtar en form med det angivna ID:t. Om ingen form med det angivna ID:t finns i datakällan returneras null. |
get |
Returnerar alla former som finns i DataSource. |
import |
Laddar ned ett GeoJSON-dokument och importerar dess data till datakällan. GeoJSON-dokumentet måste finnas på samma domän eller vara tillgängligt med CORS. |
remove(number | string | Shape | Feature<atlas. |
Tar bort en eller flera former från datakällan. Om en sträng skickas in antas det vara ett ID. Om ett tal skickas tar bort formen vid indexet. |
remove |
Tar bort en eller flera former från datakällan baserat på dess ID. |
set |
Anger alternativen för datakällan. Datakällan behåller sina aktuella värden för alla alternativ som inte anges i de angivna alternativen. |
set |
Skriver över alla former i datakällan med den nya matrisen med former. |
to |
Returnerar en GeoJSON FeatureCollection som innehåller alla formdata som finns i datakällan. |
Ärvda metoder
get |
Hämtar ID:t för datakällan |
Konstruktorinformation
DataSource(string, DataSourceOptions)
En datakälla som gör det enkelt att hantera former som visas på kartan.
En datakälla måste läggas till i ett lager innan den visas på kartan.
Klassen DataSource
kan användas med SymbolLayer
, LineLayer
, PolygonLayer
, BubbleLayer
och HeatMapLayer
.
new DataSource(id?: string, options?: DataSourceOptions)
Parametrar
- id
-
string
ett unikt ID som användaren tilldelar till datakällan. Om detta inte anges tilldelas datakällan automatiskt ett ID.
- options
- DataSourceOptions
alternativen för datakällan.
Metodinformation
add(FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, number)
Lägger till former i datakällan. GeoJSON-objekt kommer att omslutas i en Shape-klass för att göra dem enklare att hantera. Du kan också ange ett index för att infoga funktionen mellan andra former/funktioner i lagren.
function add(data: FeatureCollection | Feature<atlas.data.Geometry, any> | atlas.data.Geometry | GeometryCollection | Shape | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>, index?: number)
Parametrar
- data
-
FeatureCollection | Feature<Geometry, any> | Geometry | GeometryCollection | Shape | Array<Feature<Geometry, any> | Geometry | Shape>
- index
-
number
clear()
Tar bort alla data i datakällan.
function clear()
dispose()
Rensar alla resurser som objektet förbrukar.
function dispose()
getClusterChildren(number)
Hämtar underordnade till det angivna klustret på nästa zoomnivå. Detta kan vara en kombination av former och underkluster. Underklustren är funktioner med egenskaper som matchar ClusteredProperties.
function getClusterChildren(clusterId: number): Promise<Array<Feature<atlas.data.Geometry, ClusteredProperties | any> | Shape>>
Parametrar
- clusterId
-
number
Returer
Promise<Array<Feature<Geometry, ClusteredProperties | any> | Shape>>
getClusterExpansionZoom(number)
Beräknar en zoomnivå där klustret börjar expandera eller brytas isär.
function getClusterExpansionZoom(clusterId: number): Promise<number>
Parametrar
- clusterId
-
number
Returer
Promise<number>
getClusterLeaves(number, number, number)
Hämtar former som finns i klustret.
function getClusterLeaves(clusterId: number, limit: number, offset: number): Promise<Array<Feature<atlas.data.Geometry, any> | Shape>>
Parametrar
- clusterId
-
number
- limit
-
number
Det maximala antalet funktioner som ska returneras. Ställ in på Oändlighet för att returnera alla former.
- offset
-
number
Antalet former som ska hoppa över. Gör att du kan bläddra igenom formerna i klustret.
Returer
getOptions()
Hämtar de alternativ som används av datakällan.
function getOptions(): DataSourceOptions
Returer
getShapeById(string | number)
Hämtar en form med det angivna ID:t. Om ingen form med det angivna ID:t finns i datakällan returneras null.
function getShapeById(id: string | number): Shape
Parametrar
- id
-
string | number
Formens ID som ska returneras.
Returer
getShapes()
importDataFromUrl(string)
Laddar ned ett GeoJSON-dokument och importerar dess data till datakällan. GeoJSON-dokumentet måste finnas på samma domän eller vara tillgängligt med CORS.
function importDataFromUrl(url: string): Promise<void>
Parametrar
- url
-
string
Returer
Promise<void>
remove(number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)
Tar bort en eller flera former från datakällan. Om en sträng skickas in antas det vara ett ID. Om ett tal skickas tar bort formen vid indexet.
function remove(shape: number | string | Shape | Feature<atlas.data.Geometry, any> | Array<number | string | Shape | Feature<atlas.data.Geometry, any>>)
Parametrar
removeById(number | string | Array<number | string>)
Tar bort en eller flera former från datakällan baserat på dess ID.
function removeById(id: number | string | Array<number | string>)
Parametrar
- id
-
number | string | Array<number | string>
setOptions(DataSourceOptions)
Anger alternativen för datakällan. Datakällan behåller sina aktuella värden för alla alternativ som inte anges i de angivna alternativen.
function setOptions(options: DataSourceOptions)
Parametrar
- options
- DataSourceOptions
DataSourceOptions som ska anges
setShapes(FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)
Skriver över alla former i datakällan med den nya matrisen med former.
function setShapes(shape: FeatureCollection | Array<Feature<atlas.data.Geometry, any> | atlas.data.Geometry | Shape>)
Parametrar
- shape
-
FeatureCollection | Array<Feature<Geometry, any> | Geometry | Shape>
de nya former som ska uppdateras
toJson()
Returnerar en GeoJSON FeatureCollection som innehåller alla formdata som finns i datakällan.
function toJson(): FeatureCollection