@vertigis/arcgis-extensions 35.8.1 → 35.9.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.
Files changed (155) hide show
  1. package/AppConfig.schema.json +6 -9
  2. package/data/Feature.d.ts +14 -3
  3. package/data/Feature.js +1 -1
  4. package/data/FeatureSourceBase.d.ts +2 -2
  5. package/data/FeatureSourceBase.js +1 -1
  6. package/data/RelationshipBase.d.ts +9 -6
  7. package/data/RelationshipBase.js +1 -1
  8. package/data/_Relationship.d.ts +3 -3
  9. package/data/_TableExtension.d.ts +5 -0
  10. package/docs/html/assets/search.js +1 -1
  11. package/docs/html/classes/data_ArcGISServiceTableExtension.ArcGISServiceTableExtension.html +13 -13
  12. package/docs/html/classes/data_Feature.Feature.html +35 -33
  13. package/docs/html/classes/data_FeatureSourceBase.FeatureSourceBase.html +19 -19
  14. package/docs/html/classes/data_FeatureSourceBase.RelationshipCollection.html +4 -4
  15. package/docs/html/classes/data_FeatureStream.FeatureStream.html +1 -1
  16. package/docs/html/classes/data_RelationshipBase.RelationshipBase.html +11 -11
  17. package/docs/html/classes/data__TableExtension.TableExtension.html +27 -27
  18. package/docs/html/classes/data__TableExtension.TableFeatureSettings.html +3 -3
  19. package/docs/html/classes/data__TableExtension.TableSchema.html +10 -10
  20. package/docs/html/classes/mapping_ArcGISSublayerExtension.ArcGISSublayerExtension.html +45 -45
  21. package/docs/html/classes/mapping_ArcGISSublayerExtension.ArcGISSublayerRelationshipCollection.html +3 -3
  22. package/docs/html/classes/mapping_ArcGISSublayerExtension.ArcGISSublayerSchema.html +1 -1
  23. package/docs/html/classes/mapping_BuildingComponentSublayerExtension.BuildingComponentSublayerExtension.html +48 -48
  24. package/docs/html/classes/mapping_BuildingComponentSublayerExtension.BuildingComponentSublayerSchema.html +1 -1
  25. package/docs/html/classes/mapping_BuildingGroupSublayerExtension.BuildingGroupSublayerExtension.html +52 -52
  26. package/docs/html/classes/mapping_BuildingGroupSublayerExtension.BuildingGroupSublayerSchema.html +2 -2
  27. package/docs/html/classes/mapping_BuildingSceneLayerExtension.BuildingSceneLayerExtension.html +63 -63
  28. package/docs/html/classes/mapping_BuildingSceneLayerExtension.BuildingSceneLayerReadOnlySchema.html +3 -3
  29. package/docs/html/classes/mapping_BuildingSublayerExtension.BuildingSublayerExtension.html +58 -58
  30. package/docs/html/classes/mapping_BuildingSublayerExtension.BuildingSublayerSchema.html +2 -2
  31. package/docs/html/classes/mapping_CSVLayerExtension.CSVLayerExtension.html +66 -66
  32. package/docs/html/classes/mapping_ElevationLayerExtension.ElevationLayerExtension.html +67 -67
  33. package/docs/html/classes/mapping_FeatureCollectionLayerExtension.FeatureCollectionLayerExtension.html +61 -61
  34. package/docs/html/classes/mapping_FeatureLayerExtension.FeatureLayerExtension.html +54 -54
  35. package/docs/html/classes/mapping_FeatureLayerExtensionBase.FeatureLayerExtensionBase.html +64 -64
  36. package/docs/html/classes/mapping_FeatureLayerExtensionBase.FeatureLayerSchema.html +4 -4
  37. package/docs/html/classes/mapping_GeoRSSLayerExtension.GeoRSSLayerExtension.html +67 -67
  38. package/docs/html/classes/mapping_GraphicsLayerExtension.GraphicsLayerExtension.html +63 -63
  39. package/docs/html/classes/mapping_GroupLayerExtension.GroupLayerExtension.html +60 -60
  40. package/docs/html/classes/mapping_ImageryLayerExtension.ImageryLayerExtension.html +65 -65
  41. package/docs/html/classes/mapping_ImageryTileLayerExtension.ImageryTileLayerExtension.html +65 -65
  42. package/docs/html/classes/mapping_IntegratedMeshLayerExtension.IntegratedMeshLayerExtension.html +68 -68
  43. package/docs/html/classes/mapping_KMLLayerExtension.KMLLayerExtension.html +63 -63
  44. package/docs/html/classes/mapping_KMLSublayerExtension.KMLSublayerExtension.html +53 -53
  45. package/docs/html/classes/mapping_MapImageLayerExtension.MapImageLayerExtension.html +64 -64
  46. package/docs/html/classes/mapping_MapImageSublayerExtension.MapImageSublayerExtension.html +40 -40
  47. package/docs/html/classes/mapping_OpenStreetMapLayerExtension.OpenStreetMapLayerExtension.html +70 -70
  48. package/docs/html/classes/mapping_PointCloudLayerExtension.PointCloudLayerExtension.html +65 -65
  49. package/docs/html/classes/mapping_SceneLayerExtension.SceneLayerExtension.html +64 -64
  50. package/docs/html/classes/mapping_StreamLayerExtension.StreamLayerExtension.html +65 -65
  51. package/docs/html/classes/mapping_StreamLayerExtension.StreamLayerSchema.html +4 -4
  52. package/docs/html/classes/mapping_TileLayerExtension.TileLayerExtension.html +63 -63
  53. package/docs/html/classes/mapping_TileSublayerExtension.TileSublayerExtension.html +41 -41
  54. package/docs/html/classes/mapping_UnsupportedLayerExtension.UnsupportedLayerExtension.html +71 -71
  55. package/docs/html/classes/mapping_VectorTileLayerExtension.VectorTileLayerExtension.html +67 -67
  56. package/docs/html/classes/mapping_WMSLayerExtension.WMSLayerExtension.html +65 -65
  57. package/docs/html/classes/mapping_WMSSublayerExtension.WMSSublayerExtension.html +52 -52
  58. package/docs/html/classes/mapping_WMTSLayerExtension.WMTSLayerExtension.html +64 -64
  59. package/docs/html/classes/mapping_WMTSSublayerExtension.WMTSSublayerExtension.html +54 -54
  60. package/docs/html/classes/mapping_WebTileLayerExtension.WebTileLayerExtension.html +70 -70
  61. package/docs/html/classes/mapping__LayerExtension.ArrayWrappedCollection.html +2 -2
  62. package/docs/html/classes/mapping__LayerExtension.LayerExtension.html +73 -73
  63. package/docs/html/classes/mapping__LayerExtension.LayerExtensionSchema.html +5 -5
  64. package/docs/html/classes/mapping__SublayerExtension.SubSublayerExtensionCollection.html +6 -6
  65. package/docs/html/classes/mapping__SublayerExtension.SublayerExtension.html +64 -64
  66. package/docs/html/classes/mapping__SublayerExtension.SublayerSchema.html +2 -2
  67. package/docs/html/classes/tasks_geocoding_ArcGISGeocoder.ArcGISGeocoder.html +16 -16
  68. package/docs/html/classes/tasks_geocoding_Geocoder.Geocoder.html +18 -18
  69. package/docs/html/classes/tasks_query_ArcGISRelationship.ArcGISRelationship.html +15 -15
  70. package/docs/html/classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html +11 -11
  71. package/docs/html/classes/utilities_asyncIterable.AsyncQueue.html +1 -1
  72. package/docs/html/interfaces/data_ArcGISServiceTableExtension.ArcGISServiceTableExtensionProperties.html +2 -2
  73. package/docs/html/interfaces/data_Feature.FeatureProperties.html +5 -5
  74. package/docs/html/interfaces/data_Feature.FetchRelatedFeaturesOptions.html +3 -0
  75. package/docs/html/interfaces/data_Feature.FormatOptions.html +1 -1
  76. package/docs/html/interfaces/data_Feature.PresentableAttributes.html +2 -2
  77. package/docs/html/interfaces/data__Relationship.Relationship-1.html +4 -4
  78. package/docs/html/interfaces/data__Relationship.RelationshipProperties.html +1 -1
  79. package/docs/html/interfaces/data__TableExtension.TableExtensionProperties.html +5 -5
  80. package/docs/html/interfaces/data__TableExtension.TableProperties.html +1 -1
  81. package/docs/html/interfaces/data__TableExtension.TableReference.html +2 -2
  82. package/docs/html/interfaces/mapping_ArcGISSublayerExtension.ArcGISSublayerExtensionProperties.html +5 -5
  83. package/docs/html/interfaces/mapping_ArcGISSublayerExtension.ArcGISSublayerProperties.html +2 -2
  84. package/docs/html/interfaces/mapping_BuildingComponentSublayerExtension.BuildingComponentSublayerExtensionProperties.html +5 -5
  85. package/docs/html/interfaces/mapping_BuildingGroupSublayerExtension.BuildingGroupSublayerExtensionProperties.html +5 -5
  86. package/docs/html/interfaces/mapping_BuildingSceneLayerExtension.BuildingSceneLayerExtensionProperties.html +7 -7
  87. package/docs/html/interfaces/mapping_BuildingSceneLayerExtension.BuildingSceneLayerProperties.html +2 -2
  88. package/docs/html/interfaces/mapping_BuildingSublayerExtension.BuildingSublayerExtensionProperties.html +5 -5
  89. package/docs/html/interfaces/mapping_BuildingSublayerExtension.BuildingSublayerProperties.html +2 -2
  90. package/docs/html/interfaces/mapping_CSVLayerExtension.CSVLayerExtensionProperties.html +8 -8
  91. package/docs/html/interfaces/mapping_ElevationLayerExtension.ElevationLayerExtensionProperties.html +8 -8
  92. package/docs/html/interfaces/mapping_FeatureLayerExtension.FeatureLayerExtensionProperties.html +8 -8
  93. package/docs/html/interfaces/mapping_FeatureLayerExtension.FeatureLayerProperties.html +2 -2
  94. package/docs/html/interfaces/mapping_FeatureLayerExtensionBase.FeatureLayerBaseProperties.html +2 -2
  95. package/docs/html/interfaces/mapping_FeatureLayerExtensionBase.FeatureLayerExtensionBaseProperties.html +8 -8
  96. package/docs/html/interfaces/mapping_GeoRSSLayerExtension.GeoRSSLayerExtensionProperties.html +8 -8
  97. package/docs/html/interfaces/mapping_GraphicsLayerExtension.GraphicsLayerExtensionProperties.html +8 -8
  98. package/docs/html/interfaces/mapping_GroupLayerExtension.GroupLayerExtensionProperties.html +8 -8
  99. package/docs/html/interfaces/mapping_ImageryLayerExtension.ImageryLayerExtensionProperties.html +8 -8
  100. package/docs/html/interfaces/mapping_ImageryTileLayerExtension.ImageryTileLayerExtensionProperties.html +8 -8
  101. package/docs/html/interfaces/mapping_ImageryTileLayerExtension.ImageryTileLayerProperties.html +2 -2
  102. package/docs/html/interfaces/mapping_IntegratedMeshLayerExtension.IntegratedMeshLayerExtensionProperties.html +8 -8
  103. package/docs/html/interfaces/mapping_KMLLayerExtension.KMLLayerExtensionProperties.html +7 -7
  104. package/docs/html/interfaces/mapping_KMLSublayerExtension.KMLSublayerExtensionProperties.html +5 -5
  105. package/docs/html/interfaces/mapping_MapImageLayerExtension.MapImageLayerExtensionProperties.html +7 -7
  106. package/docs/html/interfaces/mapping_MapImageSublayerExtension.MapImageSublayerExtensionProperties.html +5 -5
  107. package/docs/html/interfaces/mapping_MapImageSublayerExtension.MapImageSublayerProperties.html +2 -2
  108. package/docs/html/interfaces/mapping_OpenStreetMapLayerExtension.OpenStreetMapLayerExtensionProperties.html +8 -8
  109. package/docs/html/interfaces/mapping_PointCloudLayerExtension.PointCloudLayerExtensionProperties.html +8 -8
  110. package/docs/html/interfaces/mapping_SceneLayerExtension.SceneLayerExtensionProperties.html +8 -8
  111. package/docs/html/interfaces/mapping_StreamLayerExtension.StreamLayerExtensionProperties.html +8 -8
  112. package/docs/html/interfaces/mapping_TileLayerExtension.TileLayerExtensionProperties.html +8 -8
  113. package/docs/html/interfaces/mapping_TileLayerExtension.TileLayerProperties.html +2 -2
  114. package/docs/html/interfaces/mapping_TileSublayerExtension.TileSublayerExtensionProperties.html +5 -5
  115. package/docs/html/interfaces/mapping_TileSublayerExtension.TileSublayerProperties.html +2 -2
  116. package/docs/html/interfaces/mapping_VectorTileLayerExtension.VectorTileLayerExtensionProperties.html +8 -8
  117. package/docs/html/interfaces/mapping_WMSLayerExtension.WMSLayerExtensionProperties.html +7 -7
  118. package/docs/html/interfaces/mapping_WMSSublayerExtension.WMSSublayerExtensionProperties.html +5 -5
  119. package/docs/html/interfaces/mapping_WMSSublayerExtension.WMSSublayerProperties.html +2 -2
  120. package/docs/html/interfaces/mapping_WMTSLayerExtension.WMTSLayerExtensionProperties.html +7 -7
  121. package/docs/html/interfaces/mapping_WMTSSublayerExtension.WMTSSublayerExtensionProperties.html +6 -6
  122. package/docs/html/interfaces/mapping_WebTileLayerExtension.WebTileLayerExtensionProperties.html +8 -8
  123. package/docs/html/interfaces/mapping__LayerExtension.LayerExtensionProperties.html +11 -11
  124. package/docs/html/interfaces/mapping__LayerExtension.LayerProperties.html +2 -2
  125. package/docs/html/interfaces/mapping__LayerExtension.LayerReference.html +4 -4
  126. package/docs/html/interfaces/mapping__SublayerExtension.SublayerExtensionProperties.html +9 -9
  127. package/docs/html/interfaces/mapping__SublayerExtension.SublayerProperties.html +2 -2
  128. package/docs/html/interfaces/mapping__SublayerExtension.SublayerReference.html +2 -2
  129. package/docs/html/interfaces/portal_DrawingInfo.DrawingInfo-1.html +7 -7
  130. package/docs/html/interfaces/portal_PopupInfo.OrderByFields.html +2 -2
  131. package/docs/html/interfaces/portal_PopupInfo.PopupElement.html +5 -5
  132. package/docs/html/interfaces/portal_PopupInfo.PopupInfo-1.html +8 -8
  133. package/docs/html/interfaces/portal_PopupInfo.RelatedRecordsInfo.html +2 -2
  134. package/docs/html/interfaces/tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html +4 -4
  135. package/docs/html/interfaces/tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html +1 -1
  136. package/docs/html/modules/data_Feature.html +5 -5
  137. package/docs/html/modules/data__Relationship.Relationship.html +2 -2
  138. package/docs/html/modules/data__Relationship.html +5 -5
  139. package/docs/html/modules/mapping__LayerExtension.html +1 -1
  140. package/docs/html/modules/mapping__SublayerExtension.html +2 -2
  141. package/docs/html/modules/portal_PopupInfo.html +1 -1
  142. package/docs/html/modules/utilities_promise.html +9 -2
  143. package/docs/html/modules/version.html +1 -1
  144. package/mapping/_LayerExtension.d.ts +5 -0
  145. package/mapping/_SublayerExtension.d.ts +5 -0
  146. package/package.json +1 -1
  147. package/portal/DrawingInfo.js +1 -1
  148. package/tasks/query/ArcGISRelationship.d.ts +3 -3
  149. package/tasks/query/ArcGISRelationship.js +1 -1
  150. package/tasks/query/QueryBasedRelationship.d.ts +3 -3
  151. package/tasks/query/QueryBasedRelationship.js +1 -1
  152. package/utilities/promise.d.ts +8 -0
  153. package/utilities/promise.js +1 -1
  154. package/version.d.ts +1 -1
  155. package/version.js +1 -1
