import * as parquetUtils from "@arcgis/core/layers/support/parquetUtils.js";
const parquetUtils = await $arcgis.import("@arcgis/core/layers/support/parquetUtils.js");
@arcgis/core/layers/support/parquetUtils
Provides utility functions for the ParquetLayer.
- See also
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
Promise<ParquetLayerInfo> | Retrieves information about a ParquetLayer from the first parquet file in the specified URLs array. | parquetUtils |
Method Details
-
getParquetLayerInfo
MethodgetParquetLayerInfo(urls, options){Promise<ParquetLayerInfo>} -
Retrieves information about a ParquetLayer from the first parquet file in the specified URLs array. Throws an error if the parquet file is empty or if the information cannot be determined.
ParametersSpecificationAn array of URLs pointing to parquet files. At least one url must be provided.
options ObjectoptionalAn object specifying additional options. See the object specification table below for the properties of this object.
SpecificationcustomParameters ObjectoptionalA list of key-value pairs of parameters to append to the url.
signal AbortSignal|null|undefinedoptionalAn AbortSignal to abort the executions of the remote method. If canceled, the promise will be rejected with an error named
AbortError. See also AbortController.ReturnsType Description Promise<ParquetLayerInfo> A promise that resolves to the parquet layer information. Exampleconst urls = ["url-to-your-parquet-file.parquet"]; const info = await parquetUtils.getParquetLayerInfo(urls); // create new parquet layer using the retrieved info const layer = new ParquetLayer(info);
Type Definitions
-
Contains an information inferred from the parquet files.
- Properties
-
urls Collection<string>
A collection of URLs pointing to the parquet files.
optional The fields derived from the parquet files.
optional The encoding format used to store geometries in the parquet files.
optionalgeometryType StringThe geometry type of the features in the layer.
Possible Values:"point"|"polygon"|"polyline"|"multipoint"
optionalobjectIdField StringThe name of the objectId field.
optionalspatialReference SpatialReferenceThe spatial reference of the layer.
- See also