@vertigis/arcgis-extensions 49.9.0 → 50.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 +23 -6
- package/Hyperlink.d.ts +3 -1
- package/Hyperlink.js +1 -1
- package/data/ArcGISServiceTableExtension.js +1 -1
- package/data/Feature.d.ts +1 -3
- package/data/Feature.js +1 -1
- package/data/FeatureSet.d.ts +40 -2
- package/data/FeatureSet.js +1 -1
- package/data/FeatureSettings.js +1 -1
- package/data/FeatureSourceBase.d.ts +22 -27
- package/data/FeatureSourceBase.js +1 -1
- package/data/FieldExtension.d.ts +0 -3
- package/data/FieldExtension.js +1 -1
- package/data/PopupContentExtension.js +1 -1
- package/data/Schema.js +1 -1
- package/data/_Relationship.d.ts +1 -2
- package/data/_TableExtension.d.ts +1 -1
- package/data/_TableExtension.js +1 -1
- package/docs/html/assets/highlight.css +38 -10
- package/docs/html/assets/navigation.js +1 -1
- package/docs/html/assets/search.js +1 -1
- package/docs/html/classes/Entity.EntityBase.html +12 -74
- package/docs/html/classes/Hyperlink.Hyperlink.html +10 -72
- package/docs/html/classes/LanguageResources.LanguageResources.html +36 -30
- package/docs/html/classes/data_ArcGISServiceTableExtension.ArcGISServiceTableExtension.html +35 -97
- package/docs/html/classes/data_Attachment.Attachment.html +12 -74
- package/docs/html/classes/data_Feature.Feature.html +16 -76
- package/docs/html/classes/data_FeatureList.FeatureList.html +73 -17
- package/docs/html/classes/data_FeatureSet.FeatureSet.html +39 -33
- package/docs/html/classes/data_FeatureSettings.FeatureSettings.html +11 -71
- package/docs/html/classes/data_FeatureSourceBase.FeatureSourceBase.html +35 -98
- package/docs/html/classes/data_FeatureSourceBase.RelationshipCollection.html +72 -16
- package/docs/html/classes/data_FeatureStream.FeatureStream.html +13 -75
- package/docs/html/classes/data_FieldExtension.FieldExtension.html +13 -75
- package/docs/html/classes/data_PopupContentExtension.PopupContentExtension.html +13 -75
- package/docs/html/classes/data_RelationshipBase.RelationshipBase.html +37 -31
- package/docs/html/classes/data_Schema.Schema.html +13 -73
- package/docs/html/classes/data_TaskSettings.TaskSettings.html +12 -72
- package/docs/html/classes/data__TableExtension.TableExtension.html +34 -96
- package/docs/html/classes/data__TableExtension.TableFeatureSettings.html +11 -71
- package/docs/html/classes/data__TableExtension.TableSchema.html +15 -75
- package/docs/html/classes/layer_preset_LayerPreset.LayerPreset.html +14 -76
- package/docs/html/classes/layer_preset_LayerPresetSettings.LayerPresetSetting.html +36 -30
- package/docs/html/classes/mapping_ArcGISSublayerExtension.ArcGISSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_ArcGISSublayerExtension.ArcGISSublayerRelationshipCollection.html +72 -16
- package/docs/html/classes/mapping_BasemapExtension.BasemapExtension.html +14 -76
- package/docs/html/classes/mapping_Bookmark.Bookmark.html +12 -74
- package/docs/html/classes/mapping_BuildingComponentSublayerExtension.BuildingComponentSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_BuildingComponentSublayerExtension.BuildingComponentSublayerSchema.html +13 -73
- package/docs/html/classes/mapping_BuildingGroupSublayerExtension.BuildingGroupSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_BuildingGroupSublayerExtension.BuildingGroupSublayerSchema.html +13 -73
- package/docs/html/classes/mapping_BuildingSceneLayerExtension.BuildingSceneLayerExtension.html +35 -97
- package/docs/html/classes/mapping_BuildingSceneLayerExtension.BuildingSceneLayerReadOnlySchema.html +13 -73
- package/docs/html/classes/mapping_BuildingSublayerExtension.BuildingSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_BuildingSublayerExtension.BuildingSublayerFeatureSettings.html +11 -53
- package/docs/html/classes/mapping_BuildingSublayerExtension.BuildingSublayerSchema.html +13 -73
- package/docs/html/classes/mapping_CSVLayerExtension.CSVLayerExtension.html +35 -97
- package/docs/html/classes/mapping_ElevationLayerExtension.ElevationLayerExtension.html +35 -97
- package/docs/html/classes/mapping_FeatureCollectionLayerExtension.FeatureCollectionLayerExtension.html +35 -97
- package/docs/html/classes/mapping_FeatureLayerExtension.FeatureLayerExtension.html +35 -97
- package/docs/html/classes/mapping_FeatureLayerExtensionBase.FeatureLayerExtensionBase.html +35 -97
- package/docs/html/classes/mapping_FeatureLayerExtensionBase.FeatureLayerReadOnlySchema.html +13 -73
- package/docs/html/classes/mapping_FeatureLayerExtensionBase.FeatureLayerSchema.html +13 -73
- package/docs/html/classes/mapping_GeoJSONLayerExtension.GeoJSONLayerExtension.html +35 -97
- package/docs/html/classes/mapping_GeoRSSLayerExtension.GeoRSSLayerExtension.html +35 -97
- package/docs/html/classes/mapping_GraphicsLayerExtension.GraphicsLayerExtension.html +35 -97
- package/docs/html/classes/mapping_GroundExtension.GroundExtension.html +13 -75
- package/docs/html/classes/mapping_GroupLayerExtension.GroupLayerExtension.html +35 -97
- package/docs/html/classes/mapping_GroupLayerExtension.GroupLayerExtensionCollection.html +74 -23
- package/docs/html/classes/mapping_ImageryLayerExtension.ImageryLayerExtension.html +35 -97
- package/docs/html/classes/mapping_ImageryTileLayerExtension.ImageryTileLayerExtension.html +35 -97
- package/docs/html/classes/mapping_IntegratedMeshLayerExtension.IntegratedMeshLayerExtension.html +35 -97
- package/docs/html/classes/mapping_KMLLayerExtension.KMLLayerExtension.html +35 -97
- package/docs/html/classes/mapping_KMLSublayerExtension.KMLSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_MapConstraints.MapConstraints.html +12 -72
- package/docs/html/classes/mapping_MapExtension.MapExtension.html +13 -75
- package/docs/html/classes/mapping_MapImageLayerExtension.MapImageLayerExtension.html +35 -97
- package/docs/html/classes/mapping_MapImageSublayerExtension.MapImageSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_MapNotesLayerExtension.MapNotesLayerExtension.html +35 -97
- package/docs/html/classes/mapping_MapNotesSublayerExtension.MapNotesSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_MapNotesSublayerExtension.MapNotesSublayerExtensionSchema.html +13 -73
- package/docs/html/classes/mapping_MediaLayerExtension.MediaLayerExtension.html +35 -97
- package/docs/html/classes/mapping_OpenStreetMapLayerExtension.OpenStreetMapLayerExtension.html +35 -97
- package/docs/html/classes/mapping_PointCloudLayerExtension.PointCloudLayerExtension.html +35 -97
- package/docs/html/classes/mapping_RouteLayerExtension.RouteLayerExtension.html +35 -97
- package/docs/html/classes/mapping_RouteLayerExtension.RouteLayerExtensionSchema.html +13 -73
- package/docs/html/classes/mapping_SceneLayerExtension.SceneLayerExtension.html +35 -97
- package/docs/html/classes/mapping_StreamLayerExtension.StreamLayerExtension.html +35 -97
- package/docs/html/classes/mapping_StreamLayerExtension.StreamLayerSchema.html +13 -73
- package/docs/html/classes/mapping_SubtypeGroupLayerExtension.SubtypeGroupLayerExtension.html +35 -97
- package/docs/html/classes/mapping_SubtypeGroupLayerExtension.SubtypeGroupLayerRelationshipCollection.html +72 -16
- package/docs/html/classes/mapping_SubtypeGroupLayerExtension.SubtypeGroupLayerSchema.html +13 -73
- package/docs/html/classes/mapping_SubtypeSublayerExtension.SubtypeSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_SubtypeSublayerExtension.SubtypeSublayerRelationshipCollection.html +72 -16
- package/docs/html/classes/mapping_SubtypeSublayerExtension.SubtypeSublayerSchema.html +13 -73
- package/docs/html/classes/mapping_TileLayerExtension.TileLayerExtension.html +35 -97
- package/docs/html/classes/mapping_TileSublayerExtension.TileSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_UnsupportedLayerExtension.UnsupportedLayerExtension.html +35 -97
- package/docs/html/classes/mapping_VectorTileLayerExtension.VectorTileLayerExtension.html +35 -97
- package/docs/html/classes/mapping_WFSLayerExtension.WFSLayerExtension.html +35 -97
- package/docs/html/classes/mapping_WMSLayerExtension.WMSLayerExtension.html +35 -97
- package/docs/html/classes/mapping_WMSSublayerExtension.WMSSublayerExtension.html +35 -97
- package/docs/html/classes/mapping_WMTSLayerExtension.WMTSLayerExtension.html +35 -97
- package/docs/html/classes/mapping_WebTileLayerExtension.WebTileLayerExtension.html +35 -97
- package/docs/html/classes/mapping__LayerExtension.LayerExtension.html +35 -97
- package/docs/html/classes/mapping__LayerExtension.LayerExtensionReadOnlySchema.html +13 -73
- package/docs/html/classes/mapping__LayerExtension.LayerExtensionSchema.html +13 -73
- package/docs/html/classes/mapping__LayerExtensionCollectionImpl.LayerExtensionCollectionImpl.html +74 -23
- package/docs/html/classes/mapping__SublayerExtension.SubSublayerExtensionCollection.html +74 -23
- package/docs/html/classes/mapping__SublayerExtension.SublayerExtension.html +35 -97
- package/docs/html/classes/mapping__SublayerExtension.SublayerSchema.html +13 -73
- package/docs/html/classes/mapping_support_ArrayWrappedCollection.ArrayWrappedCollection.html +72 -16
- package/docs/html/classes/mapping_support_LayerListSettings.ExtensionBaseLayerListSettings.html +9 -71
- package/docs/html/classes/mapping_support_LayerListSettings.LayerListSettings.html +10 -72
- package/docs/html/classes/mapping_support__LayerExtensionCollection.LayerExtensionCollectionBase.html +77 -26
- package/docs/html/classes/mapping_support__SublayerExtensionCollection.SublayerExtensionCollectionBase.html +77 -26
- package/docs/html/classes/menus_Menu.Menu.html +13 -75
- package/docs/html/classes/menus_MenuItem.MenuItem.html +13 -75
- package/docs/html/classes/support_FormatSettings.FormatSettings.html +12 -72
- package/docs/html/classes/support_InitializableBase.InitializableBase.html +21 -83
- package/docs/html/classes/support_InitializableCollectionProxy.InitializableCollectionProxy.html +73 -17
- package/docs/html/classes/support_Observable.Observable.html +27 -26
- package/docs/html/classes/support_ReadOnlyInitializableCollection.ReadOnlyInitializableCollection.html +73 -17
- package/docs/html/classes/support_Serializable.SerializableBase.html +38 -32
- package/docs/html/classes/support_Settings.Settings.html +15 -75
- package/docs/html/classes/support__ArcGISRelationshipCollection.ArcGISRelationshipCollection.html +72 -16
- package/docs/html/classes/support_observableUtils.ObservableMixin.html +3 -0
- package/docs/html/classes/tasks_geocoding_ArcGISGeocoder.ArcGISGeocoder.html +35 -97
- package/docs/html/classes/tasks_geocoding_Geocoder.Geocoder.html +33 -95
- package/docs/html/classes/tasks_identify_IdentifyService.IdentifyService.html +11 -73
- package/docs/html/classes/tasks_query_ArcGISRelationship.ArcGISRelationship.html +36 -30
- package/docs/html/classes/tasks_query_QueryBasedRelationship.QueryBasedRelationship.html +36 -30
- package/docs/html/classes/tasks_query_QueryService.QueryService.html +11 -73
- package/docs/html/classes/tasks_search_SearchService.SearchService.html +12 -74
- package/docs/html/classes/utilities_CaseInsensitiveObservableMap.CaseInsensitiveObservableMap.html +24 -27
- package/docs/html/classes/utilities_CollectionProxy.CollectionProxy.html +73 -17
- package/docs/html/classes/utilities_CopyOnWriteCollection.CopyOnWriteCollection.html +72 -16
- package/docs/html/classes/utilities_MapTransformCollection.MapTransformCollection.html +72 -16
- package/docs/html/classes/utilities_ObservableMap.ObservableMap.html +26 -32
- package/docs/html/classes/utilities_ObservableSet.ObservableSet.html +38 -32
- package/docs/html/classes/utilities_ObservableWeakSet.ObservableWeakSet.html +44 -42
- package/docs/html/classes/utilities_ReadOnlyCollection.ReadOnlyCollection.html +72 -16
- package/docs/html/classes/utilities_ReadOnlyMap.ReadOnlyMap.html +23 -29
- package/docs/html/classes/utilities_format_date.DateFormatter.html +37 -31
- package/docs/html/classes/utilities_format_number.NumberFormatter.html +37 -31
- package/docs/html/classes/utilities_format_time.TimeFormatter.html +37 -31
- package/docs/html/functions/support_Observable.deprecatedGetPropertyPath.html +7 -0
- package/docs/html/functions/support_Observable.deprecatedNotifyChange.html +5 -0
- package/docs/html/functions/support_Observable.deprecatedSet.html +9 -0
- package/docs/html/functions/support_Observable.deprecatedWatch.html +9 -0
- package/docs/html/functions/support_Observable.deprecatedWatchProperty.html +14 -0
- package/docs/html/functions/support_Observable.getPropertyByPath.html +3 -2
- package/docs/html/functions/support_observableUtils.createIHandle.html +8 -0
- package/docs/html/functions/support_observableUtils.notifyChange.html +8 -0
- package/docs/html/functions/support_observableUtils.observable-1.html +31 -0
- package/docs/html/functions/support_observableUtils.onWatch.html +14 -0
- package/docs/html/functions/support_observableUtils.once.html +11 -0
- package/docs/html/functions/support_observableUtils.watch.html +24 -0
- package/docs/html/functions/support_observableUtils.watchEach.html +33 -0
- package/docs/html/functions/support_observableUtils.watchEvent.html +12 -0
- package/docs/html/functions/support_observableUtils.when.html +9 -0
- package/docs/html/functions/support_observableUtils.whenOnce.html +9 -0
- package/docs/html/functions/utilities_checkArg.checkArg.html +1 -1
- package/docs/html/functions/utilities_watch.onCollectionPropertyChange.html +6 -1
- package/docs/html/functions/utilities_watch.watchCollectionPropertyEach.html +5 -4
- package/docs/html/functions/utilities_watch.watchEach.html +8 -6
- package/docs/html/hierarchy.html +1 -1
- package/docs/html/interfaces/data_ArcGISServiceTableExtension.ArcGISServiceTableExtensionProperties.html +1 -1
- package/docs/html/interfaces/data_Feature.PresentableAttributes.html +24 -30
- package/docs/html/interfaces/data_Schema.SchemaProperties.html +2 -2
- package/docs/html/interfaces/data__Relationship.Relationship-1.html +35 -29
- package/docs/html/interfaces/data__TableExtension.TableExtensionProperties.html +1 -1
- package/docs/html/interfaces/json_AnnotationLayerJson.AnnotationLayerJson.html +2 -2
- package/docs/html/interfaces/json_BasemapLayerJson.BasemapLayerJsonBase.html +2 -2
- package/docs/html/interfaces/json_BingLayerJson.BingLayerJson.html +2 -2
- package/docs/html/interfaces/json_BuildingSceneLayerJson.BuildingSceneLayerJson.html +2 -2
- package/docs/html/interfaces/json_CSVLayerJson.CSVLayerJson.html +2 -2
- package/docs/html/interfaces/json_FeatureLayerJson.FeatureLayerJson.html +2 -2
- package/docs/html/interfaces/json_GeoJSONLayerJson.GeoJSONLayerJson.html +2 -2
- package/docs/html/interfaces/json_GeoRSSLayerJson.GeoRSSLayerJson.html +2 -2
- package/docs/html/interfaces/json_GroupLayerJson.GroupLayerJson.html +2 -2
- package/docs/html/interfaces/json_ImageServiceLayerJson.ImageServiceLayerJson.html +2 -2
- package/docs/html/interfaces/json_ImageServiceVectorLayerJson.ImageServiceVectorLayerJson.html +2 -2
- package/docs/html/interfaces/json_IntegratedMeshLayerJson.IntegratedMeshLayerJson.html +2 -2
- package/docs/html/interfaces/json_ItemJson.ItemJson.html +2 -2
- package/docs/html/interfaces/json_KMLLayerJson.KMLLayerJson.html +2 -2
- package/docs/html/interfaces/json_LayerJson.LayerJsonBase.html +2 -2
- package/docs/html/interfaces/json_MapServiceLayerJson.MapServiceLayerJson.html +2 -2
- package/docs/html/interfaces/json_MediaLayerJson.MediaLayerJson.html +2 -2
- package/docs/html/interfaces/json_OpenStreetMapLayerJson.OpenStreetMapLayerJson.html +2 -2
- package/docs/html/interfaces/json_OperationalLayerJson.OperationalLayerJsonBase.html +2 -2
- package/docs/html/interfaces/json_PointCloudLayerJson.PointCloudLayerJson.html +2 -2
- package/docs/html/interfaces/json_RasterDataElevationLayerJson.RasterDataElevationLayerJson.html +2 -2
- package/docs/html/interfaces/json_SceneLayerJson.SceneLayerJson.html +2 -2
- package/docs/html/interfaces/json_StreamLayerJson.StreamLayerJson.html +2 -2
- package/docs/html/interfaces/json_SubtypeGroupLayerJson.SubtypeGroupLayerJson.html +2 -2
- package/docs/html/interfaces/json_SubtypeGroupLayerJson.SubtypeSubtypeGroupLayerJson.html +2 -2
- package/docs/html/interfaces/json_SubtypeSublayerJson.SubtypeSublayerJson.html +2 -2
- package/docs/html/interfaces/json_TiledElevationServiceLayerJson.TiledElevationServiceLayerJson.html +2 -2
- package/docs/html/interfaces/json_TiledImageServiceLayerJson.TiledImageServiceLayerJson.html +2 -2
- package/docs/html/interfaces/json_TiledMapServiceLayerJson.TiledMapServiceLayerJson.html +2 -2
- package/docs/html/interfaces/json_VectorTileLayerJson.VectorTileLayerJson.html +2 -2
- package/docs/html/interfaces/json_WFSLayerJson.WFSLayerJson.html +2 -2
- package/docs/html/interfaces/json_WMSLayerJson.WMSLayerJson.html +2 -2
- package/docs/html/interfaces/json_WebTileLayerJson.WebTileLayerJson.html +2 -2
- package/docs/html/interfaces/mapping_ArcGISSublayerExtension.ArcGISSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_BuildingComponentSublayerExtension.BuildingComponentSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_BuildingGroupSublayerExtension.BuildingGroupSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_BuildingSceneLayerExtension.BuildingSceneLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_BuildingSceneLayerExtension.BuildingSceneLayerProperties.html +2 -2
- package/docs/html/interfaces/mapping_BuildingSublayerExtension.BuildingSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_CSVLayerExtension.CSVLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_ElevationLayerExtension.ElevationLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_FeatureLayerExtension.FeatureLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_FeatureLayerExtension.FeatureLayerProperties.html +2 -2
- package/docs/html/interfaces/mapping_FeatureLayerExtensionBase.FeatureLayerBaseProperties.html +2 -2
- package/docs/html/interfaces/mapping_FeatureLayerExtensionBase.FeatureLayerExtensionBaseProperties.html +1 -1
- package/docs/html/interfaces/mapping_GeoJSONLayerExtension.GeoJSONLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_GeoRSSLayerExtension.GeoRSSLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_GraphicsLayerExtension.GraphicsLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_GroupLayerExtension.GroupLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_ImageryLayerExtension.ImageryLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_ImageryTileLayerExtension.ImageryTileLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_IntegratedMeshLayerExtension.IntegratedMeshLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_KMLLayerExtension.KMLLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_KMLSublayerExtension.KMLSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_MapExtension.MapExtensionProperties.html +3 -3
- package/docs/html/interfaces/mapping_MapImageLayerExtension.MapImageLayerExtensionProperties.html +4 -4
- package/docs/html/interfaces/mapping_MapImageSublayerExtension.MapImageSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_MapNotesLayerExtension.MapNotesLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_MapNotesSublayerExtension.MapNotesSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_MediaLayerExtension.MediaLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_OpenStreetMapLayerExtension.OpenStreetMapLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_PointCloudLayerExtension.PointCloudLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_PointCloudLayerExtension.PointCloudLayerProperties.html +2 -2
- package/docs/html/interfaces/mapping_RouteLayerExtension.RouteLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_SceneLayerExtension.SceneLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_StreamLayerExtension.StreamLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_SubtypeGroupLayerExtension.SubtypeGroupLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_SubtypeSublayerExtension.SubtypeSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_TileLayerExtension.TileLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_TileSublayerExtension.TileSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_VectorTileLayerExtension.VectorTileLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_WFSLayerExtension.WFSLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_WMSLayerExtension.WMSLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_WMSSublayerExtension.WMSSublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_WMTSLayerExtension.WMTSLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_WebTileLayerExtension.WebTileLayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping__LayerExtension.LayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping__SublayerExtension.SublayerExtensionProperties.html +1 -1
- package/docs/html/interfaces/mapping_support_ArrayWrappedCollection.ArrayWrappedCollectionProperties.html +3 -3
- package/docs/html/interfaces/support_InitializableBase.Initializable.html +1 -1
- package/docs/html/interfaces/support_Observable.IDeprecatedObservable.html +57 -0
- package/docs/html/interfaces/support_Serializable.Serializable.html +60 -5
- package/docs/html/interfaces/support_esri.SublayerLike.html +2 -29
- package/docs/html/interfaces/support_observableUtils.IHandle.html +9 -0
- package/docs/html/interfaces/support_observableUtils.WatchEachOptions.html +29 -0
- package/docs/html/interfaces/support_observableUtils.WatchOptions.html +26 -0
- package/docs/html/interfaces/utilities_collection.AfterItemChangeEvent.html +4 -0
- package/docs/html/modules/support_Observable.html +8 -2
- package/docs/html/modules/support_esri.html +4 -3
- package/docs/html/modules/support_observableUtils.html +20 -0
- package/docs/html/modules/utilities_ObservableWeakSet.html +1 -1
- package/docs/html/modules/utilities_collection.html +1 -0
- package/docs/html/modules/utilities_watch.html +4 -4
- package/docs/html/modules.html +1 -0
- package/docs/html/types/support_esri.CollectionAfterEvent.html +1 -0
- package/docs/html/types/support_esri.CollectionAfterItemEvent.html +1 -1
- package/docs/html/types/support_esri.CollectionEvent.html +1 -0
- package/docs/html/types/support_esri.CollectionItemEvent.html +1 -0
- package/docs/html/types/support_observableUtils.Observable.html +5 -0
- package/docs/html/types/support_observableUtils.ObservablePropertyPath.html +9 -0
- package/docs/html/types/support_observableUtils.TargetTypeFromPath.html +14 -0
- package/docs/html/types/support_observableUtils.ValueTypeFromPath.html +14 -0
- package/docs/html/types/support_observableUtils.WhenOptions.html +7 -0
- package/docs/html/types/utilities_watch.WatchCallback.html +3 -0
- package/docs/html/variables/version.version.html +1 -1
- package/layer-preset/LayerPreset.js +1 -1
- package/mapping/ArcGISSublayerExtension.js +1 -1
- package/mapping/BasemapExtension.d.ts +1 -1
- package/mapping/BasemapExtension.js +1 -1
- package/mapping/BuildingComponentSublayerExtension.js +1 -1
- package/mapping/CSVLayerExtension.js +1 -1
- package/mapping/FeatureLayerExtension.js +1 -1
- package/mapping/FeatureLayerExtensionBase.js +1 -1
- package/mapping/GeoJSONLayerExtension.js +1 -1
- package/mapping/GeoRSSLayerExtension.js +1 -1
- package/mapping/GraphicsLayerExtension.js +1 -1
- package/mapping/GroundExtension.js +1 -1
- package/mapping/GroupLayerExtension.js +1 -1
- package/mapping/ImageryLayerExtension.js +1 -1
- package/mapping/KMLLayerExtension.js +1 -1
- package/mapping/MapExtension.d.ts +1 -1
- package/mapping/MapExtension.js +1 -1
- package/mapping/MapNotesSublayerExtension.js +1 -1
- package/mapping/PointCloudLayerExtension.js +1 -1
- package/mapping/RouteLayerExtension.js +1 -1
- package/mapping/SceneLayerExtension.js +1 -1
- package/mapping/StreamLayerExtension.js +1 -1
- package/mapping/SubtypeGroupLayerExtension.js +1 -1
- package/mapping/SubtypeSublayerExtension.js +1 -1
- package/mapping/WFSLayerExtension.js +1 -1
- package/mapping/WMTSLayerExtension.js +1 -1
- package/mapping/_LayerExtension.js +1 -1
- package/mapping/_SublayerExtension.d.ts +1 -1
- package/mapping/_SublayerExtension.js +1 -1
- package/mapping/support/ArrayWrappedCollection.d.ts +3 -3
- package/mapping/support/ArrayWrappedCollection.js +1 -1
- package/mapping/support/LayerListSettings.d.ts +3 -1
- package/mapping/support/LayerListSettings.js +1 -1
- package/mapping/support/PopupTemplateFeatureSettings.js +1 -1
- package/mapping/support/_LayerExtensionCollection.d.ts +19 -4
- package/mapping/support/_LayerExtensionCollection.js +1 -1
- package/mapping/support/_SublayerExtensionCollection.d.ts +19 -4
- package/mapping/support/_SublayerExtensionCollection.js +1 -1
- package/package.json +1 -1
- package/portal/BuildingSceneLayer.js +1 -1
- package/portal/SubtypeGroupLayer.js +1 -1
- package/portal/WMSLayer.js +1 -1
- package/support/InitializableBase.d.ts +12 -3
- package/support/InitializableBase.js +1 -1
- package/support/InitializeError.js +1 -1
- package/support/Observable.d.ts +164 -14
- package/support/Observable.js +1 -1
- package/support/Serializable.d.ts +40 -3
- package/support/Serializable.js +1 -1
- package/support/Settings.d.ts +6 -7
- package/support/Settings.js +1 -1
- package/support/esri.d.ts +6 -52
- package/support/observableUtils.d.ts +560 -0
- package/support/observableUtils.js +1 -0
- package/tasks/geocoding/ArcGISGeocoder.js +1 -1
- package/tasks/query/ClientSideQueryProvider.js +1 -1
- package/utilities/CollectionProxy.d.ts +54 -23
- package/utilities/CollectionProxy.js +1 -1
- package/utilities/MapTransformCollection.js +1 -1
- package/utilities/ObservableMap.d.ts +35 -4
- package/utilities/ObservableMap.js +1 -1
- package/utilities/ObservableSet.d.ts +44 -3
- package/utilities/ObservableSet.js +1 -1
- package/utilities/ObservableWeakSet.d.ts +3 -0
- package/utilities/ReadOnlyMap.d.ts +15 -2
- package/utilities/ReadOnlyMap.js +1 -1
- package/utilities/collection.d.ts +9 -0
- package/utilities/collection.js +1 -1
- package/utilities/watch.d.ts +25 -7
- package/utilities/watch.js +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/docs/html/interfaces/support_esri.AccessorLike.html +0 -29
- package/docs/html/types/support_esri.WatchCallback.html +0 -3
|
@@ -1,12 +1,32 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Serializable | @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_Serializable.html">support/Serializable</a></li><li><a href="support_Serializable.Serializable.html">Serializable</a></li></ul><h1>Interface Serializable<TProperties></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An object that can be serialized to/from plain JSON.</p>
|
|
2
|
-
</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">Serializable</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#assignProperties.assignProperties-1">assignProperties</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">properties</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><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><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#assignPropertiesAsync.assignPropertiesAsync-1">assignPropertiesAsync</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">properties</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</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-call-signature" href="support_Serializable.Serializable.html#finishAssignProperties.finishAssignProperties-1">finishAssignProperties</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</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-call-signature" href="support_Serializable.Serializable.html#getDefault.getDefault-1">getDefault</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#getDefault.getDefault-1.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#getDefault.getDefault-1.K">K</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#getDefault.getDefault-1.K">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#getDefaults.getDefaults-1">getDefaults</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#getSerializableProperties.getSerializableProperties-1">getSerializableProperties</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serializeMode</span><span class="tsd-signature-symbol">?: </span><a href="../types/support_Serializable.SerializeMode.html" class="tsd-signature-type tsd-kind-type-alias">SerializeMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/support_Serializable.PropertyDefs.html" class="tsd-signature-type tsd-kind-type-alias">PropertyDefs</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#toJSON.toJSON-1">toJSON</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serializeMode</span><span class="tsd-signature-symbol">?: </span><a href="../types/support_Serializable.SerializeMode.html" class="tsd-signature-type tsd-kind-type-alias">SerializeMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="TProperties" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TProperties</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#support/Serializable.Serializable">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">Serializable</span><ul class="tsd-hierarchy"><li><a href="data__Relationship.Relationship-1.html" class="tsd-signature-type tsd-kind-interface">Relationship</a></li></ul></li></ul></section><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/data_FeatureList.FeatureList.html" class="tsd-signature-type tsd-kind-class">FeatureList</a></li><li><a href="../classes/data_FeatureSet.FeatureSet.html" class="tsd-signature-type tsd-kind-class">FeatureSet</a></li><li><a href="../classes/support_Serializable.SerializableBase.html" class="tsd-signature-type tsd-kind-class">SerializableBase</a></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">Methods</h3><div class="tsd-index-list"><a href="support_Serializable.Serializable.html#assignProperties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assign<wbr/>Properties</span></a>
|
|
2
|
+
</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">Serializable</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#_watchProperty._watchProperty-1">_watchProperty</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">keyof </span><a href="support_Serializable.Serializable.html" class="tsd-signature-type tsd-kind-interface">Serializable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span>, <span class="tsd-kind-parameter">subpath</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">: </span><a href="../types/utilities_watch.WatchCallback.html" class="tsd-signature-type tsd-kind-type-alias">WatchCallback</a>, <span class="tsd-kind-parameter">sync</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IHandle</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#assignProperties.assignProperties-1">assignProperties</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">properties</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><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><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#assignPropertiesAsync.assignPropertiesAsync-1">assignPropertiesAsync</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">properties</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</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-call-signature" href="support_Serializable.Serializable.html#finishAssignProperties.finishAssignProperties-1">finishAssignProperties</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</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-call-signature" href="support_Serializable.Serializable.html#get.get-1">get</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#get.get-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyPath</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><a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#get.get-1.T">T</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#get.get-2">get</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyPath</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#getDefault.getDefault-1">getDefault</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#getDefault.getDefault-1.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#getDefault.getDefault-1.K">K</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#getDefault.getDefault-1.K">K</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#getDefaults.getDefaults-1">getDefaults</a><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#getSerializableProperties.getSerializableProperties-1">getSerializableProperties</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serializeMode</span><span class="tsd-signature-symbol">?: </span><a href="../types/support_Serializable.SerializeMode.html" class="tsd-signature-type tsd-kind-type-alias">SerializeMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/support_Serializable.PropertyDefs.html" class="tsd-signature-type tsd-kind-type-alias">PropertyDefs</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#notifyChange.notifyChange-1">notifyChange</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyKey</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">keyof </span><a href="support_Serializable.Serializable.html" class="tsd-signature-type tsd-kind-interface">Serializable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><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><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#set.set-1">set</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#set.set-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyPath</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#set.set-1.T-1">T</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#set.set-2">set</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">properties</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">HashMap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#toJSON.toJSON-1">toJSON</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serializeMode</span><span class="tsd-signature-symbol">?: </span><a href="../types/support_Serializable.SerializeMode.html" class="tsd-signature-type tsd-kind-type-alias">SerializeMode</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_Serializable.Serializable.html#watch.watch-1">watch</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</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-kind-parameter">callback</span><span class="tsd-signature-symbol">: </span><a href="../types/utilities_watch.WatchCallback.html" class="tsd-signature-type tsd-kind-type-alias">WatchCallback</a>, <span class="tsd-kind-parameter">sync</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IHandle</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="TProperties" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TProperties</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#support/Serializable.Serializable">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="support_Observable.IDeprecatedObservable.html" class="tsd-signature-type tsd-kind-interface">IDeprecatedObservable</a><ul class="tsd-hierarchy"><li><span class="target">Serializable</span><ul class="tsd-hierarchy"><li><a href="data__Relationship.Relationship-1.html" class="tsd-signature-type tsd-kind-interface">Relationship</a></li></ul></li></ul></li></ul></section><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/data_FeatureList.FeatureList.html" class="tsd-signature-type tsd-kind-class">FeatureList</a></li><li><a href="../classes/data_FeatureSet.FeatureSet.html" class="tsd-signature-type tsd-kind-class">FeatureSet</a></li><li><a href="../classes/support_Serializable.SerializableBase.html" class="tsd-signature-type tsd-kind-class">SerializableBase</a></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">Methods</h3><div class="tsd-index-list"><a href="support_Serializable.Serializable.html#_watchProperty" class="tsd-index-link deprecated tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_watch<wbr/>Property</span></a>
|
|
3
|
+
<a href="support_Serializable.Serializable.html#assignProperties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assign<wbr/>Properties</span></a>
|
|
3
4
|
<a href="support_Serializable.Serializable.html#assignPropertiesAsync" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assign<wbr/>Properties<wbr/>Async</span></a>
|
|
4
5
|
<a href="support_Serializable.Serializable.html#finishAssignProperties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>finish<wbr/>Assign<wbr/>Properties</span></a>
|
|
6
|
+
<a href="support_Serializable.Serializable.html#get" class="tsd-index-link deprecated tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a>
|
|
5
7
|
<a href="support_Serializable.Serializable.html#getDefault" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default</span></a>
|
|
6
8
|
<a href="support_Serializable.Serializable.html#getDefaults" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Defaults</span></a>
|
|
7
9
|
<a href="support_Serializable.Serializable.html#getSerializableProperties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Serializable<wbr/>Properties</span></a>
|
|
10
|
+
<a href="support_Serializable.Serializable.html#notifyChange" class="tsd-index-link deprecated tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>notify<wbr/>Change</span></a>
|
|
11
|
+
<a href="support_Serializable.Serializable.html#set" class="tsd-index-link deprecated tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a>
|
|
8
12
|
<a href="support_Serializable.Serializable.html#toJSON" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a>
|
|
9
|
-
|
|
13
|
+
<a href="support_Serializable.Serializable.html#watch" class="tsd-index-link deprecated tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>watch</span></a>
|
|
14
|
+
</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-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="_watchProperty" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">_watch<wbr/>Property</span><a href="#_watchProperty" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="_watchProperty._watchProperty-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">_watch<wbr/>Property</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyKey</span>, <span class="tsd-kind-parameter">subpath</span>, <span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">sync</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IHandle</span><a href="#_watchProperty._watchProperty-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Implements the watch() behavior for a single property. Subclasses that
|
|
15
|
+
need specialized watch handling should generally override this function
|
|
16
|
+
instead of watch(), which will automatically take care of handling
|
|
17
|
+
multiple properties and nesting.</p>
|
|
18
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">propertyKey</span>: <span class="tsd-signature-keyword">keyof </span><a href="support_Serializable.Serializable.html" class="tsd-signature-type tsd-kind-interface">Serializable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The root of the property path, e.g. "foo" in
|
|
19
|
+
"foo.bar.baz" or "foo".</p>
|
|
20
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">subpath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The remainder of the property path, e.g. "bar.baz" in
|
|
21
|
+
"foo.bar.baz" or "" in "foo". The implementation of watch() takes care
|
|
22
|
+
of monitoring the subpath for changes.</p>
|
|
23
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../types/utilities_watch.WatchCallback.html" class="tsd-signature-type tsd-kind-type-alias">WatchCallback</a></span><div class="tsd-comment tsd-typography"><p>The callback to invoke.</p>
|
|
24
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">sync</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If true, the callback will be invoked synchronously on the
|
|
25
|
+
same tick that the property changed. Otherwise, it will be invoked in a
|
|
26
|
+
future tick.</p>
|
|
27
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IHandle</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated" class="tsd-anchor"></a>Deprecated<a href="#Deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>See <a href="../functions/support_observableUtils.observable-1.html" class="tsd-kind-function">support/observableUtils!observable</a> and
|
|
28
|
+
<a href="../functions/support_observableUtils.watch.html" class="tsd-kind-function">support/observableUtils!watch</a> instead.</p>
|
|
29
|
+
</div></div><aside class="tsd-sources"><p>Inherited from <a href="support_Observable.IDeprecatedObservable.html">IDeprecatedObservable</a>.<a href="support_Observable.IDeprecatedObservable.html#_watchProperty">_watchProperty</a></p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="assignProperties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>assign<wbr/>Properties</span><a href="#assignProperties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assignProperties.assignProperties-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">assign<wbr/>Properties</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">properties</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#assignProperties.assignProperties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the properties for this item.</p>
|
|
10
30
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">properties</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>A plain object containing property values to set, keyed
|
|
11
31
|
by property name.</p>
|
|
12
32
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="assignPropertiesAsync" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>assign<wbr/>Properties<wbr/>Async</span><a href="#assignPropertiesAsync" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="assignPropertiesAsync.assignPropertiesAsync-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">assign<wbr/>Properties<wbr/>Async</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">properties</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#assignPropertiesAsync.assignPropertiesAsync-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the properties for this item.</p>
|
|
@@ -17,14 +37,49 @@ by property name.</p>
|
|
|
17
37
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="finishAssignProperties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>finish<wbr/>Assign<wbr/>Properties</span><a href="#finishAssignProperties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="finishAssignProperties.finishAssignProperties-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">finish<wbr/>Assign<wbr/>Properties</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#finishAssignProperties.finishAssignProperties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Waits for all deserialization logic initiated thus far to finish, whether
|
|
18
38
|
invoked by passing properties into the constructor, or by invoking
|
|
19
39
|
<code>assignProperties()</code> or <code>assignPropertiesAsync()</code>.</p>
|
|
20
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="
|
|
40
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="get" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">get</span><a href="#get" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="get.get-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#get.get-1.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#get.get-1.T">T</a><a href="#get.get-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the value of a property.</p>
|
|
41
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="get.get-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">propertyPath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the property to get. It can also be a
|
|
42
|
+
path to a property deeper in the instance, for example "foo.bar.baz".
|
|
43
|
+
If a property in the path doesn't exist, then the result will be
|
|
44
|
+
undefined.</p>
|
|
45
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#get.get-1.T">T</a></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This function is deprecated. Access the property directly.</p>
|
|
46
|
+
</div></div><aside class="tsd-sources"><p>Inherited from <a href="support_Observable.IDeprecatedObservable.html">IDeprecatedObservable</a>.<a href="support_Observable.IDeprecatedObservable.html#get">get</a></p></aside></li><li class="tsd-signature tsd-anchor-link"><a id="get.get-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyPath</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#get.get-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the value of a property.</p>
|
|
47
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">propertyPath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the property to get. It can also be a
|
|
48
|
+
path to a property deeper in the instance, for example "foo.bar.baz".
|
|
49
|
+
If a property in the path doesn't exist, then the result will be
|
|
50
|
+
undefined.</p>
|
|
51
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This function is deprecated. Access the property directly.</p>
|
|
52
|
+
</div></div><aside class="tsd-sources"><p>Inherited from <a href="support_Observable.IDeprecatedObservable.html">IDeprecatedObservable</a>.<a href="support_Observable.IDeprecatedObservable.html#get">get</a></p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getDefault" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Default</span><a href="#getDefault" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDefault.getDefault-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Default</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#getDefault.getDefault-1.K">K</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">key</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#getDefault.getDefault-1.K">K</a><span class="tsd-signature-symbol">]</span><a href="#getDefault.getDefault-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the default value of an object's property.</p>
|
|
21
53
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="getDefault.getDefault-1.K" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">K</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">key</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#getDefault.getDefault-1.K">K</a></span><div class="tsd-comment tsd-typography"><p>The property of the object for which to get the default value.</p>
|
|
22
54
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">[</span><a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#getDefault.getDefault-1.K">K</a><span class="tsd-signature-symbol">]</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getDefaults" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Defaults</span><a href="#getDefaults" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getDefaults.getDefaults-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Defaults</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><a href="#getDefaults.getDefaults-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the object's default property values.</p>
|
|
23
55
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getSerializableProperties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Serializable<wbr/>Properties</span><a href="#getSerializableProperties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getSerializableProperties.getSerializableProperties-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Serializable<wbr/>Properties</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serializeMode</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../types/support_Serializable.PropertyDefs.html" class="tsd-signature-type tsd-kind-type-alias">PropertyDefs</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><a href="#getSerializableProperties.getSerializableProperties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the serializable properties.</p>
|
|
24
56
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">serializeMode</span>: <a href="../types/support_Serializable.SerializeMode.html" class="tsd-signature-type tsd-kind-type-alias">SerializeMode</a></span><div class="tsd-comment tsd-typography"><p>Optional. If specified, only properties that support
|
|
25
57
|
the given serialization mode will be returned.</p>
|
|
26
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/support_Serializable.PropertyDefs.html" class="tsd-signature-type tsd-kind-type-alias">PropertyDefs</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="
|
|
58
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/support_Serializable.PropertyDefs.html" class="tsd-signature-type tsd-kind-type-alias">PropertyDefs</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="notifyChange" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">notify<wbr/>Change</span><a href="#notifyChange" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="notifyChange.notifyChange-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">notify<wbr/>Change</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyKey</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#notifyChange.notifyChange-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Indicates that the given property might have changed, causing observers
|
|
59
|
+
to be notified if it did.</p>
|
|
60
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">propertyKey</span>: <span class="tsd-signature-keyword">keyof </span><a href="support_Serializable.Serializable.html" class="tsd-signature-type tsd-kind-interface">Serializable</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The property that changed (or might have changed).</p>
|
|
61
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-3" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>See <a href="../functions/support_observableUtils.observable-1.html" class="tsd-kind-function">support/observableUtils!observable</a> and
|
|
62
|
+
<a href="../functions/support_observableUtils.notifyChange.html" class="tsd-kind-function">support/observableUtils!notifyChange</a> instead.</p>
|
|
63
|
+
</div></div><aside class="tsd-sources"><p>Inherited from <a href="support_Observable.IDeprecatedObservable.html">IDeprecatedObservable</a>.<a href="support_Observable.IDeprecatedObservable.html#notifyChange">notifyChange</a></p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="set" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="set.set-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#set.set-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyPath</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#set.set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the value of a property.</p>
|
|
64
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="set.set-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">propertyPath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the property to set. It can also be a
|
|
65
|
+
path to a property deeper in the instance, for example "foo.bar.baz".
|
|
66
|
+
If a property along the way doesn't exist, then nothing will be set.</p>
|
|
67
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="data__Relationship.Relationship-1.html#set.set-1.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The new value to set on the property.</p>
|
|
68
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-4" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This function is deprecated. Access the property directly.</p>
|
|
69
|
+
</div></div><aside class="tsd-sources"><p>Inherited from <a href="support_Observable.IDeprecatedObservable.html">IDeprecatedObservable</a>.<a href="support_Observable.IDeprecatedObservable.html#set">set</a></p></aside></li><li class="tsd-signature tsd-anchor-link"><a id="set.set-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">properties</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#set.set-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the values of one or more properties.</p>
|
|
70
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">properties</span>: <span class="tsd-signature-type">HashMap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An object containing key/value pairs of properties to
|
|
71
|
+
set.</p>
|
|
72
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-5" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This function is deprecated. Access the property directly.</p>
|
|
73
|
+
</div></div><aside class="tsd-sources"><p>Inherited from <a href="support_Observable.IDeprecatedObservable.html">IDeprecatedObservable</a>.<a href="support_Observable.IDeprecatedObservable.html#set">set</a></p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toJSON" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>toJSON</span><a href="#toJSON" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toJSON.toJSON-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">toJSON</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">serializeMode</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span><a href="#toJSON.toJSON-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns a serializable representation of the item.</p>
|
|
27
74
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">serializeMode</span>: <a href="../types/support_Serializable.SerializeMode.html" class="tsd-signature-type tsd-kind-type-alias">SerializeMode</a></span><div class="tsd-comment tsd-typography"><p>If specified, only properties that are appropriate
|
|
28
75
|
for the given mode are returned. Otherwise, all properties will be
|
|
29
76
|
serialized.</p>
|
|
30
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section
|
|
77
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_Serializable.Serializable.html#TProperties">TProperties</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="watch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="deprecated">watch</span><a href="#watch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="watch.watch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">watch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">sync</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IHandle</span><a href="#watch.watch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Watches for property changes.</p>
|
|
78
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</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><div class="tsd-comment tsd-typography"><p>The property (or list of properties) to watch for changes.</p>
|
|
79
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../types/utilities_watch.WatchCallback.html" class="tsd-signature-type tsd-kind-type-alias">WatchCallback</a></span><div class="tsd-comment tsd-typography"><p>The callback to invoke when the property has changed.
|
|
80
|
+
This callback will always be invoked <em>asynchronously</em>.</p>
|
|
81
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">sync</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether to invoke the callback synchronously. The default is
|
|
82
|
+
false.</p>
|
|
83
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IHandle</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-Deprecated"><h4 class="tsd-anchor-link"><a id="Deprecated-6" class="tsd-anchor"></a>Deprecated<a href="#Deprecated-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>See <a href="../functions/support_observableUtils.observable-1.html" class="tsd-kind-function">support/observableUtils!observable</a> and
|
|
84
|
+
<a href="../functions/support_observableUtils.watch.html" class="tsd-kind-function">support/observableUtils!watch</a> instead.</p>
|
|
85
|
+
</div></div><aside class="tsd-sources"><p>Inherited from <a href="support_Observable.IDeprecatedObservable.html">IDeprecatedObservable</a>.<a href="support_Observable.IDeprecatedObservable.html#watch">watch</a></p></aside></li></ul></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-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#_watchProperty" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>_watch<wbr/>Property</span></a><a href="#assignProperties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assign<wbr/>Properties</span></a><a href="#assignPropertiesAsync" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>assign<wbr/>Properties<wbr/>Async</span></a><a href="#finishAssignProperties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>finish<wbr/>Assign<wbr/>Properties</span></a><a href="#get" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#getDefault" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Default</span></a><a href="#getDefaults" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Defaults</span></a><a href="#getSerializableProperties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Serializable<wbr/>Properties</span></a><a href="#notifyChange" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>notify<wbr/>Change</span></a><a href="#set" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#toJSON" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>toJSON</span></a><a href="#watch" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>watch</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,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SublayerLike | @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_esri.html">support/esri</a></li><li><a href="support_esri.SublayerLike.html">SublayerLike</a></li></ul><h1>Interface SublayerLike</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Base interface for Esri sublayer classes.</p>
|
|
2
|
-
</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">SublayerLike</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#id">id</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">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#layer">layer</a><span class="tsd-signature-symbol">: </span><a href="support_esri.LayerWithSublayers.html" class="tsd-signature-type tsd-kind-interface">LayerWithSublayers</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#listMode">listMode</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"show"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hide"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hide-children"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#maxScale">maxScale</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="support_esri.SublayerLike.html#minScale">minScale</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="support_esri.SublayerLike.html#opacity">opacity</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="support_esri.SublayerLike.html#sublayers">sublayers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Collection</span><span class="tsd-signature-symbol"><</span><a href="support_esri.SublayerLike.html" class="tsd-signature-type tsd-kind-interface">SublayerLike</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#title">title</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="support_esri.SublayerLike.html#visible">visible</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-call-signature" href="support_esri.SublayerLike.html#clone.clone-1">clone</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="support_esri.SublayerLike.html" class="tsd-signature-type tsd-kind-interface">SublayerLike</a><span class="tsd-signature-symbol">; </span><br/><span
|
|
2
|
+
</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">SublayerLike</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#id">id</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">number</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#layer">layer</a><span class="tsd-signature-symbol">: </span><a href="support_esri.LayerWithSublayers.html" class="tsd-signature-type tsd-kind-interface">LayerWithSublayers</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#listMode">listMode</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"show"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hide"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hide-children"</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#maxScale">maxScale</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="support_esri.SublayerLike.html#minScale">minScale</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="support_esri.SublayerLike.html#opacity">opacity</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="support_esri.SublayerLike.html#sublayers">sublayers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Collection</span><span class="tsd-signature-symbol"><</span><a href="support_esri.SublayerLike.html" class="tsd-signature-type tsd-kind-interface">SublayerLike</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="support_esri.SublayerLike.html#title">title</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="support_esri.SublayerLike.html#visible">visible</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-call-signature" href="support_esri.SublayerLike.html#clone.clone-1">clone</a><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="support_esri.SublayerLike.html" class="tsd-signature-type tsd-kind-interface">SublayerLike</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">Accessor</span><ul class="tsd-hierarchy"><li><span class="target">SublayerLike</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="support_esri.SublayerLike.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id?</span></a>
|
|
3
3
|
<a href="support_esri.SublayerLike.html#layer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>layer</span></a>
|
|
4
4
|
<a href="support_esri.SublayerLike.html#listMode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list<wbr/>Mode?</span></a>
|
|
5
5
|
<a href="support_esri.SublayerLike.html#maxScale" 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/>Scale?</span></a>
|
|
@@ -9,9 +9,6 @@
|
|
|
9
9
|
<a href="support_esri.SublayerLike.html#title" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title</span></a>
|
|
10
10
|
<a href="support_esri.SublayerLike.html#visible" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>visible?</span></a>
|
|
11
11
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="support_esri.SublayerLike.html#clone" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone?</span></a>
|
|
12
|
-
<a href="support_esri.SublayerLike.html#get" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a>
|
|
13
|
-
<a href="support_esri.SublayerLike.html#set" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a>
|
|
14
|
-
<a href="support_esri.SublayerLike.html#watch" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>watch</span></a>
|
|
15
12
|
</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="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>id</span><a href="#id" 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">id</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">number</span></div><div class="tsd-comment tsd-typography"><p>The unique ID for the sublayer.</p>
|
|
16
13
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="layer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>layer</span><a href="#layer" 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">layer</span><span class="tsd-signature-symbol">:</span> <a href="support_esri.LayerWithSublayers.html" class="tsd-signature-type tsd-kind-interface">LayerWithSublayers</a></div><div class="tsd-comment tsd-typography"><p>The parent Layer object.</p>
|
|
17
14
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="listMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>list<wbr/>Mode</span><a href="#listMode" 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">list<wbr/>Mode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"show"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hide"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"hide-children"</span></div><div class="tsd-comment tsd-typography"><p>Controls the visibility of the sublayer in the layer list.</p>
|
|
@@ -23,28 +20,4 @@
|
|
|
23
20
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="title" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>title</span><a href="#title" 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">title</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The human readable title of the sublayer.</p>
|
|
24
21
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="visible" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>visible</span><a href="#visible" 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">visible</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the sublayer is visible.</p>
|
|
25
22
|
</div><div class="tsd-comment tsd-typography"></div></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="clone" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>clone</span><a href="#clone" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="clone.clone-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clone</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="support_esri.SublayerLike.html" class="tsd-signature-type tsd-kind-interface">SublayerLike</a><a href="#clone.clone-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a copy of the sublayer object.</p>
|
|
26
|
-
</div><h4 class="tsd-returns-title">Returns <a href="support_esri.SublayerLike.html" class="tsd-signature-type tsd-kind-interface">SublayerLike</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><
|
|
27
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="get.get-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">unknown</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">propertyPath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the property to get. It can also be a
|
|
28
|
-
path to a property deeper in the instance, for example "foo.bar.baz".
|
|
29
|
-
If a property in the path doesn't exist, then the result will be
|
|
30
|
-
undefined.</p>
|
|
31
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="support_esri.AccessorLike.html#get.get-1.T">T</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="support_esri.AccessorLike.html">AccessorLike</a>.<a href="support_esri.AccessorLike.html#get">get</a></p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="set" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="set.set-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="support_esri.SublayerLike.html#set.set-1.T-1">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">propertyPath</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#set.set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the value of a property denoted by the given path.</p>
|
|
32
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="set.set-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">propertyPath</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the property to set. It can also be a
|
|
33
|
-
path to a property deeper in the instance, for example "foo.bar.baz".
|
|
34
|
-
If a property along the way doesn't exist, then nothing will be set.</p>
|
|
35
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="support_esri.AccessorLike.html#set.set-1.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The value to set.</p>
|
|
36
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="support_esri.AccessorLike.html">AccessorLike</a>.<a href="support_esri.AccessorLike.html#set">set</a></p></aside></li><li class="tsd-signature tsd-anchor-link"><a id="set.set-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">props</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">this</span><a href="#set.set-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the values of several properties.</p>
|
|
37
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">props</span>: <span class="tsd-signature-type">HashMap</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>On object with key/value pairs denoting the paths and values
|
|
38
|
-
to set.</p>
|
|
39
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">this</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="support_esri.AccessorLike.html">AccessorLike</a>.<a href="support_esri.AccessorLike.html#set">set</a></p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="watch" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>watch</span><a href="#watch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="watch.watch-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">watch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">callback</span>, <span class="tsd-kind-parameter">sync</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IHandle</span><a href="#watch.watch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Watches a property for changes.</p>
|
|
40
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">path</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><div class="tsd-comment tsd-typography"><p>The property path to watch, which can be the name of a
|
|
41
|
-
property, or a path like "a.b.c" that will be traversed. In the latter
|
|
42
|
-
case the watch handler will be invoked any time that any of the
|
|
43
|
-
intermediate properties change.</p>
|
|
44
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <a href="../types/support_esri.WatchCallback.html" class="tsd-signature-type tsd-kind-type-alias">WatchCallback</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The callback to invoke when the property changes.</p>
|
|
45
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">sync</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Whether to invoke the callback synchronously. The default is
|
|
46
|
-
<code>false</code> (will be invoked on a future tick from the one that changed the
|
|
47
|
-
value). Async generally performs better as the callback is only invoked
|
|
48
|
-
once for the final value if the property is changed multiple times in a
|
|
49
|
-
tick.</p>
|
|
50
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">IHandle</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="support_esri.AccessorLike.html">AccessorLike</a>.<a href="support_esri.AccessorLike.html#watch">watch</a></p></aside></li></ul></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="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#layer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>layer</span></a><a href="#listMode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list<wbr/>Mode</span></a><a href="#maxScale" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Scale</span></a><a href="#minScale" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Scale</span></a><a href="#opacity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity</span></a><a href="#sublayers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sublayers</span></a><a href="#title" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title</span></a><a href="#visible" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>visible</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#clone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</span></a><a href="#get" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get</span></a><a href="#set" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#watch" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>watch</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>
|
|
23
|
+
</div><h4 class="tsd-returns-title">Returns <a href="support_esri.SublayerLike.html" class="tsd-signature-type tsd-kind-interface">SublayerLike</a></h4><div class="tsd-comment tsd-typography"></div></li></ul></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="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#layer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>layer</span></a><a href="#listMode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list<wbr/>Mode</span></a><a href="#maxScale" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>max<wbr/>Scale</span></a><a href="#minScale" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>min<wbr/>Scale</span></a><a href="#opacity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>opacity</span></a><a href="#sublayers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>sublayers</span></a><a href="#title" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title</span></a><a href="#visible" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>visible</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#clone" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clone</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>
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IHandle | @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_observableUtils.html">support/observableUtils</a></li><li><a href="support_observableUtils.IHandle.html">IHandle</a></li></ul><h1>Interface IHandle</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Returned by <a href="../functions/support_observableUtils.watch.html" class="tsd-kind-function">support/observableUtils!watch</a>.</p>
|
|
2
|
+
<p>Call <code>remove</code> to stop watching.</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">IHandle</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-call-signature" href="support_observableUtils.IHandle.html#remove.remove-1">remove</a><span class="tsd-signature-symbol">(</span><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><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">Methods</h3><div class="tsd-index-list"><a href="support_observableUtils.IHandle.html#remove" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove</span></a>
|
|
4
|
+
</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-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="remove" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove</span><a href="#remove" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="remove.remove-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#remove.remove-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stops watching the property.</p>
|
|
5
|
+
<p>Any pending asynchronous callbacks (watch options used <code>sync: false</code>)
|
|
6
|
+
that have not yet been invoked will also be stopped and not invoked. This
|
|
7
|
+
includes the callback invoked with the initial value (watch options used
|
|
8
|
+
<code>initial: true</code>).</p>
|
|
9
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></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-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#remove" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove</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>
|