@@ -3,11 +3,11 @@
3
3
  order for the returned child records.</p>
4
4
  </div><div><p><a href="https://developers.arcgis.com/web-map-specification/objects/relatedRecordsInfo/" class="external">https://developers.arcgis.com/web-map-specification/objects/relatedRecordsInfo/</a>
5
5
  <a href="https://developers.arcgis.com/web-scene-specification/objects/relatedRecordsInfo/" class="external">https://developers.arcgis.com/web-scene-specification/objects/relatedRecordsInfo/</a>.</p>
6
- </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">RelatedRecordsInfo</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_PopupInfo.RelatedRecordsInfo.html#orderByFields" class="tsd-kind-icon">order<wbr/>By<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_PopupInfo.RelatedRecordsInfo.html#showRelatedRecords" class="tsd-kind-icon">show<wbr/>Related<wbr/>Records</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="orderByFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> order<wbr/>By<wbr/>Fields<a href="#orderByFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">order<wbr/>By<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <a href="portal_PopupInfo.OrderByFields.html" class="tsd-signature-type" data-tsd-kind="Interface">OrderByFields</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in src/portal/PopupInfo.ts:175</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">RelatedRecordsInfo</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_PopupInfo.RelatedRecordsInfo.html#orderByFields" class="tsd-kind-icon">order<wbr/>By<wbr/>Fields</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="portal_PopupInfo.RelatedRecordsInfo.html#showRelatedRecords" class="tsd-kind-icon">show<wbr/>Related<wbr/>Records</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="orderByFields" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> order<wbr/>By<wbr/>Fields<a href="#orderByFields" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">order<wbr/>By<wbr/>Fields<span class="tsd-signature-symbol">?:</span> <a href="portal_PopupInfo.OrderByFields.html" class="tsd-signature-type" data-tsd-kind="Interface">OrderByFields</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in src/portal/PopupInfo.ts:174</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
7
  <p>Array of orderByFields objects indicating the field display order for the
