@azure/planetarycomputer package
الفصول
| PlanetaryComputerProClient |
الواجهات
النوع أسماء مستعارة
| BandMetadataElement |
نوع الاتحاد لعناصر بيانات التعريف في النطاق |
| ColorMapNames |
خرائط الألوان المتاحة لعرض البيانات القيم المعروفة التي تدعمها الخدمة
التأكيد: خريطة ألوان مميزة - خريطة ألوان نوعية بألوان مميزة |
| ContinuablePage |
واجهة تصف صفحة من النتائج. |
| DataCropCollectionFeatureByFormatResponse | |
| DataCropCollectionFeatureResponse | |
| DataCropCollectionFeatureWidthByHeightResponse | |
| DataCropFeatureByFormatResponse | |
| DataCropFeatureResponse | |
| DataCropFeatureWidthByHeightResponse | |
| DataCropSearchFeatureByFormatResponse | |
| DataCropSearchFeatureResponse | |
| DataCropSearchFeatureWidthByHeightResponse | |
| DataGetCollectionAssetsForBboxResponse | |
| DataGetCollectionAssetsForTileNoTmsResponse | |
| DataGetCollectionBboxCropResponse | |
| DataGetCollectionBboxCropWithDimensionsResponse | |
| DataGetCollectionTileByFormatResponse | |
| DataGetCollectionTileByScaleAndFormatResponse | |
| DataGetCollectionTileByScaleResponse | |
| DataGetCollectionTileNoTmsByFormatResponse | |
| DataGetCollectionTileNoTmsByScaleAndFormatResponse | |
| DataGetCollectionTileNoTmsByScaleResponse | |
| DataGetCollectionTileNoTmsResponse | |
| DataGetCollectionTileResponse | |
| DataGetCollectionWmtsCapabilitiesByTmsResponse | |
| DataGetCollectionWmtsCapabilitiesResponse | |
| DataGetIntervalLegendResponse | |
| DataGetItemAvailableAssetsResponse | |
| DataGetItemBboxCropResponse | |
| DataGetItemBboxCropWithDimensionsResponse | |
| DataGetItemPreviewResponse | |
| DataGetItemPreviewWithFormatResponse | |
| DataGetItemWmtsCapabilitiesByTmsResponse | |
| DataGetItemWmtsCapabilitiesResponse | |
| DataGetLegendResponse | |
| DataGetSearchAssetsForTileNoTmsResponse | |
| DataGetSearchBboxAssetsResponse | |
| DataGetSearchBboxCropResponse | |
| DataGetSearchBboxCropWithDimensionsResponse | |
| DataGetSearchTileByFormatResponse | |
| DataGetSearchTileByScaleAndFormatResponse | |
| DataGetSearchTileByScaleResponse | |
| DataGetSearchTileNoTmsByFormatResponse | |
| DataGetSearchTileNoTmsByScaleAndFormatResponse | |
| DataGetSearchTileNoTmsByScaleResponse | |
| DataGetSearchTileNoTmsResponse | |
| DataGetSearchTileResponse | |
| DataGetSearchWmtsCapabilitiesByTmsResponse | |
| DataGetSearchWmtsCapabilitiesResponse | |
| DataGetTileByFormatResponse | |
| DataGetTileByScaleAndFormatResponse | |
| DataGetTileByScaleResponse | |
| DataGetTileMatricesResponse | |
| DataGetTileNoTmsByFormatResponse | |
| DataGetTileNoTmsByScaleAndFormatResponse | |
| DataGetTileNoTmsByScaleResponse | |
| DataGetTileNoTmsResponse | |
| DataGetTileResponse | |
| FeatureType |
معرف النوع لكائنات ميزات GeoJSON القيم المعروفة التي تدعمها الخدمةالميزة: معرف نوع ميزة GeoJSON القياسي |
| FileContents |
قيم صالحة لمحتويات ملف ثنائي. |
| FilterLanguage |
خيارات لقيمة الفلاتر لانغ في طلب POST. استنادا إلى https://github.com/stac-api-extensions/filter#queryables لاحظ إضافة cql2-json، التي تستخدمها الخلفية pgstac لكنها غير مدرجة في المواصفة أعلاه. يحدد لغات التصفية المدعومة لاستعلامات واجهة برمجة التطبيقات الخاصة ب STAC. القيم المعروفة التي تدعمها الخدمة
cql-json: لغة استعلام مشتركة بصيغة JSON. |
| GeometryType |
يمثل نوع هندسة GeoJSON. القيم المعروفة التي تدعمها الخدمة
النقطة: تمثل هندسة نقطة. |
| GeometryUnion |
اسم مستعار ل GeometryUnion |
| IngestionSourceType |
نوع مصدر الاستهلاك القيم المعروفة التي تدعمها الخدمة
SasToken: مساحة تخزين Azure Blob SAS token |
| IngestionSourceUnion |
اسم مستعار ل IngestionSourceUnion |
| IngestionStatus |
حالة الابتلاع القيم المعروفة التي تدعمها الخدمة
جاهز: تم قبول البلع وجاهز للاستخدام |
| IngestionType |
نوع البلع القيم المعروفة التي تدعمها الخدمة
StaticCatalog: كتالوج STAC الثابت |
| LegendConfigType |
نوع الأسطورة لصنعه، واحد من: القيم المعروفة التي تدعمها الخدمة
مستمر: أسطورة منحدر الألوان المستمر. |
| MosaicMetadataType |
نوع مورد البيانات الوصفية في النظام القيم المعروفة التي تدعمها الخدمة
mosaic: بيانات وصفية لفسيفساء من عدة أصول نقطية |
| NoDataType |
NoDataType القيم المعروفة التي تدعمها الخدمة
ألفا: نوداتا ممثلة بقناة ألفا |
| NodeReadableStream |
اكتب اسم مستعار ل Node.js ReadableStream.
على أهداف العقدة، يتم حل هذا إلى نوع NodeJS.ReadableStream الفعلي.
في أهداف المتصفح/react-native يحل نسخة المنصة إلى |
| OperationStatus |
حالة التشغيل القيم المعروفة التي تدعمها الخدمة
قيد الانتظار: تم قبول العملية وجاهز للتشغيل |
| PartitionTypeScheme |
يحدد مخططات التقسيم لتنظيم البيانات الزمنية. القيم المعروفة التي تدعمها الخدمة
السنة: تقسيم البيانات حسب السنة. |
| PixelSelection |
المعرف الذي يختار أحد الأنظمة المدعومة من TileMatrixSetId (الافتراضي: 'WebMercatorQuad') يمثل الطريقة المستخدمة لاختيار أو حساب البكسلات عند إنشاء مركبات من مصادر متعددة القيم المعروفة التي تدعمها الخدمة
أولا: اختر البكسل من أول صورة متاحة |
| RenderOptionType |
يحدد أنواع خيارات العرض لعرض الخرائط. القيم المعروفة التي تدعمها الخدمة
بلاطة نقطية: نوع عرض بلاطة نقطية. |
| Resampling |
خوارزمية إعادة العينات المستخدمة عند قراءة بيانات النقطي المصدرية بدقة مختلفة القيم المعروفة التي تدعمها الخدمة
الأقرب: أقرب جار - أسرع طريقة تختار أقرب قيمة بكسل |
| SelMethod |
طريقة فهرسة Xarray للاستخدام في حالات التطابقات غير الدقيقة القيم المعروفة التي تدعمها الخدمة
الأقرب: طريقة أقرب جار |
| StacAssetUrlSigningMode |
تمثيل نوع التوقيع لعناوين URL للأصول. القيم المعروفة التي تدعمها الخدمة
صحيح: قم بتوقيع عناوين URL للأصول في الرد. |
| StacGetCollectionThumbnailResponse | |
| StacItemOrStacItemCollectionUnion |
اسم مستعار ل StacItemOrStacItemCollectionUnion |
| StacLinkType |
يكتب MIME للروابط. القيم المعروفة التي تدعمها الخدمة
image/tiff؛ التطبيق = geotiff: يمثل صورة/tiff مع application=geotiff. |
| StacModelType |
مميز Enum لأنواع عناصر ومجموعات STAC. القيم المعروفة التي تدعمها الخدمة
الميزة: نوع ميزة GeoJSON. |
| StacQueryableDefinitionDataType |
أنواع البيانات القابلة للاستعلام لامتداد Quryables.
هذه هي أنواع البيانات التي يدعمها Basic CQL2. القيم المعروفة التي تدعمها الخدمة
الوتر: سلاسل الحروف.
مثال: 'هذا خيط حرفي.' |
| StacSearchSortingDirection |
يحدد اتجاهات الفرز لنتائج الاستعلام في واجهة برمجة تطبيقات STAC. القيم المعروفة التي تدعمها الخدمة
ASC: الترتيب يؤدي إلى ترتيب تصاعدي. |
| TerrainAlgorithm |
خوارزميات مدعومة للتحليل القائم على التضاريس والمؤشرات القيم المعروفة التي تدعمها الخدمة
هيلشيد: ينشئ تصور تلال الظل من بيانات الارتفاع |
| TileAddressingScheme |
مخطط عنونة البلاط في مواصفة TileJSON القيم المعروفة التي تدعمها الخدمة
xyz: مخطط عنونة البلاط XYZ مع الأصل في الأعلى-اليسار |
| TileMatrixCornerOfOrigin |
زاوية مصفوفة البلاط (من الأعلىييسار أو الأسفلييس) تستخدم كمصدر لترقيم صفوف وأعمدة البلاط. هذه الزاوية هي أيضا زاوية من بلاطة (0, 0). القيم المعروفة التي تدعمها الخدمة
أعلى اليسار: الأصل في الزاوية العلوية اليسرى (Y تزداد للأسفل) |
| TileMatrixSetId |
المعرف الذي يختار أحد الأنظمة المدعومة من TileMatrixSetId (الافتراضي: 'WebMercatorQuad') معرف قياسي لنظام الإحداثيات المرجعي ومخطط التبليط المستخدم في تقديم بلاطات الخريطة القيم المعروفة التي تدعمها الخدمة
CanadianNAD83_LCC: مجموعة مصفوفة بلاطة الإسقاط المخروطي التوافقي NAD83 لامبرت الكندية |
| TilerImageFormat |
محدد تنسيق الصورة لطلبات البلاط والصور القيم المعروفة التي تدعمها الخدمة
png: تنسيق الرسومات الشبكية المحمولة - يدعم الشفافية |
| WarpKernelResampling |
خوارزمية إعادة أخذ عينات WarpKernel المستخدمة عند إعادة الإسقاط. تتغير افتراضيا إلى القيم المعروفة التي تدعمها الخدمة
الأقرب: أقرب جار |
التعدادات
| KnownColorMapNames |
خرائط الألوان المتاحة لعرض البيانات |
| KnownFeatureType |
معرف النوع لكائنات ميزات GeoJSON |
| KnownFilterLanguage |
خيارات لقيمة الفلاتر لانغ في طلب POST. استنادا إلى https://github.com/stac-api-extensions/filter#queryables لاحظ إضافة cql2-json، التي تستخدمها الخلفية pgstac لكنها غير مدرجة في المواصفة أعلاه. يحدد لغات التصفية المدعومة لاستعلامات واجهة برمجة التطبيقات الخاصة ب STAC. |
| KnownGeometryType |
يمثل نوع هندسة GeoJSON. |
| KnownIngestionSourceType |
نوع مصدر الاستهلاك |
| KnownIngestionStatus |
حالة الابتلاع |
| KnownIngestionType |
نوع الاستيعاب |
| KnownLegendConfigType |
نوع الأسطورة لصنعه، واحد من: |
| KnownMosaicMetadataType |
نوع مورد البيانات الوصفية في النظام |
| KnownNoDataType |
NoDataType |
| KnownOperationStatus |
حالة العملية |
| KnownPartitionTypeScheme |
يحدد مخططات التقسيم لتنظيم البيانات الزمنية. |
| KnownPixelSelection |
المعرف الذي يختار أحد الأنظمة المدعومة من TileMatrixSetId (الافتراضي: 'WebMercatorQuad') يمثل الطريقة المستخدمة لاختيار أو حساب البكسلات عند إنشاء مركبات من مصادر متعددة |
| KnownRenderOptionType |
يحدد أنواع خيارات العرض لعرض الخرائط. |
| KnownResampling |
خوارزمية إعادة العينات المستخدمة عند قراءة بيانات النقطي المصدرية بدقة مختلفة |
| KnownSelMethod |
طريقة فهرسة Xarray للاستخدام في حالات التطابقات غير الدقيقة |
| KnownStacAssetUrlSigningMode |
تمثيل نوع التوقيع لعناوين URL للأصول. |
| KnownStacLinkType |
يكتب MIME للروابط. |
| KnownStacModelType |
مميز Enum لأنواع عناصر ومجموعات STAC. |
| KnownStacQueryableDefinitionDataType |
أنواع البيانات القابلة للاستعلام لامتداد Quryables. هذه هي أنواع البيانات التي يدعمها Basic CQL2. |
| KnownStacSearchSortingDirection |
يحدد اتجاهات الفرز لنتائج الاستعلام في واجهة برمجة تطبيقات STAC. |
| KnownTerrainAlgorithm |
خوارزميات مدعومة للتحليل القائم على التضاريس والمؤشرات |
| KnownTileAddressingScheme |
مخطط عنونة البلاط في مواصفة TileJSON |
| KnownTileMatrixCornerOfOrigin |
زاوية مصفوفة البلاط (من الأعلىييسار أو الأسفلييس) تستخدم كمصدر لترقيم صفوف وأعمدة البلاط. هذه الزاوية هي أيضا زاوية من بلاطة (0, 0). |
| KnownTileMatrixSetId |
المعرف الذي يختار أحد الأنظمة المدعومة من TileMatrixSetId (الافتراضي: 'WebMercatorQuad') معرف قياسي لنظام الإحداثيات المرجعي ومخطط التبليط المستخدم في تقديم بلاطات الخريطة |
| KnownTilerImageFormat |
محدد تنسيق الصورة لطلبات البلاط والصور |
| KnownVersions |
يمثل معلومات الإصدار. |
| KnownWarpKernelResampling |
خوارزمية إعادة أخذ عينات WarpKernel المستخدمة عند إعادة الإسقاط. تتغير افتراضيا إلى |
الوظائف
| is |
Typeguard ل RestError |
| restore |
إنشاء استقصاء من الحالة المتسلسلة لأداة استقصاء أخرى. يمكن أن يكون هذا مفيدا عندما تريد إنشاء استقصاءات على مضيف مختلف أو يحتاج إلى إنشاء أداة استقصاء بعد أن لا تكون الأصلية في النطاق. |
المتغيرات
| Rest |
نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة. |
تفاصيل الوظيفة
isRestError(unknown)
Typeguard ل RestError
function isRestError(e: unknown): e
المعلمات
- e
-
unknown
شيء ما تم التقاطه بواسطة عبارة catch.
المرتجعات
e
restorePoller<TResponse, TResult>(PlanetaryComputerProClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
إنشاء استقصاء من الحالة المتسلسلة لأداة استقصاء أخرى. يمكن أن يكون هذا مفيدا عندما تريد إنشاء استقصاءات على مضيف مختلف أو يحتاج إلى إنشاء أداة استقصاء بعد أن لا تكون الأصلية في النطاق.
function restorePoller<TResponse, TResult>(client: PlanetaryComputerProClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
المعلمات
- client
- PlanetaryComputerProClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
المرتجعات
PollerLike<OperationState<TResult>, TResult>
تفاصيل المُتغيّر
RestError
نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.
RestError: RestErrorConstructor