@vertigis/arcgis-extensions 48.9.1 → 49.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AppConfig.schema.json +63 -47
- package/data/Feature.d.ts +4 -4
- package/data/Feature.js +1 -1
- package/data/_TableExtension.d.ts +1 -1
- package/data/support/attachments.js +1 -1
- package/declarations/arcgis-js-api-extensions/index.d.ts +4 -6
- package/docs/html/assets/navigation.js +1 -1
- package/docs/html/assets/search.js +1 -1
- package/docs/html/classes/Entity.EntityBase.html +3 -3
- package/docs/html/classes/data_ArcGISServiceTableExtension.ArcGISServiceTableExtension.html +3 -3
- package/docs/html/classes/data_Attachment.Attachment.html +3 -3
- package/docs/html/classes/data_Feature.Feature.html +5 -5
- package/docs/html/classes/data_FeatureList.FeatureList.html +3 -9
- package/docs/html/classes/data_FeatureSet.FeatureSet.html +0 -1
- package/docs/html/classes/data_FeatureSourceBase.FeatureSourceBase.html +3 -3
- package/docs/html/classes/data_FeatureSourceBase.RelationshipCollection.html +3 -9
- package/docs/html/classes/data_FeatureStream.FeatureStream.html +3 -3
- package/docs/html/classes/data_FieldExtension.FieldExtension.html +3 -3
- package/docs/html/classes/data_PopupContentExtension.PopupContentExtension.html +3 -3
- package/docs/html/classes/data_RelationshipBase.RelationshipBase.html +3 -3
- package/docs/html/classes/data__TableExtension.TableExtension.html +3 -3
- package/docs/html/classes/data__TableExtension.TableSchema.html +2 -2
- package/docs/html/classes/layer_preset_LayerPreset.LayerPreset.html +3 -3
- package/docs/html/classes/mapping_ArcGISSublayerExtension.ArcGISSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_ArcGISSublayerExtension.ArcGISSublayerRelationshipCollection.html +3 -9
- package/docs/html/classes/mapping_BasemapExtension.BasemapExtension.html +3 -3
- package/docs/html/classes/mapping_Bookmark.Bookmark.html +3 -3
- package/docs/html/classes/mapping_BuildingComponentSublayerExtension.BuildingComponentSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_BuildingGroupSublayerExtension.BuildingGroupSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_BuildingSceneLayerExtension.BuildingSceneLayerExtension.html +3 -3
- package/docs/html/classes/mapping_BuildingSublayerExtension.BuildingSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_CSVLayerExtension.CSVLayerExtension.html +5 -5
- package/docs/html/classes/mapping_ElevationLayerExtension.ElevationLayerExtension.html +3 -3
- package/docs/html/classes/mapping_FeatureCollectionLayerExtension.FeatureCollectionLayerExtension.html +3 -3
- package/docs/html/classes/mapping_FeatureLayerExtension.FeatureLayerExtension.html +5 -5
- package/docs/html/classes/mapping_FeatureLayerExtensionBase.FeatureLayerExtensionBase.html +3 -3
- package/docs/html/classes/mapping_GeoJSONLayerExtension.GeoJSONLayerExtension.html +5 -5
- package/docs/html/classes/mapping_GeoRSSLayerExtension.GeoRSSLayerExtension.html +3 -3
- package/docs/html/classes/mapping_GraphicsLayerExtension.GraphicsLayerExtension.html +3 -3
- package/docs/html/classes/mapping_GroundExtension.GroundExtension.html +3 -3
- package/docs/html/classes/mapping_GroupLayerExtension.GroupLayerExtension.html +3 -3
- package/docs/html/classes/mapping_GroupLayerExtension.GroupLayerExtensionCollection.html +7 -11
- package/docs/html/classes/mapping_ImageryLayerExtension.ImageryLayerExtension.html +3 -3
- package/docs/html/classes/mapping_ImageryTileLayerExtension.ImageryTileLayerExtension.html +3 -3
- package/docs/html/classes/mapping_IntegratedMeshLayerExtension.IntegratedMeshLayerExtension.html +3 -3
- package/docs/html/classes/mapping_KMLLayerExtension.KMLLayerExtension.html +3 -3
- package/docs/html/classes/mapping_KMLSublayerExtension.KMLSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_MapExtension.MapExtension.html +3 -3
- package/docs/html/classes/mapping_MapImageLayerExtension.MapImageLayerExtension.html +3 -3
- package/docs/html/classes/mapping_MapImageSublayerExtension.MapImageSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_MapNotesLayerExtension.MapNotesLayerExtension.html +3 -3
- package/docs/html/classes/mapping_MapNotesSublayerExtension.MapNotesSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_OpenStreetMapLayerExtension.OpenStreetMapLayerExtension.html +3 -3
- package/docs/html/classes/mapping_PointCloudLayerExtension.PointCloudLayerExtension.html +3 -3
- package/docs/html/classes/mapping_RouteLayerExtension.RouteLayerExtension.html +3 -3
- package/docs/html/classes/mapping_SceneLayerExtension.SceneLayerExtension.html +3 -3
- package/docs/html/classes/mapping_StreamLayerExtension.StreamLayerExtension.html +3 -3
- package/docs/html/classes/mapping_SubtypeGroupLayerExtension.SubtypeGroupLayerExtension.html +3 -3
- package/docs/html/classes/mapping_SubtypeGroupLayerExtension.SubtypeGroupLayerRelationshipCollection.html +3 -9
- package/docs/html/classes/mapping_SubtypeSublayerExtension.SubtypeSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_SubtypeSublayerExtension.SubtypeSublayerRelationshipCollection.html +3 -9
- package/docs/html/classes/mapping_TileLayerExtension.TileLayerExtension.html +3 -3
- package/docs/html/classes/mapping_TileSublayerExtension.TileSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_UnsupportedLayerExtension.UnsupportedLayerExtension.html +3 -3
- package/docs/html/classes/mapping_VectorTileLayerExtension.VectorTileLayerExtension.html +3 -3
- package/docs/html/classes/mapping_WFSLayerExtension.WFSLayerExtension.html +3 -3
- package/docs/html/classes/mapping_WMSLayerExtension.WMSLayerExtension.html +3 -3
- package/docs/html/classes/mapping_WMSSublayerExtension.WMSSublayerExtension.html +3 -3
- package/docs/html/classes/mapping_WMTSLayerExtension.WMTSLayerExtension.html +3 -3
- package/docs/html/classes/mapping_WebTileLayerExtension.WebTileLayerExtension.html +3 -3
- package/docs/html/classes/mapping__LayerExtension.LayerExtension.html +3 -3
- package/docs/html/classes/mapping__LayerExtensionCollectionImpl.LayerExtensionCollectionImpl.html +7 -11
- package/docs/html/classes/mapping__SublayerExtension.SubSublayerExtensionCollection.html +7 -11
- package/docs/html/classes/mapping__SublayerExtension.SublayerExtension.html +3 -3
- package/docs/html/classes/mapping_support_ArrayWrappedCollection.ArrayWrappedCollection.html +3 -9
- package/docs/html/classes/mapping_support__LayerExtensionCollection.LayerExtensionCollectionBase.html +7 -11
- package/docs/html/classes/mapping_support__SublayerExtensionCollection.SublayerExtensionCollectionBase.html +7 -11
- package/docs/html/classes/menus_Menu.Menu.html +3 -3
- package/docs/html/classes/menus_MenuItem.MenuItem.html +3 -3
- package/docs/html/classes/support_InitializableBase.InitializableBase.html +3 -3
- package/docs/html/classes/support_InitializableCollectionProxy.InitializableCollectionProxy.html +3 -9
- package/docs/html/classes/support_ReadOnlyInitializableCollection.ReadOnlyInitializableCollection.html +3 -9
- package/docs/html/classes/support__ArcGISRelationshipCollection.ArcGISRelationshipCollection.html +3 -9
- package/docs/html/classes/tasks_geocoding_ArcGISGeocoder.ArcGISGeocoder.html +3 -3
- package/docs/html/classes/tasks_geocoding_Geocoder.Geocoder.html +3 -3
- package/docs/html/classes/tasks_identify_ArcGISSublayerQueryIdentifyProvider.ArcGISSublayerQueryIdentifyProvider.html +6 -6
- package/docs/html/classes/tasks_identify_BuildingComponentSublayerClientSideIdentifyProvider.BuildingComponentSublayerClientSideIdentifyProvider.html +6 -6
- package/docs/html/classes/tasks_identify_BuildingComponentSublayerHitTestIdentifyProvider.BuildingComponentSublayerHitTestIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_CSVLayer3DHitTestIdentifyProvider.CSVLayer3DHitTestIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_CSVLayerClientSideQueryIdentifyProvider.CSVLayerClientSideQueryIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_ClientSideIdentifyProvider.ClientSideIdentifyProvider.html +8 -8
- package/docs/html/classes/tasks_identify_FeatureLayer3DHitTestIdentifyProvider.FeatureLayer3DHitTestIdentifyProvider.html +10 -10
- package/docs/html/classes/tasks_identify_FeatureLayerClientSideIdentifyProvider.FeatureLayerClientSideIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_FeatureLayerQueryIdentifyProvider.FeatureLayerQueryIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_GeoJSONLayer3DHitTestIdentifyProvider.GeoJSONLayer3DHitTestIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_GeoJSONLayerClientSideQueryIdentifyProvider.GeoJSONLayerClientSideQueryIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_GeoRSSLayerIdentifyProvider.GeoRSSLayerIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_GraphicsLayerQueryIdentifyProvider.GraphicsLayerQueryIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_HitTestIdentifyProvider.HitTestIdentifyProvider.html +10 -10
- package/docs/html/classes/tasks_identify_IdentifyProviderBase.IdentifyProviderBase.html +9 -9
- package/docs/html/classes/tasks_identify_IdentifyService.IdentifyService.html +10 -10
- package/docs/html/classes/tasks_identify_ImageryLayerIdentifyProvider.ImageryLayerIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_KMLLayerQueryIdentifyProvider.KMLLayerQueryIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_MapNotesSublayerQueryIdentifyProvider.MapNotesSublayerQueryIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_PointCloudLayerHitTestIdentifyProvider.PointCloudLayerHitTestIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_RouteLayerQueryIdentifyProvider.RouteLayerQueryIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_SceneLayerClientSideIdentifyProvider.SceneLayerClientSideIdentifyProvider.html +6 -6
- package/docs/html/classes/tasks_identify_SceneLayerHitTestIdentifyProvider.SceneLayerHitTestIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_SceneLayerQueryIdentifyProvider.SceneLayerQueryIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_StreamLayerClientSideQueryIdentifyProvider.StreamLayerClientSideQueryIdentifyProvider.html +6 -6
- package/docs/html/classes/tasks_identify_SubtypeSublayerClientSideIdentifyProvider.SubtypeSublayerClientSideIdentifyProvider.html +6 -6
- package/docs/html/classes/tasks_identify_SubtypeSublayerQueryIdentifyProvider.SubtypeSublayerQueryIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_WFSLayerClientSideIdentifyProvider.WFSLayerClientSideIdentifyProvider.html +7 -7
- package/docs/html/classes/tasks_identify_WFSLayerQueryIdentifyProvider.WFSLayerQueryIdentifyProvider.html +6 -6
- package/docs/html/classes/tasks_identify_WMSLayerFeatureInfoIdentifyProvider.WMSLayerFeatureInfoIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_identify_WMSSublayerIdentifyProvider.WMSSublayerIdentifyProvider.html +9 -9
- package/docs/html/classes/tasks_query_ArcGISRelationship.ArcGISRelationship.html +3 -3
- package/docs/html/classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html +3 -3
- package/docs/html/classes/tasks_query_QueryService.QueryService.html +3 -3
- package/docs/html/classes/tasks_search_SearchService.SearchService.html +3 -3
- package/docs/html/classes/utilities_CaseInsensitiveObservableMap.CaseInsensitiveObservableMap.html +0 -1
- package/docs/html/classes/utilities_CollectionProxy.CollectionProxy.html +3 -9
- package/docs/html/classes/utilities_CopyOnWriteCollection.CopyOnWriteCollection.html +3 -9
- package/docs/html/classes/utilities_MapTransformCollection.MapTransformCollection.html +3 -9
- package/docs/html/classes/utilities_ObservableMap.ObservableMap.html +0 -1
- package/docs/html/classes/utilities_ObservableSet.ObservableSet.html +0 -1
- package/docs/html/classes/utilities_ObservableWeakSet.ObservableWeakSet.html +0 -1
- package/docs/html/classes/utilities_ReadOnlyCollection.ReadOnlyCollection.html +3 -9
- package/docs/html/classes/utilities_ReadOnlyMap.ReadOnlyMap.html +4 -3
- package/docs/html/functions/utilities__geoJson.esriToGeoJSON.html +1 -1
- package/docs/html/functions/utilities__geoJson.geoJSONToEsri.html +2 -2
- package/docs/html/functions/utilities__gml.esriToGml.html +1 -1
- package/docs/html/functions/utilities__gml.gmlToEsri.html +2 -2
- package/docs/html/functions/utilities__project.project.html +4 -4
- package/docs/html/functions/utilities__wkt.esriToWKT.html +1 -1
- package/docs/html/functions/utilities__wkt.wktToEsri.html +2 -2
- package/docs/html/functions/utilities_esri.isGeometry.html +2 -2
- package/docs/html/functions/utilities_geometry.buffer.html +2 -2
- package/docs/html/functions/utilities_geometry.createCrossTypeUnion.html +3 -3
- package/docs/html/functions/utilities_geometry.esriToGeoJSON.html +1 -1
- package/docs/html/functions/utilities_geometry.esriToGml.html +1 -1
- package/docs/html/functions/utilities_geometry.esriToWKT.html +1 -1
- package/docs/html/functions/utilities_geometry.geoJSONToEsri.html +2 -2
- package/docs/html/functions/utilities_geometry.getScreenExtent.html +1 -1
- package/docs/html/functions/utilities_geometry.gmlToEsri.html +2 -2
- package/docs/html/functions/utilities_geometry.project.html +4 -4
- package/docs/html/functions/utilities_geometry.removeZValues.html +3 -3
- package/docs/html/functions/utilities_geometry.wktToEsri.html +2 -2
- package/docs/html/functions/utilities_query.spatialFilter.html +1 -1
- package/docs/html/functions/utilities_symbol.isPointGeometrySymbol.html +2 -2
- package/docs/html/functions/utilities_symbol.isPolygonGeometrySymbol.html +2 -2
- package/docs/html/functions/utilities_symbol.isPolylineGeometrySymbol.html +2 -2
- package/docs/html/functions/utilities_symbol.isSymbol.html +2 -2
- package/docs/html/functions/utilities_symbol.isVolumetric.html +1 -1
- package/docs/html/interfaces/data_Feature.FeatureProperties.html +2 -2
- package/docs/html/interfaces/data_Feature.PresentableAttributes.html +4 -3
- package/docs/html/interfaces/data_support_attachments.AttachmentEnabledLayer.html +8 -4
- package/docs/html/interfaces/json_RendererJson.SizeInfoJson.html +3 -3
- package/docs/html/interfaces/json_SymbolJson.ObjectSymbol3DLayerJson.html +2 -2
- package/docs/html/interfaces/json_WebSceneJson.WebSceneJson.html +2 -2
- package/docs/html/interfaces/support_ArcGISRequestHelper.ArcGISRequestOptions.html +2 -2
- package/docs/html/interfaces/tasks_query_QueryOptions.QueryOptions-1.html +2 -2
- package/docs/html/interfaces/tasks_search_SearchOptions.SearchOptions-1.html +2 -2
- package/docs/html/interfaces/tasks_search_support__querySearchProviderUtils.ExpandSearchAreaResult.html +2 -2
- package/docs/html/interfaces/utilities_transformation.Transformation.html +2 -2
- package/docs/html/modules/support_esri.html +5 -2
- package/docs/html/types/support_esri.FeatureIdentifier.html +1 -0
- package/docs/html/types/support_esri.FeatureLayerApplyEdits.html +1 -1
- package/docs/html/types/support_esri.FeatureLayerApplyEditsEdits.html +1 -0
- package/docs/html/types/support_esri.FeatureLayerApplyEditsOptions.html +1 -0
- package/docs/html/types/support_esri.ItemCallback.html +1 -1
- package/docs/html/types/support_esri.ItemTestCallback.html +1 -1
- package/docs/html/types/support_esri.LengthUnit.html +3 -0
- package/docs/html/types/support_esri.LinearUnits.html +4 -0
- package/docs/html/variables/version.version.html +1 -1
- package/json/GeometryJson.d.ts +1 -1
- package/json/LayerJson.js +1 -1
- package/mapping/CSVLayerExtension.d.ts +2 -2
- package/mapping/FeatureLayerExtension.d.ts +2 -2
- package/mapping/GeoJSONLayerExtension.d.ts +2 -2
- package/mapping/ImageryLayerExtension.js +1 -1
- package/mapping/_SublayerExtension.js +1 -1
- package/mapping/support/featureService.js +1 -1
- package/package.json +2 -2
- package/portal/FeatureLayer.js +1 -1
- package/portal/FeatureReduction.d.ts +1 -1
- package/portal/FeatureReduction.js +1 -1
- package/portal/Lighting.d.ts +1 -1
- package/portal/Symbol.d.ts +2 -1
- package/portal/Widgets.d.ts +1 -1
- package/support/esri.d.ts +21 -6
- package/tasks/identify/BuildingComponentSublayerHitTestIdentifyProvider.d.ts +2 -2
- package/tasks/identify/CSVLayer3DHitTestIdentifyProvider.d.ts +2 -2
- package/tasks/identify/CSVLayer3DHitTestIdentifyProvider.js +1 -1
- package/tasks/identify/CSVLayerClientSideQueryIdentifyProvider.d.ts +4 -4
- package/tasks/identify/ClientSideIdentifyProvider.d.ts +1 -1
- package/tasks/identify/FeatureLayer3DHitTestIdentifyProvider.d.ts +2 -2
- package/tasks/identify/FeatureLayer3DHitTestIdentifyProvider.js +1 -1
- package/tasks/identify/FeatureLayerClientSideIdentifyProvider.d.ts +3 -3
- package/tasks/identify/FeatureLayerClientSideIdentifyProvider.js +1 -1
- package/tasks/identify/FeatureLayerQueryIdentifyProvider.d.ts +4 -4
- package/tasks/identify/GeoJSONLayer3DHitTestIdentifyProvider.d.ts +2 -2
- package/tasks/identify/GeoJSONLayer3DHitTestIdentifyProvider.js +1 -1
- package/tasks/identify/GeoJSONLayerClientSideQueryIdentifyProvider.d.ts +4 -4
- package/tasks/identify/GeoRSSLayerIdentifyProvider.d.ts +4 -4
- package/tasks/identify/GraphicsLayerQueryIdentifyProvider.d.ts +4 -4
- package/tasks/identify/HitTestIdentifyProvider.d.ts +6 -8
- package/tasks/identify/IdentifyProviderBase.d.ts +8 -8
- package/tasks/identify/IdentifyService.d.ts +8 -8
- package/tasks/identify/ImageryLayerIdentifyProvider.d.ts +4 -4
- package/tasks/identify/ImageryLayerIdentifyProvider.js +1 -1
- package/tasks/identify/KMLLayerQueryIdentifyProvider.d.ts +4 -4
- package/tasks/identify/MapNotesSublayerQueryIdentifyProvider.d.ts +4 -4
- package/tasks/identify/PointCloudLayerHitTestIdentifyProvider.d.ts +2 -2
- package/tasks/identify/RouteLayerQueryIdentifyProvider.d.ts +4 -4
- package/tasks/identify/SceneLayerHitTestIdentifyProvider.d.ts +2 -2
- package/tasks/identify/SceneLayerQueryIdentifyProvider.d.ts +4 -4
- package/tasks/identify/StreamLayerClientSideQueryIdentifyProvider.js +1 -1
- package/tasks/identify/SubtypeSublayerQueryIdentifyProvider.d.ts +5 -5
- package/tasks/identify/WMSLayerFeatureInfoIdentifyProvider.d.ts +4 -4
- package/tasks/identify/WMSSublayerIdentifyProvider.d.ts +4 -4
- package/tasks/identify/_utilities.js +1 -1
- package/tasks/query/QueryOptions.d.ts +3 -3
- package/tasks/query/StreamLayerClientSideQueryProvider.js +1 -1
- package/tasks/search/QuerySearchProvider.js +1 -1
- package/tasks/search/SearchOptions.d.ts +3 -3
- package/tasks/search/SubtypeSublayerQuerySearchProvider.js +1 -1
- package/tasks/search/support/_querySearchProviderUtils.d.ts +2 -2
- package/utilities/CollectionProxy.d.ts +9 -9
- package/utilities/CollectionProxy.js +1 -1
- package/utilities/CopyOnWriteCollection.d.ts +2 -2
- package/utilities/_geoJson.d.ts +3 -3
- package/utilities/_gml.d.ts +3 -3
- package/utilities/_project.d.ts +2 -2
- package/utilities/_wkt.d.ts +3 -3
- package/utilities/arcade.js +1 -1
- package/utilities/basemaps.js +1 -1
- package/utilities/esri.d.ts +2 -2
- package/utilities/geometry.d.ts +13 -14
- package/utilities/geometry.js +1 -1
- package/utilities/query.d.ts +2 -2
- package/utilities/query.js +1 -1
- package/utilities/symbol.d.ts +3 -3
- package/utilities/watch.d.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/docs/html/types/support_esri.FeatureLayerBaseApplyEditsEdits.html +0 -1
- package/docs/html/types/support_esri.FeatureLayerBaseApplyEditsOptions.html +0 -1
|
@@ -6,7 +6,7 @@ ramp.</p>
|
|
|
6
6
|
<p>See
|
|
7
7
|
<a href="https://developers.arcgis.com/web-map-specification/objects/sizeInfo_visualVariable/">https://developers.arcgis.com/web-map-specification/objects/sizeInfo_visualVariable/</a>
|
|
8
8
|
<a href="https://developers.arcgis.com/web-scene-specification/objects/sizeInfo_visualVariable/">https://developers.arcgis.com/web-scene-specification/objects/sizeInfo_visualVariable/</a>.</p>
|
|
9
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SizeInfoJson</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#axis">axis</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"all"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SizeInfoJson</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#axis">axis</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"all"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"height"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"width"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"depth"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"widthAndDepth"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#field">field</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#legendOptions">legendOptions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#maxDataValue">maxDataValue</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#maxSize">maxSize</a><span class="tsd-signature-symbol">?: </span><a href="json_RendererJson.SizeJson.html" class="tsd-signature-type tsd-kind-interface">SizeJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#minDataValue">minDataValue</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#minSize">minSize</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><a href="json_RendererJson.SizeJson.html" class="tsd-signature-type tsd-kind-interface">SizeJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#normalizationField">normalizationField</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#target">target</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"outline"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"sizeInfo"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#useSymbolValue">useSymbolValue</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#valueRepresentation">valueRepresentation</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"width"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"radius"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"diameter"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"area"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"distance"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_RendererJson.SizeInfoJson.html#valueUnit">valueUnit</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"unknown"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"feet"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"meters"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"miles"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"nautical-miles"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"yards"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"millimeters"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"centimeters"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"decimeters"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"inches"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"kilometer"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"decimal-degrees"</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#json/RendererJson.SizeInfoJson">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="json_RendererJson.VisualVariableJsonBase.html" class="tsd-signature-type tsd-kind-interface">VisualVariableJsonBase</a><ul class="tsd-hierarchy"><li><span class="target">SizeInfoJson</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="json_RendererJson.SizeInfoJson.html#axis" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>axis?</span></a>
|
|
10
10
|
<a href="json_RendererJson.SizeInfoJson.html#field" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field</span></a>
|
|
11
11
|
<a href="json_RendererJson.SizeInfoJson.html#legendOptions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>legend<wbr/>Options?</span></a>
|
|
12
12
|
<a href="json_RendererJson.SizeInfoJson.html#maxDataValue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Data<wbr/>Value?</span></a>
|
|
@@ -19,7 +19,7 @@ ramp.</p>
|
|
|
19
19
|
<a href="json_RendererJson.SizeInfoJson.html#useSymbolValue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Symbol<wbr/>Value?</span></a>
|
|
20
20
|
<a href="json_RendererJson.SizeInfoJson.html#valueRepresentation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value<wbr/>Representation?</span></a>
|
|
21
21
|
<a href="json_RendererJson.SizeInfoJson.html#valueUnit" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value<wbr/>Unit?</span></a>
|
|
22
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="axis" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>axis</span><a href="#axis" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axis</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"all"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"
|
|
22
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="axis" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>axis</span><a href="#axis" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">axis</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"all"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"height"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"width"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"depth"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"widthAndDepth"</span></div><div class="tsd-comment tsd-typography"><p>Defines the axis the size visual variable should be applied to when
|
|
23
23
|
rendering features with an ObjectSymbol3DLayer.</p>
|
|
24
24
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="field" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field</span><a href="#field" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">field</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A string value indicating the name of the feature attribute field that
|
|
25
25
|
contains the data value to render.</p>
|
|
@@ -47,7 +47,7 @@ axis of this visual variable instead of proportionally scaling this axis'
|
|
|
47
47
|
value after other axes.</p>
|
|
48
48
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="valueRepresentation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>value<wbr/>Representation</span><a href="#valueRepresentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">value<wbr/>Representation</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"width"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"radius"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"diameter"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"area"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"distance"</span></div><div class="tsd-comment tsd-typography"><p>Specifies how to apply the data value when mapping real-world sizes. See
|
|
49
49
|
table below for supported values.</p>
|
|
50
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="valueUnit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>value<wbr/>Unit</span><a href="#valueUnit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">value<wbr/>Unit</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"unknown"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"feet"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"meters"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"miles"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"nautical-miles"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"yards"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"
|
|
50
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="valueUnit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>value<wbr/>Unit</span><a href="#valueUnit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">value<wbr/>Unit</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"unknown"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"feet"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"meters"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"miles"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"nautical-miles"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"yards"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"millimeters"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"centimeters"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"decimeters"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"inches"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"kilometer"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"decimal-degrees"</span></div><div class="tsd-comment tsd-typography"><p>A string value indicating the required unit of measurement if the data
|
|
51
51
|
represents a real world distance quantity. If the data value represents a
|
|
52
52
|
non-distance quantity, e.g. traffic count, census data, etc., valueUnits
|
|
53
53
|
should be set to 'unknown'.</p>
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
shape (e.g., a sphere or cylinder) with a PointSymbol3D in a SceneView.</p>
|
|
3
3
|
<p>See
|
|
4
4
|
<a href="https://developers.arcgis.com/web-scene-specification/objects/objectSymbol3DLayer/">https://developers.arcgis.com/web-scene-specification/objects/objectSymbol3DLayer/</a>.</p>
|
|
5
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ObjectSymbol3DLayerJson</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#anchor">anchor</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"center"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"top"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"bottom"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ObjectSymbol3DLayerJson</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#anchor">anchor</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"center"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"top"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"bottom"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"relative"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"origin"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#anchorPosition">anchorPosition</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#castShadows">castShadows</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#depth">depth</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#enable">enable</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#heading">heading</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#height">height</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#material">material</a><span class="tsd-signature-symbol">?: </span><a href="json_SymbolJson.MaterialJson.html" class="tsd-signature-type tsd-kind-interface">MaterialJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#outline">outline</a><span class="tsd-signature-symbol">?: </span><a href="json_SymbolJson.OutlineJson.html" class="tsd-signature-type tsd-kind-interface">OutlineJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#resource">resource</a><span class="tsd-signature-symbol">?: </span><a href="json_SymbolJson.ResourceObjectSymbolJson.html" class="tsd-signature-type tsd-kind-interface">ResourceObjectSymbolJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"Object"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_SymbolJson.ObjectSymbol3DLayerJson.html#width">width</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#json/SymbolJson.ObjectSymbol3DLayerJson">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="json_SymbolJson.Symbol3DLayerJsonBase.html" class="tsd-signature-type tsd-kind-interface">Symbol3DLayerJsonBase</a><ul class="tsd-hierarchy"><li><span class="target">ObjectSymbol3DLayerJson</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="json_SymbolJson.ObjectSymbol3DLayerJson.html#anchor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>anchor?</span></a>
|
|
6
6
|
<a href="json_SymbolJson.ObjectSymbol3DLayerJson.html#anchorPosition" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>anchor<wbr/>Position?</span></a>
|
|
7
7
|
<a href="json_SymbolJson.ObjectSymbol3DLayerJson.html#castShadows" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cast<wbr/>Shadows?</span></a>
|
|
8
8
|
<a href="json_SymbolJson.ObjectSymbol3DLayerJson.html#depth" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>depth?</span></a>
|
|
@@ -14,7 +14,7 @@ shape (e.g., a sphere or cylinder) with a PointSymbol3D in a SceneView.</p>
|
|
|
14
14
|
<a href="json_SymbolJson.ObjectSymbol3DLayerJson.html#resource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>resource?</span></a>
|
|
15
15
|
<a href="json_SymbolJson.ObjectSymbol3DLayerJson.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
16
16
|
<a href="json_SymbolJson.ObjectSymbol3DLayerJson.html#width" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>width?</span></a>
|
|
17
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="anchor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>anchor</span><a href="#anchor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">anchor</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"center"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"top"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"bottom"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"
|
|
17
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="anchor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>anchor</span><a href="#anchor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">anchor</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"center"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"top"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"bottom"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"relative"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"origin"</span></div><div class="tsd-comment tsd-typography"><p>The positioning of the object relative to the geometry. Must be one of
|
|
18
18
|
the following values: center, bottom, origin.</p>
|
|
19
19
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="anchorPosition" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>anchor<wbr/>Position</span><a href="#anchorPosition" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">anchor<wbr/>Position</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>When anchor equals "relative", this property specifies the positioning of
|
|
20
20
|
the object relative to the geometry as a fraction of the symbol layer's
|
|
@@ -8,7 +8,7 @@ consumed by the ArcGIS API for JavaScript via the WebScene class to easily
|
|
|
8
8
|
create compelling 3D applications.</p>
|
|
9
9
|
<p>See
|
|
10
10
|
<a href="https://developers.arcgis.com/web-scene-specification/objects/webscene/">https://developers.arcgis.com/web-scene-specification/objects/webscene/</a>.</p>
|
|
11
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">WebSceneJson</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#applicationProperties">applicationProperties</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.ApplicationPropertiesJson.html" class="tsd-signature-type tsd-kind-interface">ApplicationPropertiesJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#authoringApp">authoringApp</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#authoringAppVersion">authoringAppVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#baseMap">baseMap</a><span class="tsd-signature-symbol">: </span><a href="json_BasemapJson.BasemapJson.html" class="tsd-signature-type tsd-kind-interface">BasemapJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#clippingArea">clippingArea</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">clip</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">geometry</span><span class="tsd-signature-symbol">: </span><a href="json_GeometryJson.ExtentJson.html" class="tsd-signature-type tsd-kind-interface">ExtentJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#ground">ground</a><span class="tsd-signature-symbol">?: </span><a href="json_GroundJson.GroundJson.html" class="tsd-signature-type tsd-kind-interface">GroundJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#heightModelInfo">heightModelInfo</a><span class="tsd-signature-symbol">?: </span><a href="json_WebSceneJson.HeightModelInfoJson.html" class="tsd-signature-type tsd-kind-interface">HeightModelInfoJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#initialState">initialState</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.InitialStateJson.html" class="tsd-signature-type tsd-kind-interface">InitialStateJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#mapFloorInfo">mapFloorInfo</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.MapFloorInfoJson.html" class="tsd-signature-type tsd-kind-interface">MapFloorInfoJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#mapRangeInfo">mapRangeInfo</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.MapRangeInfoJson.html" class="tsd-signature-type tsd-kind-interface">MapRangeInfoJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#operationalLayers">operationalLayers</a><span class="tsd-signature-symbol">?: </span><a href="../types/json_OperationalLayerJson.OperationalLayerJson.html" class="tsd-signature-type tsd-kind-type-alias">OperationalLayerJson</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#presentation">presentation</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.PresentationJson.html" class="tsd-signature-type tsd-kind-interface">PresentationJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#spatialReference">spatialReference</a><span class="tsd-signature-symbol">: </span><a href="json_SpatialReferenceJson.SpatialReferenceJson.html" class="tsd-signature-type tsd-kind-interface">SpatialReferenceJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#tables">tables</a><span class="tsd-signature-symbol">?: </span><a href="json_TableJson.TableJson.html" class="tsd-signature-type tsd-kind-interface">TableJson</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#timeZone">timeZone</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#version">version</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#viewingMode">viewingMode</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"
|
|
11
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">WebSceneJson</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#applicationProperties">applicationProperties</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.ApplicationPropertiesJson.html" class="tsd-signature-type tsd-kind-interface">ApplicationPropertiesJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#authoringApp">authoringApp</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#authoringAppVersion">authoringAppVersion</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#baseMap">baseMap</a><span class="tsd-signature-symbol">: </span><a href="json_BasemapJson.BasemapJson.html" class="tsd-signature-type tsd-kind-interface">BasemapJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#clippingArea">clippingArea</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">clip</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">geometry</span><span class="tsd-signature-symbol">: </span><a href="json_GeometryJson.ExtentJson.html" class="tsd-signature-type tsd-kind-interface">ExtentJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#ground">ground</a><span class="tsd-signature-symbol">?: </span><a href="json_GroundJson.GroundJson.html" class="tsd-signature-type tsd-kind-interface">GroundJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#heightModelInfo">heightModelInfo</a><span class="tsd-signature-symbol">?: </span><a href="json_WebSceneJson.HeightModelInfoJson.html" class="tsd-signature-type tsd-kind-interface">HeightModelInfoJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#initialState">initialState</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.InitialStateJson.html" class="tsd-signature-type tsd-kind-interface">InitialStateJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#mapFloorInfo">mapFloorInfo</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.MapFloorInfoJson.html" class="tsd-signature-type tsd-kind-interface">MapFloorInfoJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#mapRangeInfo">mapRangeInfo</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.MapRangeInfoJson.html" class="tsd-signature-type tsd-kind-interface">MapRangeInfoJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#operationalLayers">operationalLayers</a><span class="tsd-signature-symbol">?: </span><a href="../types/json_OperationalLayerJson.OperationalLayerJson.html" class="tsd-signature-type tsd-kind-type-alias">OperationalLayerJson</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#presentation">presentation</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.PresentationJson.html" class="tsd-signature-type tsd-kind-interface">PresentationJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#spatialReference">spatialReference</a><span class="tsd-signature-symbol">: </span><a href="json_SpatialReferenceJson.SpatialReferenceJson.html" class="tsd-signature-type tsd-kind-interface">SpatialReferenceJson</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#tables">tables</a><span class="tsd-signature-symbol">?: </span><a href="json_TableJson.TableJson.html" class="tsd-signature-type tsd-kind-interface">TableJson</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#timeZone">timeZone</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#version">version</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#viewingMode">viewingMode</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"local"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"global"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="json_WebSceneJson.WebSceneJson.html#widgets">widgets</a><span class="tsd-signature-symbol">?: </span><a href="json_WebMapJson.WidgetsJson.html" class="tsd-signature-type tsd-kind-interface">WidgetsJson</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#json/WebSceneJson.WebSceneJson">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="json_WebMapJson.WebMapJsonBase.html" class="tsd-signature-type tsd-kind-interface">WebMapJsonBase</a><ul class="tsd-hierarchy"><li><span class="target">WebSceneJson</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="json_WebSceneJson.WebSceneJson.html#applicationProperties" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>application<wbr/>Properties?</span></a>
|
|
12
12
|
<a href="json_WebSceneJson.WebSceneJson.html#authoringApp" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>authoring<wbr/>App?</span></a>
|
|
13
13
|
<a href="json_WebSceneJson.WebSceneJson.html#authoringAppVersion" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>authoring<wbr/>App<wbr/>Version?</span></a>
|
|
14
14
|
<a href="json_WebSceneJson.WebSceneJson.html#baseMap" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Map</span></a>
|
|
@@ -60,6 +60,6 @@ generated by Maps SDK 4.28.</p>
|
|
|
60
60
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="json_WebMapJson.WebMapJsonBase.html">WebMapJsonBase</a>.<a href="json_WebMapJson.WebMapJsonBase.html#timeZone">timeZone</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="version" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>version</span><a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Root element in the web map specifying a string value indicating the web
|
|
61
61
|
map version. See
|
|
62
62
|
<a href="https://developers.arcgis.com/web-map-specification/objects/version/">https://developers.arcgis.com/web-map-specification/objects/version/</a>.</p>
|
|
63
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="json_WebMapJson.WebMapJsonBase.html">WebMapJsonBase</a>.<a href="json_WebMapJson.WebMapJsonBase.html#version">version</a></p></aside></section><section class="tsd-panel tsd-member"><a id="viewingMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>viewing<wbr/>Mode</span><a href="#viewingMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">viewing<wbr/>Mode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"
|
|
63
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="json_WebMapJson.WebMapJsonBase.html">WebMapJsonBase</a>.<a href="json_WebMapJson.WebMapJsonBase.html#version">version</a></p></aside></section><section class="tsd-panel tsd-member"><a id="viewingMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>viewing<wbr/>Mode</span><a href="#viewingMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">viewing<wbr/>Mode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"local"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"global"</span></div><div class="tsd-comment tsd-typography"><p>Must be one of the following values: "global" | "local".</p>
|
|
64
64
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="widgets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>widgets</span><a href="#widgets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">widgets</span><span class="tsd-signature-symbol">?:</span> <a href="json_WebMapJson.WidgetsJson.html" class="tsd-signature-type tsd-kind-interface">WidgetsJson</a></div><div class="tsd-comment tsd-typography"><p>The widgets object contains widgets that should be exposed to the user.</p>
|
|
65
65
|
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="json_WebMapJson.WebMapJsonBase.html">WebMapJsonBase</a>.<a href="json_WebMapJson.WebMapJsonBase.html#widgets">widgets</a></p></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#applicationProperties" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>application<wbr/>Properties</span></a><a href="#authoringApp" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>authoring<wbr/>App</span></a><a href="#authoringAppVersion" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>authoring<wbr/>App<wbr/>Version</span></a><a href="#baseMap" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Map</span></a><a href="#clippingArea" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>clipping<wbr/>Area</span></a><a href="#ground" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ground</span></a><a href="#heightModelInfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>height<wbr/>Model<wbr/>Info</span></a><a href="#initialState" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>State</span></a><a href="#mapFloorInfo" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>map<wbr/>Floor<wbr/>Info</span></a><a href="#mapRangeInfo" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>map<wbr/>Range<wbr/>Info</span></a><a href="#operationalLayers" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>operational<wbr/>Layers</span></a><a href="#presentation" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>presentation</span></a><a href="#spatialReference" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spatial<wbr/>Reference</span></a><a href="#tables" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tables</span></a><a href="#timeZone" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Zone</span></a><a href="#version" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>version</span></a><a href="#viewingMode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>viewing<wbr/>Mode</span></a><a href="#widgets" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>widgets</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@vertigis/arcgis-extensions</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ArcGISRequestOptions | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vertigis/arcgis-extensions</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@vertigis/arcgis-extensions</a></li><li><a href="../modules/support_ArcGISRequestHelper.html">support/ArcGISRequestHelper</a></li><li><a href="support_ArcGISRequestHelper.ArcGISRequestOptions.html">ArcGISRequestOptions</a></li></ul><h1>Interface ArcGISRequestOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options that can be passed into
|
|
2
2
|
<a href="support_ArcGISRequestHelper.ArcGISRequestHelper.html#request" class="tsd-kind-method">support/ArcGISRequestHelper!ArcGISRequestHelper.request</a>.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ArcGISRequestOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#batchLayerRequests">batchLayerRequests</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#body">body</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#headers">headers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#method">method</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"auto"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"head"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"post"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"put"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#query">query</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#responseType">responseType</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"blob"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xml"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"text"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"json"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"document"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"array-buffer"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"native"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#ttl">ttl</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#batchLayerRequests" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>batch<wbr/>Layer<wbr/>Requests?</span></a>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ArcGISRequestOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#batchLayerRequests">batchLayerRequests</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#body">body</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#headers">headers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#method">method</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"delete"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"auto"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"head"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"post"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"put"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#query">query</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#responseType">responseType</a><span class="tsd-signature-symbol">?: </span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"blob"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xml"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"text"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"json"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"document"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"array-buffer"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"native"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"native-request-init"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#ttl">ttl</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#batchLayerRequests" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>batch<wbr/>Layer<wbr/>Requests?</span></a>
|
|
4
4
|
<a href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#body" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>body?</span></a>
|
|
5
5
|
<a href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#headers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>headers?</span></a>
|
|
6
6
|
<a href="support_ArcGISRequestHelper.ArcGISRequestOptions.html#method" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>method?</span></a>
|
|
@@ -21,7 +21,7 @@ default, this is determined automatically based on the request size.
|
|
|
21
21
|
<strong>Possible Values:</strong> auto | post.</p>
|
|
22
22
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="query" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>query</span><a href="#query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">query</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>If the request URL points to a web server that requires parameters,
|
|
23
23
|
specify them here.</p>
|
|
24
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="responseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>response<wbr/>Type</span><a href="#responseType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response<wbr/>Type</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"blob"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xml"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"text"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"json"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"document"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"array-buffer"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"native"</span></div><div class="tsd-comment tsd-typography"><p>Response format. When this value is <code>image</code> the <code>headers</code> and <code>timeout</code>
|
|
24
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="responseType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>response<wbr/>Type</span><a href="#responseType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response<wbr/>Type</span><span class="tsd-signature-symbol">?:</span> <br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"blob"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"xml"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"text"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"image"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"json"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"document"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"array-buffer"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"native"</span><br/><span> </span><span class="tsd-signature-symbol">| </span><span class="tsd-signature-type">"native-request-init"</span></div><div class="tsd-comment tsd-typography"><p>Response format. When this value is <code>image</code> the <code>headers</code> and <code>timeout</code>
|
|
25
25
|
options are ignored. <strong>Possible Values:</strong> json | xml | text | blob |
|
|
26
26
|
array-buffer | document | image.</p>
|
|
27
27
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="ttl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ttl</span><a href="#ttl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ttl</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>See <a href="support_ArcGISRequestHelper.ArcGISRequestHelper.html#ttl" class="tsd-kind-property">support/ArcGISRequestHelper!ArcGISRequestHelper.ttl</a>.</p>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueryOptions | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vertigis/arcgis-extensions</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@vertigis/arcgis-extensions</a></li><li><a href="../modules/tasks_query_QueryOptions.html">tasks/query/QueryOptions</a></li><li><a href="tasks_query_QueryOptions.QueryOptions-1.html">QueryOptions</a></li></ul><h1>Interface QueryOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options that can be passed into
|
|
2
2
|
<a href="../classes/tasks_query_QueryService.QueryService.html#query" class="tsd-kind-method">tasks/query/QueryService!QueryService.query</a>.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">QueryOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#cancelToken">cancelToken</a><span class="tsd-signature-symbol">?: </span><a href="../types/support_Cancellable.CancelToken.html" class="tsd-signature-type tsd-kind-type-alias">CancelToken</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#maxAllowableOffset">maxAllowableOffset</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#maxResults">maxResults</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#outFields">outFields</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#outSpatialReference">outSpatialReference</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SpatialReference</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#returnGeometry">returnGeometry</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#spatialFilter">spatialFilter</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">QueryOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#cancelToken">cancelToken</a><span class="tsd-signature-symbol">?: </span><a href="../types/support_Cancellable.CancelToken.html" class="tsd-signature-type tsd-kind-type-alias">CancelToken</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#maxAllowableOffset">maxAllowableOffset</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#maxResults">maxResults</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#outFields">outFields</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#outSpatialReference">outSpatialReference</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SpatialReference</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#returnGeometry">returnGeometry</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_query_QueryOptions.QueryOptions-1.html#spatialFilter">spatialFilter</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">GeometryUnion</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="tasks_query_QueryOptions.QueryOptions-1.html#cancelToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancel<wbr/>Token?</span></a>
|
|
4
4
|
<a href="tasks_query_QueryOptions.QueryOptions-1.html#maxAllowableOffset" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Allowable<wbr/>Offset?</span></a>
|
|
5
5
|
<a href="tasks_query_QueryOptions.QueryOptions-1.html#maxResults" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Results?</span></a>
|
|
6
6
|
<a href="tasks_query_QueryOptions.QueryOptions-1.html#outFields" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>out<wbr/>Fields?</span></a>
|
|
@@ -15,6 +15,6 @@ the query operation.</p>
|
|
|
15
15
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="outFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>out<wbr/>Fields</span><a href="#outFields" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">out<wbr/>Fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Fields that should be returned for each feature.</p>
|
|
16
16
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="outSpatialReference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>out<wbr/>Spatial<wbr/>Reference</span><a href="#outSpatialReference" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">out<wbr/>Spatial<wbr/>Reference</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SpatialReference</span></div><div class="tsd-comment tsd-typography"><p>The spatial reference for the returned geometry.</p>
|
|
17
17
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="returnGeometry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>return<wbr/>Geometry</span><a href="#returnGeometry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">return<wbr/>Geometry</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether geometry for features should be returned.</p>
|
|
18
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="spatialFilter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>spatial<wbr/>Filter</span><a href="#spatialFilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spatial<wbr/>Filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">
|
|
18
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="spatialFilter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>spatial<wbr/>Filter</span><a href="#spatialFilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">spatial<wbr/>Filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GeometryUnion</span></div><div class="tsd-comment tsd-typography"><p>Spatial filter used to filter search results. If specified, results are
|
|
19
19
|
limited to features that intersect the geometry.</p>
|
|
20
20
|
</div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#cancelToken" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancel<wbr/>Token</span></a><a href="#maxAllowableOffset" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Allowable<wbr/>Offset</span></a><a href="#maxResults" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Results</span></a><a href="#outFields" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>out<wbr/>Fields</span></a><a href="#outSpatialReference" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>out<wbr/>Spatial<wbr/>Reference</span></a><a href="#returnGeometry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>return<wbr/>Geometry</span></a><a href="#spatialFilter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>spatial<wbr/>Filter</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@vertigis/arcgis-extensions</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SearchOptions | @vertigis/arcgis-extensions</title><meta name="description" content="Documentation for @vertigis/arcgis-extensions"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vertigis/arcgis-extensions</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@vertigis/arcgis-extensions</a></li><li><a href="../modules/tasks_search_SearchOptions.html">tasks/search/SearchOptions</a></li><li><a href="tasks_search_SearchOptions.SearchOptions-1.html">SearchOptions</a></li></ul><h1>Interface SearchOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options that can be passed into
|
|
2
2
|
<a href="../classes/tasks_search_SearchService.SearchService.html#search" class="tsd-kind-method">tasks/search/SearchService!SearchService.search</a>.</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SearchOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#cancelToken">cancelToken</a><span class="tsd-signature-symbol">?: </span><a href="../types/support_Cancellable.CancelToken.html" class="tsd-signature-type tsd-kind-type-alias">CancelToken</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#currentScale">currentScale</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#initialSearchArea">initialSearchArea</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">SearchOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#cancelToken">cancelToken</a><span class="tsd-signature-symbol">?: </span><a href="../types/support_Cancellable.CancelToken.html" class="tsd-signature-type tsd-kind-type-alias">CancelToken</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#currentScale">currentScale</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#initialSearchArea">initialSearchArea</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">GeometryUnion</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#locale">locale</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#maxAllowableOffset">maxAllowableOffset</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#maxQueryResults">maxQueryResults</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#maxResults">maxResults</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#maxSuggestions">maxSuggestions</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#near">near</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Point</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#onSourceComplete">onSourceComplete</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">result</span><span class="tsd-signature-symbol">: </span><a href="tasks_TaskResult.TaskResult.html" class="tsd-signature-type tsd-kind-interface">TaskResult</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#outSpatialReference">outSpatialReference</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SpatialReference</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#returnGeometry">returnGeometry</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="tasks_search_SearchOptions.SearchOptions-1.html#tokenizeSearchString">tokenizeSearchString</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="tasks_search_SearchOptions.SearchOptions-1.html#cancelToken" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancel<wbr/>Token?</span></a>
|
|
4
4
|
<a href="tasks_search_SearchOptions.SearchOptions-1.html#currentScale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>current<wbr/>Scale?</span></a>
|
|
5
5
|
<a href="tasks_search_SearchOptions.SearchOptions-1.html#initialSearchArea" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>initial<wbr/>Search<wbr/>Area?</span></a>
|
|
6
6
|
<a href="tasks_search_SearchOptions.SearchOptions-1.html#locale" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>locale?</span></a>
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
that can be used to cancel the search.</p>
|
|
18
18
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="currentScale" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>current<wbr/>Scale</span><a href="#currentScale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">current<wbr/>Scale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Indicates the current scale of the supplied search area. If not provided
|
|
19
19
|
the search area is limited to the initial search area.</p>
|
|
20
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="initialSearchArea" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>initial<wbr/>Search<wbr/>Area</span><a href="#initialSearchArea" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">initial<wbr/>Search<wbr/>Area</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">
|
|
20
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="initialSearchArea" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>initial<wbr/>Search<wbr/>Area</span><a href="#initialSearchArea" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">initial<wbr/>Search<wbr/>Area</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">GeometryUnion</span></div><div class="tsd-comment tsd-typography"><p>Initial search area. If possible the search area will be expanded until
|
|
21
21
|
the maximum number of results are fulfilled.</p>
|
|
22
22
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="locale" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>locale</span><a href="#locale" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">locale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The user's locale. Affects how numbers and other locale-specific values
|
|
23
23
|
in the search text are interpreted. If not specified, the current global
|