8
8
  related records and whether they should be sorted in ascending &#39;asc&#39; or
9
9
  descending &#39;desc&#39; order.</p>
10
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="showRelatedRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link">show<wbr/>Related<wbr/>Records<a href="#showRelatedRecords" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">show<wbr/>Related<wbr/>Records<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in src/portal/PopupInfo.ts:184</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="showRelatedRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link">show<wbr/>Related<wbr/>Records<a href="#showRelatedRecords" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">show<wbr/>Related<wbr/>Records<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in src/portal/PopupInfo.ts:183</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
11
11
  <p>Required boolean value indicating whether to display related records. If
12
12
  true, client should const the user navigate to the related records.
13
13
  Defaults to true if the layer participates in a relationship AND the
@@ -1,10 +1,10 @@
1
1
  <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ArcGISRelationshipProperties | @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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@vertigis/arcgis-extensions</a></li><li><a href="../modules/tasks_query_ArcGISRelationship.html">tasks/query/ArcGISRelationship</a></li><li><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html">ArcGISRelationshipProperties</a></li></ul><h1>Interface ArcGISRelationshipProperties </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>Properties that can be passed into the constructor for <a href="../classes/tasks_query_ArcGISRelationship.ArcGISRelationship.html">ArcGISRelationship</a>.</p>
3
- </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">QueryBasedRelationshipProperties</a><ul class="tsd-hierarchy"><li><span class="target">ArcGISRelationshipProperties</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#_relationshipType" class="tsd-kind-icon">$relationship<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#cardinality" class="tsd-kind-icon">cardinality</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#destinationForeignKey" class="tsd-kind-icon">destination<wbr/>Foreign<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#failureMode" class="tsd-kind-icon">failure<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#keyField" class="tsd-kind-icon">key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#originForeignKey" class="tsd-kind-icon">origin<wbr/>Foreign<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#queryService" class="tsd-kind-icon">query<wbr/>Service</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#relatedKeyField" class="tsd-kind-icon">related<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#relatedSource" class="tsd-kind-icon">related<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#relationshipTableId" class="tsd-kind-icon">relationship<wbr/>Table<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#title" class="tsd-kind-icon">title</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="_relationshipType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> $relationship<wbr/>Type<a href="#_relationshipType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">$relationship<wbr/>Type<span class="tsd-signature-symbol">?:</span> <a href="../modules/data__Relationship.html#RelationshipType" class="tsd-signature-type" data-tsd-kind="Type alias">RelationshipType</a></div><aside class="tsd-sources"><p>Inherited from <a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html">QueryBasedRelationshipProperties</a>.<a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#_relationshipType">$relationshipType</a></p><ul><li>Defined in src/tasks/query/QueryBasedRelationship.ts:48</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">QueryBasedRelationshipProperties</a><ul class="tsd-hierarchy"><li><span class="target">ArcGISRelationshipProperties</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#_relationshipType" class="tsd-kind-icon">$relationship<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#cardinality" class="tsd-kind-icon">cardinality</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#destinationForeignKey" class="tsd-kind-icon">destination<wbr/>Foreign<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#failureMode" class="tsd-kind-icon">failure<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#keyField" class="tsd-kind-icon">key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#originForeignKey" class="tsd-kind-icon">origin<wbr/>Foreign<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#queryService" class="tsd-kind-icon">query<wbr/>Service</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#relatedKeyField" class="tsd-kind-icon">related<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#relatedSource" class="tsd-kind-icon">related<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#relationshipTableId" class="tsd-kind-icon">relationship<wbr/>Table<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html#title" class="tsd-kind-icon">title</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="_relationshipType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> $relationship<wbr/>Type<a href="#_relationshipType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">$relationship<wbr/>Type<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html">QueryBasedRelationshipProperties</a>.<a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#_relationshipType">$relationshipType</a></p><ul><li>Defined in src/tasks/query/QueryBasedRelationship.ts:48</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
4
  <p>See {@link RelationshipProperties.type}.</p>
5
5
  </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="cardinality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> cardinality<a href="#cardinality" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">cardinality<span class="tsd-signature-symbol">?:</span> <a href="../modules/data__Relationship.html#Cardinality" class="tsd-signature-type" data-tsd-kind="Type alias">Cardinality</a></div><aside class="tsd-sources"><p>Inherited from <a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html">QueryBasedRelationshipProperties</a>.<a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#cardinality">cardinality</a></p><ul><li>Defined in src/tasks/query/QueryBasedRelationship.ts:33</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
6
  <p>See <a href="../classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html#cardinality">QueryBasedRelationship.cardinality</a>.</p>
7
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="destinationForeignKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> destination<wbr/>Foreign<wbr/>Key<a href="#destinationForeignKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">destination<wbr/>Foreign<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/tasks/query/ArcGISRelationship.ts:42</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="destinationForeignKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> destination<wbr/>Foreign<wbr/>Key<a href="#destinationForeignKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">destination<wbr/>Foreign<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/tasks/query/ArcGISRelationship.ts:43</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
8
8
  <p>See <a href="../classes/tasks_query_ArcGISRelationship.ArcGISRelationship.html#destinationForeignKey">ArcGISRelationship.destinationForeignKey</a>.</p>
9
9
  </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="failureMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> failure<wbr/>Mode<a href="#failureMode" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">failure<wbr/>Mode<span class="tsd-signature-symbol">?:</span> <a href="../modules/FailureMode.html#FailureMode-1" class="tsd-signature-type" data-tsd-kind="Type alias">FailureMode</a></div><aside class="tsd-sources"><p>Inherited from <a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html">QueryBasedRelationshipProperties</a>.<a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#failureMode">failureMode</a></p><ul><li>Defined in src/support/InitializableBase.ts:63</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
10
10
  <p>See <a href="../classes/support_InitializableBase.InitializableBase.html#failureMode">InitializableBase.failureMode</a>.</p>
@@ -12,7 +12,7 @@
12
12
  <p>The unique ID to assign to the entity. If not specified, one will be generated.</p>
13
13
  </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="keyField" class="tsd-anchor"></a><h3 class="tsd-anchor-link">key<wbr/>Field<a href="#keyField" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">key<wbr/>Field<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html">QueryBasedRelationshipProperties</a>.<a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#keyField">keyField</a></p><ul><li>Defined in src/tasks/query/QueryBasedRelationship.ts:23</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
14
14
  <p>See <a href="../classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html#keyField">QueryBasedRelationship.keyField</a>.</p>
15
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="originForeignKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> origin<wbr/>Foreign<wbr/>Key<a href="#originForeignKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">origin<wbr/>Foreign<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/tasks/query/ArcGISRelationship.ts:37</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
15
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="originForeignKey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> origin<wbr/>Foreign<wbr/>Key<a href="#originForeignKey" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">origin<wbr/>Foreign<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in src/tasks/query/ArcGISRelationship.ts:38</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
16
16
  <p>See <a href="../classes/tasks_query_ArcGISRelationship.ArcGISRelationship.html#originForeignKey">ArcGISRelationship.originForeignKey</a>.</p>
17
17
  </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="queryService" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> query<wbr/>Service<a href="#queryService" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">query<wbr/>Service<span class="tsd-signature-symbol">?:</span> <a href="../classes/tasks_query_QueryService.QueryService.html" class="tsd-signature-type" data-tsd-kind="Class">QueryService</a></div><aside class="tsd-sources"><p>Inherited from <a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html">QueryBasedRelationshipProperties</a>.<a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#queryService">queryService</a></p><ul><li>Defined in src/tasks/query/QueryBasedRelationship.ts:43</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
18
18
  <p>See <a href="../classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html#queryService">QueryBasedRelationship.queryService</a>.</p>
@@ -20,7 +20,7 @@
20
20
  <p>See <a href="../classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html#relatedKeyField">QueryBasedRelationship.relatedKeyField</a>.</p>
21
21
  </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="relatedSource" class="tsd-anchor"></a><h3 class="tsd-anchor-link">related<wbr/>Source<a href="#relatedSource" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">related<wbr/>Source<span class="tsd-signature-symbol">:</span> <a href="data_FeatureSource.FeatureSource.html" class="tsd-signature-type" data-tsd-kind="Interface">FeatureSource</a></div><aside class="tsd-sources"><p>Inherited from <a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html">QueryBasedRelationshipProperties</a>.<a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#relatedSource">relatedSource</a></p><ul><li>Defined in src/tasks/query/QueryBasedRelationship.ts:38</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
22
22
  <p>See <a href="../classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html#relatedSource">QueryBasedRelationship.relatedSource</a>.</p>
23
- </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="relationshipTableId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> relationship<wbr/>Table<wbr/>Id<a href="#relationshipTableId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">relationship<wbr/>Table<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in src/tasks/query/ArcGISRelationship.ts:32</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
23
+ </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="relationshipTableId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> relationship<wbr/>Table<wbr/>Id<a href="#relationshipTableId" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">relationship<wbr/>Table<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in src/tasks/query/ArcGISRelationship.ts:33</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
24
24
  <p>See <a href="../classes/tasks_query_ArcGISRelationship.ArcGISRelationship.html#relationshipTableId">ArcGISRelationship.relationshipTableId</a>.</p>
25
25
  </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="title" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> title<a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">title<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from <a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html">QueryBasedRelationshipProperties</a>.<a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#title">title</a></p><ul><li>Defined in src/data/_Relationship.ts:20</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
26
26
  <p>See <a href="data__Relationship.Relationship-1.html#title">Relationship.title</a>.</p>
@@ -1,6 +1,6 @@
1
1
  <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueryBasedRelationshipProperties | @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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@vertigis/arcgis-extensions</a></li><li><a href="../modules/tasks_query_QueryBasedRelationship.html">tasks/query/QueryBasedRelationship</a></li><li><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html">QueryBasedRelationshipProperties</a></li></ul><h1>Interface QueryBasedRelationshipProperties </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
2
  <p>Properties that can be passed into the constructor for <a href="../classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html">QueryBasedRelationship</a>.</p>
3
- </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="data__Relationship.RelationshipProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipProperties</a><ul class="tsd-hierarchy"><li><span class="target">QueryBasedRelationshipProperties</span><ul class="tsd-hierarchy"><li><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">ArcGISRelationshipProperties</a></li></ul></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#_relationshipType" class="tsd-kind-icon">$relationship<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#cardinality" class="tsd-kind-icon">cardinality</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#failureMode" class="tsd-kind-icon">failure<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#keyField" class="tsd-kind-icon">key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#queryService" class="tsd-kind-icon">query<wbr/>Service</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#relatedKeyField" class="tsd-kind-icon">related<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#relatedSource" class="tsd-kind-icon">related<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#title" class="tsd-kind-icon">title</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="_relationshipType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> $relationship<wbr/>Type<a href="#_relationshipType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">$relationship<wbr/>Type<span class="tsd-signature-symbol">?:</span> <a href="../modules/data__Relationship.html#RelationshipType" class="tsd-signature-type" data-tsd-kind="Type alias">RelationshipType</a></div><aside class="tsd-sources"><p>Overrides <a href="data__Relationship.RelationshipProperties.html">RelationshipProperties</a>.<a href="data__Relationship.RelationshipProperties.html#_relationshipType">$relationshipType</a></p><ul><li>Defined in src/tasks/query/QueryBasedRelationship.ts:48</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
3
+ </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="data__Relationship.RelationshipProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">RelationshipProperties</a><ul class="tsd-hierarchy"><li><span class="target">QueryBasedRelationshipProperties</span><ul class="tsd-hierarchy"><li><a href="tasks_query_ArcGISRelationship.ArcGISRelationshipProperties.html" class="tsd-signature-type" data-tsd-kind="Interface">ArcGISRelationshipProperties</a></li></ul></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#_relationshipType" class="tsd-kind-icon">$relationship<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#cardinality" class="tsd-kind-icon">cardinality</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#failureMode" class="tsd-kind-icon">failure<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#id" class="tsd-kind-icon">id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#keyField" class="tsd-kind-icon">key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#queryService" class="tsd-kind-icon">query<wbr/>Service</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#relatedKeyField" class="tsd-kind-icon">related<wbr/>Key<wbr/>Field</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#relatedSource" class="tsd-kind-icon">related<wbr/>Source</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="tasks_query_QueryBasedRelationship.QueryBasedRelationshipProperties.html#title" class="tsd-kind-icon">title</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a id="_relationshipType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> $relationship<wbr/>Type<a href="#_relationshipType" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">$relationship<wbr/>Type<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Overrides <a href="data__Relationship.RelationshipProperties.html">RelationshipProperties</a>.<a href="data__Relationship.RelationshipProperties.html#_relationshipType">$relationshipType</a></p><ul><li>Defined in src/tasks/query/QueryBasedRelationship.ts:48</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
4
4
  <p>See {@link RelationshipProperties.type}.</p>
5
5
  </div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="cardinality" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> cardinality<a href="#cardinality" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">cardinality<span class="tsd-signature-symbol">?:</span> <a href="../modules/data__Relationship.html#Cardinality" class="tsd-signature-type" data-tsd-kind="Type alias">Cardinality</a></div><aside class="tsd-sources"><ul><li>Defined in src/tasks/query/QueryBasedRelationship.ts:33</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
6
6
  <p>See <a href="../classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html#cardinality">QueryBasedRelationship.cardinality</a>.</p>