@@ -956,6 +972,12 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
• status: WebLinkStatus
Inherited from
CatalogEntity.status
+
+apiVersion
+▪ Static Readonly apiVersion: "entity.k8slens.dev/v1alpha1"
+
+kind
+▪ Static Readonly kind: "WebLink"
Methods
getId
▸ getId(): string
diff --git a/master/extensions/api/classes/Main.Ipc/index.html b/master/extensions/api/classes/Main.Ipc/index.html
index 010662d6a5..2116238122 100644
--- a/master/extensions/api/classes/Main.Ipc/index.html
+++ b/master/extensions/api/classes/Main.Ipc/index.html
@@ -904,7 +904,7 @@
[IpcPrefix]
• Readonly [IpcPrefix]: string
Inherited from
-IpcRegistrar.__@IpcPrefix@43995
+IpcRegistrar.__@IpcPrefix@43997
extension
• Protected extension: LensExtension
diff --git a/master/extensions/api/classes/Main.LensExtension/index.html b/master/extensions/api/classes/Main.LensExtension/index.html
index 0c8dfd2b1b..0868717b31 100644
--- a/master/extensions/api/classes/Main.LensExtension/index.html
+++ b/master/extensions/api/classes/Main.LensExtension/index.html
@@ -1007,7 +1007,7 @@
[Disposers]
• [Disposers]: ExtendableDisposer
Inherited from
-LensExtension.__@Disposers@24553
+LensExtension.__@Disposers@24555
• appMenus: MenuRegistration[] = []
diff --git a/master/extensions/api/classes/Renderer.Ipc/index.html b/master/extensions/api/classes/Renderer.Ipc/index.html
index 530d4cdae0..ebdfb56a4c 100644
--- a/master/extensions/api/classes/Renderer.Ipc/index.html
+++ b/master/extensions/api/classes/Renderer.Ipc/index.html
@@ -904,7 +904,7 @@
[IpcPrefix]
• Readonly [IpcPrefix]: string
Inherited from
-IpcRegistrar.__@IpcPrefix@43995
+IpcRegistrar.__@IpcPrefix@43997
extension
• Protected extension: LensExtension
diff --git a/master/extensions/api/classes/Renderer.LensExtension/index.html b/master/extensions/api/classes/Renderer.LensExtension/index.html
index 84eee948a9..03aff2212a 100644
--- a/master/extensions/api/classes/Renderer.LensExtension/index.html
+++ b/master/extensions/api/classes/Renderer.LensExtension/index.html
@@ -1127,7 +1127,7 @@
[Disposers]
• [Disposers]: ExtendableDisposer
Inherited from
-LensExtension.__@Disposers@24553
+LensExtension.__@Disposers@24555
appPreferences
• appPreferences: AppPreferenceRegistration[] = []
diff --git a/master/search/search_index.json b/master/search/search_index.json
index e784138494..3697c8d4eb 100644
--- a/master/search/search_index.json
+++ b/master/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Lens Extension API # Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens. This documentation describes: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started. What Extensions Can Do # Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API. How to Build Extensions # Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics. What's New # Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release. Keep up with Lens and the Lens Extension API by reviewing the release notes . Important changes since Lens v4 # Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5. Looking for Help # If you have questions for extension development, try asking on the Lens Dev Slack . It's a public chatroom for Lens developers, where Lens team members chime in from time to time. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens . Please use the labels area/documentation and/or area/extension . Downloading Lens # Download Lens for macOS, Windows, or Linux.","title":"Overview"},{"location":"#lens-extension-api","text":"Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features. To install your first extension you should goto the extension page in lens. This documentation describes: How to build, run, test, and publish an extension. How to take full advantage of the Lens Extension API. Where to find guides and code samples to help get you started.","title":"Lens Extension API"},{"location":"#what-extensions-can-do","text":"Here are some examples of what you can achieve with the Extension API: Add custom components & views in the UI - Extending the Lens Workbench For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.","title":"What Extensions Can Do"},{"location":"#how-to-build-extensions","text":"Here is what each section of the Lens Extension API docs can help you with: Getting Started teaches fundamental concepts for building extensions with the Hello World sample. Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics. Extension Guides includes guides and code samples that explain specific usages of Lens Extension API. Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions. API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.","title":"How to Build Extensions"},{"location":"#whats-new","text":"Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release. Keep up with Lens and the Lens Extension API by reviewing the release notes .","title":"What's New"},{"location":"#important-changes-since-lens-v4","text":"Lens has undergone major design improvements in v5, which have resulted in several large changes to the extension API. Workspaces are gone, and the catalog is introduced for containing clusters, as well as other items, including custom entities. Lens has migrated from using mobx 5 to mobx 6 for internal state management, and this may have ramifications for extension implementations. Although the API retains many components from v4, given these changes, extensions written for Lens v4 are not compatible with the Lens v5 extension API. See the Lens v4 to v5 extension migration notes on getting old extensions working in Lens v5.","title":"Important changes since Lens v4"},{"location":"#looking-for-help","text":"If you have questions for extension development, try asking on the Lens Dev Slack . It's a public chatroom for Lens developers, where Lens team members chime in from time to time. To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens . Please use the labels area/documentation and/or area/extension .","title":"Looking for Help"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"extensions/extension-migration/","text":"Lens v4 to v5 Extension Migration Notes # Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( Main and Renderer ) plus those not specific to a process ( Common ). For example the LensMainExtension class is now referred to by Main.LensExtension . See the API Reference for the new organization. The globalPageMenus field of the Renderer extension class (now Renderer.LensExtension ) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu. The clusterFeatures field of the Renderer extension class (now Renderer.LensExtension ) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the lifecycle. It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/extension-migration/#lens-v4-to-v5-extension-migration-notes","text":"Lens v5 inspects the version of the extension to ensure it is compatible. The package.json for your extension must have an \"engines\" field specifying the lens version that your extension is targeted for, e.g: \"engines\": { \"lens\": \"^5.0.0-beta.7\" }, Note that Lens v5 supports all the range semantics that semver provides. Types and components have been reorganized, many have been grouped by process ( Main and Renderer ) plus those not specific to a process ( Common ). For example the LensMainExtension class is now referred to by Main.LensExtension . See the API Reference for the new organization. The globalPageMenus field of the Renderer extension class (now Renderer.LensExtension ) is removed. Global pages can still be made accessible via the application menus and the status bar, as well as from the newly added Welcome menu. The clusterFeatures field of the Renderer extension class (now Renderer.LensExtension ) is removed. Cluster features can still be implemented but Lens no longer dictates how a feature's lifecycle (install/upgrade/uninstall) is managed. Renderer.K8sApi.ResourceStack provides the functionality to input and apply kubernetes resources to a cluster. It is up to the extension developer to manage the lifecycle. It could be applied automatically to a cluster by the extension or the end-user could be expected to install it, etc. from the cluster Settings page. Lens v5 now relies on mobx 6 for state management. Extensions that use mobx will need to be modified to work with mobx 6. See Migrating from Mobx 4/5 for specific details. For an example of an existing extension that is compatible with Lens v5 see the Lens Resource Map Extension","title":"Lens v4 to v5 Extension Migration Notes"},{"location":"extensions/api/","text":"Extension API Reference # APIs # Common Main Renderer","title":"API Reference"},{"location":"extensions/api/#extension-api-reference","text":"","title":"Extension API Reference"},{"location":"extensions/api/#apis","text":"Common Main Renderer","title":"APIs"},{"location":"extensions/api/modules/","text":"@k8slens/extensions # Table of contents # Namespaces # Common Main Renderer","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#k8slensextensions","text":"","title":"@k8slens/extensions"},{"location":"extensions/api/modules/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/modules/#namespaces","text":"Common Main Renderer","title":"Namespaces"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/","text":"Class: CatalogCategory # Common . Catalog .CatalogCategory Hierarchy # TypedEventEmitter < CatalogCategoryEvents , this > \u21b3 CatalogCategory Table of contents # Constructors # constructor Properties # apiVersion filters kind metadata spec Methods # addListener addMenuFilter emit eventNames filteredItems getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId Constructors # constructor # \u2022 new CatalogCategory () Inherited from # (EventEmitter as new () => TypedEmitter).constructor Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string filters # \u2022 Protected filters : ObservableSet < AddMenuFilter > kind # \u2022 Readonly Abstract kind : string metadata # \u2022 Abstract metadata : Object Type declaration # Name Type icon string name string spec # \u2022 Abstract spec : CatalogCategorySpec Methods # addListener # \u25b8 addListener < E >( event , listener ): CatalogCategory Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).addListener addMenuFilter # \u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu Parameters # Name Type Description fn AddMenuFilter The function that should return a truthy value if that menu item should be displayed Returns # Disposer A function to remove that filter emit # \u25b8 emit < E >( event , ... args ): boolean Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E ...args Arguments < CatalogCategoryEvents [ E ]> Returns # boolean Inherited from # (EventEmitter as new () => TypedEmitter).emit eventNames # \u25b8 eventNames (): ( string | symbol )[] Returns # ( string | symbol )[] Inherited from # (EventEmitter as new () => TypedEmitter).eventNames filteredItems # \u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters Parameters # Name Type Description menuItems CatalogEntityAddMenu [] menu items to filter Returns # CatalogEntityAddMenu [] filtered menu items getId # \u25b8 getId (): string Returns # string getMaxListeners # \u25b8 getMaxListeners (): number Returns # number Inherited from # (EventEmitter as new () => TypedEmitter).getMaxListeners listenerCount # \u25b8 listenerCount < E >( event ): number Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E Returns # number Inherited from # (EventEmitter as new () => TypedEmitter).listenerCount listeners # \u25b8 listeners < E >( event ): Function [] Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # (EventEmitter as new () => TypedEmitter).listeners off # \u25b8 off < E >( event , listener ): CatalogCategory Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).off on # \u25b8 on < E >( event , listener ): CatalogCategory Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).on once # \u25b8 once < E >( event , listener ): CatalogCategory Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).once prependListener # \u25b8 prependListener < E >( event , listener ): CatalogCategory Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).prependListener prependOnceListener # \u25b8 prependOnceListener < E >( event , listener ): CatalogCategory Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).prependOnceListener rawListeners # \u25b8 rawListeners < E >( event ): Function [] Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E Returns # Function [] Inherited from # (EventEmitter as new () => TypedEmitter).rawListeners removeAllListeners # \u25b8 removeAllListeners < E >( event? ): CatalogCategory Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event? E Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).removeAllListeners removeListener # \u25b8 removeListener < E >( event , listener ): CatalogCategory Type parameters # Name Type E extends keyof CatalogCategoryEvents Parameters # Name Type event E listener CatalogCategoryEvents [ E ] Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).removeListener setMaxListeners # \u25b8 setMaxListeners ( maxListeners ): CatalogCategory Parameters # Name Type maxListeners number Returns # CatalogCategory Inherited from # (EventEmitter as new () => TypedEmitter).setMaxListeners parseId # \u25b8 Static parseId ( id? ): Object Parameters # Name Type Default value id string \"\" Returns # Object Name Type group? string kind? string","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#class-catalogcategory","text":"Common . Catalog .CatalogCategory","title":"Class: CatalogCategory"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#hierarchy","text":"TypedEventEmitter < CatalogCategoryEvents , this > \u21b3 CatalogCategory","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties","text":"apiVersion filters kind metadata spec","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods","text":"addListener addMenuFilter emit eventNames filteredItems getId getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener setMaxListeners parseId","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#constructor","text":"\u2022 new CatalogCategory ()","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filters","text":"\u2022 Protected filters : ObservableSet < AddMenuFilter >","title":"filters"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#kind","text":"\u2022 Readonly Abstract kind : string","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#metadata","text":"\u2022 Abstract metadata : Object","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#spec","text":"\u2022 Abstract spec : CatalogCategorySpec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#addlistener","text":"\u25b8 addListener < E >( event , listener ): CatalogCategory","title":"addListener"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#addmenufilter","text":"\u25b8 addMenuFilter ( fn ): Disposer Add a filter for menu items of catalogAddMenu","title":"addMenuFilter"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#emit","text":"\u25b8 emit < E >( event , ... args ): boolean","title":"emit"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#eventnames","text":"\u25b8 eventNames (): ( string | symbol )[]","title":"eventNames"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filtereditems","text":"\u25b8 filteredItems ( menuItems ): CatalogEntityAddMenu [] Filter menuItems according to the Category's set filters","title":"filteredItems"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getmaxlisteners","text":"\u25b8 getMaxListeners (): number","title":"getMaxListeners"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#listenercount","text":"\u25b8 listenerCount < E >( event ): number","title":"listenerCount"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#listeners","text":"\u25b8 listeners < E >( event ): Function []","title":"listeners"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#off","text":"\u25b8 off < E >( event , listener ): CatalogCategory","title":"off"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#on","text":"\u25b8 on < E >( event , listener ): CatalogCategory","title":"on"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#once","text":"\u25b8 once < E >( event , listener ): CatalogCategory","title":"once"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#prependlistener","text":"\u25b8 prependListener < E >( event , listener ): CatalogCategory","title":"prependListener"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#prependoncelistener","text":"\u25b8 prependOnceListener < E >( event , listener ): CatalogCategory","title":"prependOnceListener"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#rawlisteners","text":"\u25b8 rawListeners < E >( event ): Function []","title":"rawListeners"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#removealllisteners","text":"\u25b8 removeAllListeners < E >( event? ): CatalogCategory","title":"removeAllListeners"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#removelistener","text":"\u25b8 removeListener < E >( event , listener ): CatalogCategory","title":"removeListener"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#setmaxlisteners","text":"\u25b8 setMaxListeners ( maxListeners ): CatalogCategory","title":"setMaxListeners"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#parseid","text":"\u25b8 Static parseId ( id? ): Object","title":"parseId"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/","text":"Class: CatalogEntity # Common . Catalog .CatalogEntity Type parameters # Name Type Metadata extends CatalogEntityMetadata CatalogEntityMetadata Status extends CatalogEntityStatus CatalogEntityStatus Spec extends CatalogEntitySpec CatalogEntitySpec Hierarchy # CatalogEntity \u21b3 KubernetesCluster \u21b3 GeneralEntity \u21b3 WebLink Implements # CatalogEntityKindData Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new CatalogEntity < Metadata , Status , Spec >( data ) Type parameters # Name Type Metadata extends CatalogEntityMetadata CatalogEntityMetadata Status extends CatalogEntityStatus CatalogEntityStatus Spec extends CatalogEntitySpec CatalogEntitySpec Parameters # Name Type data CatalogEntityData < Metadata , Status , Spec > Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string Implementation of # CatalogEntityKindData . apiVersion kind # \u2022 Readonly Abstract kind : string Implementation of # CatalogEntityKindData . kind metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 status : Status Methods # getId # \u25b8 getId (): string Returns # string getName # \u25b8 getName (): string Returns # string onContextMenuOpen # \u25b8 Abstract onContextMenuOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityContextMenuContext Returns # void | Promise < void > onRun # \u25b8 Optional Abstract onRun ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityActionContext Returns # void | Promise < void > onSettingsOpen # \u25b8 Abstract onSettingsOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise < void >","title":"Class: CatalogEntity"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#class-catalogentitymetadata-status-spec","text":"Common . Catalog .CatalogEntity","title":"Class: CatalogEntity<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#type-parameters","text":"Name Type Metadata extends CatalogEntityMetadata CatalogEntityMetadata Status extends CatalogEntityStatus CatalogEntityStatus Spec extends CatalogEntitySpec CatalogEntitySpec","title":"Type parameters"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#hierarchy","text":"CatalogEntity \u21b3 KubernetesCluster \u21b3 GeneralEntity \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#implements","text":"CatalogEntityKindData","title":"Implements"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods","text":"getId getName onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#constructor","text":"\u2022 new CatalogEntity < Metadata , Status , Spec >( data )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#apiversion","text":"\u2022 Readonly Abstract apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#kind","text":"\u2022 Readonly Abstract kind : string","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#oncontextmenuopen","text":"\u25b8 Abstract onContextMenuOpen ( context ): void | Promise < void >","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onrun","text":"\u25b8 Optional Abstract onRun ( context ): void | Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onsettingsopen","text":"\u25b8 Abstract onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/","text":"Class: GeneralEntity # Common . Catalog .GeneralEntity Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Hierarchy # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > \u21b3 GeneralEntity Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen Constructors # constructor # \u2022 new GeneralEntity ( data ) Parameters # Name Type data CatalogEntityData < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"General\" Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : GeneralEntitySpec Inherited from # CatalogEntity . spec status # \u2022 status : CatalogEntityStatus Inherited from # CatalogEntity . status Methods # getId # \u25b8 getId (): string Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Returns # string Inherited from # CatalogEntity . getName onContextMenuOpen # \u25b8 onContextMenuOpen (): void Returns # void Overrides # CatalogEntity . onContextMenuOpen onDetailsOpen # \u25b8 onDetailsOpen (): void Returns # void onRun # \u25b8 onRun (): Promise < void > Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#class-generalentity","text":"Common . Catalog .GeneralEntity Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > \u21b3 GeneralEntity","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods","text":"getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#constructor","text":"\u2022 new GeneralEntity ( data )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#kind","text":"\u2022 Readonly kind : \"General\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#spec","text":"\u2022 spec : GeneralEntitySpec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#status","text":"\u2022 status : CatalogEntityStatus","title":"status"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen (): void","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#ondetailsopen","text":"\u25b8 onDetailsOpen (): void","title":"onDetailsOpen"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onrun","text":"\u25b8 onRun (): Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/","text":"Class: KubernetesCluster # Common . Catalog .KubernetesCluster Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Hierarchy # CatalogEntity < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > \u21b3 KubernetesCluster Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiVersion kind Methods # connect disconnect getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen Constructors # constructor # \u2022 new KubernetesCluster ( data ) Parameters # Name Type data CatalogEntityData < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"KubernetesCluster\" Overrides # CatalogEntity . kind metadata # \u2022 metadata : KubernetesClusterMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : KubernetesClusterSpec Inherited from # CatalogEntity . spec status # \u2022 status : KubernetesClusterStatus Inherited from # CatalogEntity . status apiVersion # \u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" kind # \u25aa Static Readonly kind : \"KubernetesCluster\" Methods # connect # \u25b8 connect (): Promise < void > Returns # Promise < void > disconnect # \u25b8 disconnect (): Promise < void > Returns # Promise < void > getId # \u25b8 getId (): string Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Returns # string Inherited from # CatalogEntity . getName onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): Promise < void > Parameters # Name Type context CatalogEntityContextMenuContext Returns # Promise < void > Overrides # CatalogEntity . onContextMenuOpen onDetailsOpen # \u25b8 onDetailsOpen (): void Returns # void onRun # \u25b8 onRun ( context ): Promise < void > Parameters # Name Type context CatalogEntityActionContext Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: KubernetesCluster"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#class-kubernetescluster","text":"Common . Catalog .KubernetesCluster Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Class: KubernetesCluster"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#hierarchy","text":"CatalogEntity < KubernetesClusterMetadata , KubernetesClusterStatus , KubernetesClusterSpec > \u21b3 KubernetesCluster","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties","text":"apiVersion kind metadata spec status apiVersion kind","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods","text":"connect disconnect getId getName onContextMenuOpen onDetailsOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#constructor","text":"\u2022 new KubernetesCluster ( data )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind","text":"\u2022 Readonly kind : \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#metadata","text":"\u2022 metadata : KubernetesClusterMetadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#spec","text":"\u2022 spec : KubernetesClusterSpec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#status","text":"\u2022 status : KubernetesClusterStatus","title":"status"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion_1","text":"\u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind_1","text":"\u25aa Static Readonly kind : \"KubernetesCluster\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#connect","text":"\u25b8 connect (): Promise < void >","title":"connect"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#disconnect","text":"\u25b8 disconnect (): Promise < void >","title":"disconnect"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): Promise < void >","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#ondetailsopen","text":"\u25b8 onDetailsOpen (): void","title":"onDetailsOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onrun","text":"\u25b8 onRun ( context ): Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.WebLink/","text":"Class: WebLink # Common . Catalog .WebLink Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Hierarchy # CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new WebLink ( data ) Parameters # Name Type data CatalogEntityData < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"WebLink\" Overrides # CatalogEntity . kind metadata # \u2022 metadata : CatalogEntityMetadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : WebLinkSpec Inherited from # CatalogEntity . spec status # \u2022 status : WebLinkStatus Inherited from # CatalogEntity . status Methods # getId # \u25b8 getId (): string Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Returns # string Inherited from # CatalogEntity . getName onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): Promise < void > Parameters # Name Type context CatalogEntityContextMenuContext Returns # Promise < void > Overrides # CatalogEntity . onContextMenuOpen onRun # \u25b8 onRun (): Promise < void > Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 onSettingsOpen (): void Returns # void Overrides # CatalogEntity . onSettingsOpen","title":"Class: WebLink"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#class-weblink","text":"Common . Catalog .WebLink Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Class: WebLink"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#hierarchy","text":"CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties","text":"apiVersion kind metadata spec status","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods","text":"getId getName onContextMenuOpen onRun onSettingsOpen","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#constructor","text":"\u2022 new WebLink ( data )","title":"constructor"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#apiversion","text":"\u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind","text":"\u2022 Readonly kind : \"WebLink\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#metadata","text":"\u2022 metadata : CatalogEntityMetadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#spec","text":"\u2022 spec : WebLinkSpec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#status","text":"\u2022 status : WebLinkStatus","title":"status"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): Promise < void >","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onrun","text":"\u25b8 onRun (): Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#onsettingsopen","text":"\u25b8 onSettingsOpen (): void","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/","text":"Class: ExtensionStore # Common . Store .ExtensionStore Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Type parameters # Name T Hierarchy # BaseStore < T > \u21b3 ExtensionStore Table of contents # Constructors # constructor Properties # extension params storeConfig syncDisposers Accessors # name path syncMainChannel syncRendererChannel Methods # applyWithoutSync cwd disableSync enableSync fromStore load loadExtension onModelChange onSync onSyncFromMain saveToFile toJSON unregisterIpcListener createInstance getInstance resetInstance Constructors # constructor # \u2022 Protected new ExtensionStore < T >( params ) Type parameters # Name T Parameters # Name Type params BaseStoreParams < T > Inherited from # BaseStore.constructor Properties # extension # \u2022 Protected extension : LensExtension params # \u2022 Protected params : BaseStoreParams < T > Inherited from # BaseStore.params storeConfig # \u2022 Protected Optional storeConfig : Conf < T > Inherited from # BaseStore.storeConfig syncDisposers # \u2022 Protected syncDisposers : Disposer [] = [] Inherited from # BaseStore.syncDisposers Accessors # name # \u2022 get name (): string Returns # string path # \u2022 get path (): string Returns # string syncMainChannel # \u2022 Protected get syncMainChannel (): string Returns # string syncRendererChannel # \u2022 Protected get syncRendererChannel (): string Returns # string Methods # applyWithoutSync # \u25b8 Protected applyWithoutSync ( callback ): void Parameters # Name Type callback () => void Returns # void Inherited from # BaseStore.applyWithoutSync cwd # \u25b8 Protected cwd (): string Returns # string Overrides # BaseStore.cwd disableSync # \u25b8 disableSync (): void Returns # void Inherited from # BaseStore.disableSync enableSync # \u25b8 enableSync (): void Returns # void Inherited from # BaseStore.enableSync fromStore # \u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous. Parameters # Name Type Description data T the parsed information read from the stored JSON file Returns # void Inherited from # BaseStore.fromStore load # \u25b8 load (): void Returns # void Overrides # BaseStore.load loadExtension # \u25b8 loadExtension ( extension ): void Parameters # Name Type extension LensExtension Returns # void onModelChange # \u25b8 Protected onModelChange ( model ): Promise < void > Parameters # Name Type model T Returns # Promise < void > Inherited from # BaseStore.onModelChange onSync # \u25b8 Protected onSync ( model ): void Parameters # Name Type model T Returns # void Inherited from # BaseStore.onSync onSyncFromMain # \u25b8 Protected onSyncFromMain ( model ): void Parameters # Name Type model T Returns # void Inherited from # BaseStore.onSyncFromMain saveToFile # \u25b8 Protected saveToFile ( model ): Promise < void > Parameters # Name Type model T Returns # Promise < void > Inherited from # BaseStore.saveToFile toJSON # \u25b8 Abstract toJSON (): T toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representation of the current state. It is recommended that a round trip is valid. Namely, calling this.fromStore(this.toJSON()) shouldn't change the state. Returns # T Inherited from # BaseStore.toJSON unregisterIpcListener # \u25b8 unregisterIpcListener (): void Returns # void Inherited from # BaseStore.unregisterIpcListener createInstance # \u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # BaseStore.createInstance getInstance # \u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # BaseStore.getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # BaseStore.resetInstance","title":"Class: ExtensionStore"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#class-extensionstoret","text":"Common . Store .ExtensionStore Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Class: ExtensionStore<T>"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#type-parameters","text":"Name T","title":"Type parameters"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#hierarchy","text":"BaseStore < T > \u21b3 ExtensionStore","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties","text":"extension params storeConfig syncDisposers","title":"Properties"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#accessors","text":"name path syncMainChannel syncRendererChannel","title":"Accessors"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods","text":"applyWithoutSync cwd disableSync enableSync fromStore load loadExtension onModelChange onSync onSyncFromMain saveToFile toJSON unregisterIpcListener createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#constructor","text":"\u2022 Protected new ExtensionStore < T >( params )","title":"constructor"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#extension","text":"\u2022 Protected extension : LensExtension","title":"extension"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#params","text":"\u2022 Protected params : BaseStoreParams < T >","title":"params"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#storeconfig","text":"\u2022 Protected Optional storeConfig : Conf < T >","title":"storeConfig"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#syncdisposers","text":"\u2022 Protected syncDisposers : Disposer [] = []","title":"syncDisposers"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#path","text":"\u2022 get path (): string","title":"path"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#syncmainchannel","text":"\u2022 Protected get syncMainChannel (): string","title":"syncMainChannel"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#syncrendererchannel","text":"\u2022 Protected get syncRendererChannel (): string","title":"syncRendererChannel"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#applywithoutsync","text":"\u25b8 Protected applyWithoutSync ( callback ): void","title":"applyWithoutSync"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#cwd","text":"\u25b8 Protected cwd (): string","title":"cwd"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#disablesync","text":"\u25b8 disableSync (): void","title":"disableSync"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#enablesync","text":"\u25b8 enableSync (): void","title":"enableSync"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#fromstore","text":"\u25b8 Protected Abstract fromStore ( data ): void fromStore is called internally when a child class syncs with the file system. Note: This function must be synchronous.","title":"fromStore"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#load","text":"\u25b8 load (): void","title":"load"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#loadextension","text":"\u25b8 loadExtension ( extension ): void","title":"loadExtension"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#onmodelchange","text":"\u25b8 Protected onModelChange ( model ): Promise < void >","title":"onModelChange"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#onsync","text":"\u25b8 Protected onSync ( model ): void","title":"onSync"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#onsyncfrommain","text":"\u25b8 Protected onSyncFromMain ( model ): void","title":"onSyncFromMain"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#savetofile","text":"\u25b8 Protected saveToFile ( model ): Promise < void >","title":"saveToFile"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#tojson","text":"\u25b8 Abstract toJSON (): T toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representation of the current state. It is recommended that a round trip is valid. Namely, calling this.fromStore(this.toJSON()) shouldn't change the state.","title":"toJSON"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#unregisteripclistener","text":"\u25b8 unregisterIpcListener (): void","title":"unregisterIpcListener"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#createinstance","text":"\u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#getinstance","text":"\u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/Common.Util.Singleton/","text":"Class: Singleton # Common . Util .Singleton Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. Hierarchy # Singleton \u21b3 TerminalStore Table of contents # Constructors # constructor Methods # createInstance getInstance resetInstance Constructors # constructor # \u2022 new Singleton () Methods # createInstance # \u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class getInstance # \u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void","title":"Class: Singleton"},{"location":"extensions/api/classes/Common.Util.Singleton/#class-singleton","text":"Common . Util .Singleton Copyright (c) 2021 OpenLens Authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.","title":"Class: Singleton"},{"location":"extensions/api/classes/Common.Util.Singleton/#hierarchy","text":"Singleton \u21b3 TerminalStore","title":"Hierarchy"},{"location":"extensions/api/classes/Common.Util.Singleton/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods","text":"createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Common.Util.Singleton/#constructor","text":"\u2022 new Singleton ()","title":"constructor"},{"location":"extensions/api/classes/Common.Util.Singleton/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Util.Singleton/#createinstance","text":"\u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/Common.Util.Singleton/#getinstance","text":"\u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Common.Util.Singleton/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/Main.Catalog.CatalogEntityRegistry/","text":"Class: CatalogEntityRegistry # Main . Catalog .CatalogEntityRegistry Table of contents # Constructors # constructor Methods # getItemsForApiKind Constructors # constructor # \u2022 new CatalogEntityRegistry () Methods # getItemsForApiKind # \u25b8 getItemsForApiKind < T >( apiVersion , kind ): T [] Type parameters # Name Type T extends CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T > Parameters # Name Type apiVersion string kind string Returns # T []","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/Main.Catalog.CatalogEntityRegistry/#class-catalogentityregistry","text":"Main . Catalog .CatalogEntityRegistry","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/Main.Catalog.CatalogEntityRegistry/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.Catalog.CatalogEntityRegistry/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.Catalog.CatalogEntityRegistry/#methods","text":"getItemsForApiKind","title":"Methods"},{"location":"extensions/api/classes/Main.Catalog.CatalogEntityRegistry/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.Catalog.CatalogEntityRegistry/#constructor","text":"\u2022 new CatalogEntityRegistry ()","title":"constructor"},{"location":"extensions/api/classes/Main.Catalog.CatalogEntityRegistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.Catalog.CatalogEntityRegistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind < T >( apiVersion , kind ): T []","title":"getItemsForApiKind"},{"location":"extensions/api/classes/Main.Ipc/","text":"Class: Ipc # Main .Ipc Hierarchy # IpcRegistrar \u21b3 Ipc Table of contents # Constructors # constructor Properties # [IpcPrefix] extension Methods # broadcast handle listen createInstance getInstance resetInstance Constructors # constructor # \u2022 new Ipc ( extension ) Parameters # Name Type extension LensExtension Overrides # IpcRegistrar.constructor Properties # [IpcPrefix] # \u2022 Readonly [IpcPrefix] : string Inherited from # IpcRegistrar.__@IpcPrefix@43995 extension # \u2022 Protected extension : LensExtension Inherited from # IpcRegistrar.extension Methods # broadcast # \u25b8 broadcast ( channel , ... args ): void Parameters # Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any [] The arguments passed to all listeners Returns # void Inherited from # IpcRegistrar.broadcast handle # \u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled Parameters # Name Type Description channel string The name of the RPC handler ( event : IpcMainInvokeEvent , ... args : any []) => any The remote procedure that is called Returns # void listen # \u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension Parameters # Name Type Description channel string The channel to listen for broadcasts on listener ( event : IpcRendererEvent , ... args : any []) => any The function that will be called with the arguments of the broadcast Returns # Disposer An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called createInstance # \u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # IpcRegistrar.createInstance getInstance # \u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # IpcRegistrar.getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # IpcRegistrar.resetInstance","title":"Class: Ipc"},{"location":"extensions/api/classes/Main.Ipc/#class-ipc","text":"Main .Ipc","title":"Class: Ipc"},{"location":"extensions/api/classes/Main.Ipc/#hierarchy","text":"IpcRegistrar \u21b3 Ipc","title":"Hierarchy"},{"location":"extensions/api/classes/Main.Ipc/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.Ipc/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.Ipc/#properties","text":"[IpcPrefix] extension","title":"Properties"},{"location":"extensions/api/classes/Main.Ipc/#methods","text":"broadcast handle listen createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Main.Ipc/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.Ipc/#constructor","text":"\u2022 new Ipc ( extension )","title":"constructor"},{"location":"extensions/api/classes/Main.Ipc/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.Ipc/#ipcprefix","text":"\u2022 Readonly [IpcPrefix] : string","title":"[IpcPrefix]"},{"location":"extensions/api/classes/Main.Ipc/#extension","text":"\u2022 Protected extension : LensExtension","title":"extension"},{"location":"extensions/api/classes/Main.Ipc/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.Ipc/#broadcast","text":"\u25b8 broadcast ( channel , ... args ): void","title":"broadcast"},{"location":"extensions/api/classes/Main.Ipc/#handle","text":"\u25b8 handle ( channel , handler ): void Declare a RPC over channel . Lens will cleanup when the extension is disabled or uninstalled","title":"handle"},{"location":"extensions/api/classes/Main.Ipc/#listen","text":"\u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension","title":"listen"},{"location":"extensions/api/classes/Main.Ipc/#createinstance","text":"\u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/Main.Ipc/#getinstance","text":"\u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Main.Ipc/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/Main.LensExtension/","text":"Class: LensExtension # Main .LensExtension Hierarchy # LensExtension \u21b3 LensExtension Table of contents # Constructors # constructor Properties # [Disposers] appMenus id isBundled manifest manifestPath protocolHandlers Accessors # description name version Methods # addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource Constructors # constructor # \u2022 new LensExtension ( __namedParameters ) Parameters # Name Type __namedParameters InstalledExtension Inherited from # LensExtension.constructor Properties # [Disposers] # \u2022 [Disposers] : ExtendableDisposer Inherited from # LensExtension.__@Disposers@24553 appMenus # \u2022 appMenus : MenuRegistration [] = [] id # \u2022 Readonly id : string Inherited from # LensExtension.id isBundled # \u2022 Readonly isBundled : boolean Inherited from # LensExtension.isBundled manifest # \u2022 Readonly manifest : LensExtensionManifest Inherited from # LensExtension.manifest manifestPath # \u2022 Readonly manifestPath : string Inherited from # LensExtension.manifestPath protocolHandlers # \u2022 protocolHandlers : ProtocolHandlerRegistration [] = [] Inherited from # LensExtension.protocolHandlers Accessors # description # \u2022 get description (): string Returns # string name # \u2022 get name (): string Returns # string version # \u2022 get version (): string Returns # string Methods # addCatalogSource # \u25b8 addCatalogSource ( id , source ): void Parameters # Name Type id string source IObservableArray < CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> Returns # void disable # \u25b8 disable (): Promise < void > Returns # Promise < void > Inherited from # LensExtension.disable enable # \u25b8 enable ( register ): Promise < void > Parameters # Name Type register ( ext : LensExtension ) => Promise < Disposer []> Returns # Promise < void > Inherited from # LensExtension.enable getExtensionFileFolder # \u25b8 getExtensionFileFolder (): Promise < string > getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension. Note: there is no security done on this folder, only obfuscation of the folder name. Returns # Promise < string > Inherited from # LensExtension.getExtensionFileFolder navigate # \u25b8 navigate ( pageId? , params? , frameId? ): Promise < void > Parameters # Name Type pageId? string params? Record < string , any > frameId? number Returns # Promise < void > onActivate # \u25b8 Protected onActivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension.onActivate onDeactivate # \u25b8 Protected onDeactivate (): void | Promise < void > Returns # void | Promise < void > Inherited from # LensExtension.onDeactivate removeCatalogSource # \u25b8 removeCatalogSource ( id ): void Parameters # Name Type id string Returns # void","title":"Class: LensExtension"},{"location":"extensions/api/classes/Main.LensExtension/#class-lensextension","text":"Main .LensExtension","title":"Class: LensExtension"},{"location":"extensions/api/classes/Main.LensExtension/#hierarchy","text":"LensExtension \u21b3 LensExtension","title":"Hierarchy"},{"location":"extensions/api/classes/Main.LensExtension/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Main.LensExtension/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Main.LensExtension/#properties","text":"[Disposers] appMenus id isBundled manifest manifestPath protocolHandlers","title":"Properties"},{"location":"extensions/api/classes/Main.LensExtension/#accessors","text":"description name version","title":"Accessors"},{"location":"extensions/api/classes/Main.LensExtension/#methods","text":"addCatalogSource disable enable getExtensionFileFolder navigate onActivate onDeactivate removeCatalogSource","title":"Methods"},{"location":"extensions/api/classes/Main.LensExtension/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Main.LensExtension/#constructor","text":"\u2022 new LensExtension ( __namedParameters )","title":"constructor"},{"location":"extensions/api/classes/Main.LensExtension/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Main.LensExtension/#disposers","text":"\u2022 [Disposers] : ExtendableDisposer","title":"[Disposers]"},{"location":"extensions/api/classes/Main.LensExtension/#appmenus","text":"\u2022 appMenus : MenuRegistration [] = []","title":"appMenus"},{"location":"extensions/api/classes/Main.LensExtension/#id","text":"\u2022 Readonly id : string","title":"id"},{"location":"extensions/api/classes/Main.LensExtension/#isbundled","text":"\u2022 Readonly isBundled : boolean","title":"isBundled"},{"location":"extensions/api/classes/Main.LensExtension/#manifest","text":"\u2022 Readonly manifest : LensExtensionManifest","title":"manifest"},{"location":"extensions/api/classes/Main.LensExtension/#manifestpath","text":"\u2022 Readonly manifestPath : string","title":"manifestPath"},{"location":"extensions/api/classes/Main.LensExtension/#protocolhandlers","text":"\u2022 protocolHandlers : ProtocolHandlerRegistration [] = []","title":"protocolHandlers"},{"location":"extensions/api/classes/Main.LensExtension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.LensExtension/#description","text":"\u2022 get description (): string","title":"description"},{"location":"extensions/api/classes/Main.LensExtension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/Main.LensExtension/#version","text":"\u2022 get version (): string","title":"version"},{"location":"extensions/api/classes/Main.LensExtension/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Main.LensExtension/#addcatalogsource","text":"\u25b8 addCatalogSource ( id , source ): void","title":"addCatalogSource"},{"location":"extensions/api/classes/Main.LensExtension/#disable","text":"\u25b8 disable (): Promise < void >","title":"disable"},{"location":"extensions/api/classes/Main.LensExtension/#enable","text":"\u25b8 enable ( register ): Promise < void >","title":"enable"},{"location":"extensions/api/classes/Main.LensExtension/#getextensionfilefolder","text":"\u25b8 getExtensionFileFolder (): Promise < string > getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension. Note: there is no security done on this folder, only obfuscation of the folder name.","title":"getExtensionFileFolder"},{"location":"extensions/api/classes/Main.LensExtension/#navigate","text":"\u25b8 navigate ( pageId? , params? , frameId? ): Promise < void >","title":"navigate"},{"location":"extensions/api/classes/Main.LensExtension/#onactivate","text":"\u25b8 Protected onActivate (): void | Promise < void >","title":"onActivate"},{"location":"extensions/api/classes/Main.LensExtension/#ondeactivate","text":"\u25b8 Protected onDeactivate (): void | Promise < void >","title":"onDeactivate"},{"location":"extensions/api/classes/Main.LensExtension/#removecatalogsource","text":"\u25b8 removeCatalogSource ( id ): void","title":"removeCatalogSource"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/","text":"Class: CatalogEntityRegistry # Renderer . Catalog .CatalogEntityRegistry Table of contents # Constructors # constructor Accessors # activeEntity entities Methods # addOnBeforeRun getById getItemsForApiKind getItemsForCategory Constructors # constructor # \u2022 new CatalogEntityRegistry () Accessors # activeEntity # \u2022 get activeEntity (): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity Returns # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > entities # \u2022 get entities (): Map < string , CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> Returns # Map < string , CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >> Methods # addOnBeforeRun # \u25b8 addOnBeforeRun ( onBeforeRun ): Disposer Add a onBeforeRun hook to a catalog entities. If onBeforeRun was previously added then it will not be added again. Parameters # Name Type Description onBeforeRun CatalogEntityOnBeforeRun The function to be called with a CatalogRunEvent event target will be the catalog entity. onBeforeRun hook can call event.preventDefault() to stop run sequence Returns # Disposer A function to remove that hook getById # \u25b8 getById ( id ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Parameters # Name Type id string Returns # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > getItemsForApiKind # \u25b8 getItemsForApiKind < T >( apiVersion , kind ): T [] Type parameters # Name Type T extends CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T > Parameters # Name Type apiVersion string kind string Returns # T [] getItemsForCategory # \u25b8 getItemsForCategory < T >( category ): T [] Type parameters # Name Type T extends CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec , T > Parameters # Name Type category CatalogCategory Returns # T []","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#class-catalogentityregistry","text":"Renderer . Catalog .CatalogEntityRegistry","title":"Class: CatalogEntityRegistry"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors","text":"activeEntity entities","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods","text":"addOnBeforeRun getById getItemsForApiKind getItemsForCategory","title":"Methods"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#constructor","text":"\u2022 new CatalogEntityRegistry ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#activeentity","text":"\u2022 get activeEntity (): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity","title":"activeEntity"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#entities","text":"\u2022 get entities (): Map < string , CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >>","title":"entities"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#addonbeforerun","text":"\u25b8 addOnBeforeRun ( onBeforeRun ): Disposer Add a onBeforeRun hook to a catalog entities. If onBeforeRun was previously added then it will not be added again.","title":"addOnBeforeRun"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getbyid","text":"\u25b8 getById ( id ): CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec >","title":"getById"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforapikind","text":"\u25b8 getItemsForApiKind < T >( apiVersion , kind ): T []","title":"getItemsForApiKind"},{"location":"extensions/api/classes/Renderer.Catalog.CatalogEntityRegistry/#getitemsforcategory","text":"\u25b8 getItemsForCategory < T >( category ): T []","title":"getItemsForCategory"},{"location":"extensions/api/classes/Renderer.Component.Badge/","text":"Class: Badge # Renderer . Component .Badge Hierarchy # Component < BadgeProps > \u21b3 Badge Table of contents # Constructors # constructor Properties # context elem isExpanded props refs state badgeMeta contextType defaultProps Accessors # isExpandable Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onMouseUp render setState shouldComponentUpdate Constructors # constructor # \u2022 new Badge ( props ) Parameters # Name Type props BadgeProps Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context elem # \u2022 elem : HTMLElement isExpanded # \u2022 isExpanded : boolean = false props # \u2022 Readonly props : Readonly < BadgeProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state badgeMeta # \u25aa Static badgeMeta : Object Type declaration # Name Type hasTextSelected boolean contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : Partial < BadgeProps > Accessors # isExpandable # \u2022 get isExpandable (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < BadgeProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < BadgeProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindRef # \u25b8 bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < BadgeProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < BadgeProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < BadgeProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < BadgeProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onMouseUp # \u25b8 onMouseUp (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < BadgeProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < BadgeProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Badge"},{"location":"extensions/api/classes/Renderer.Component.Badge/#class-badge","text":"Renderer . Component .Badge","title":"Class: Badge"},{"location":"extensions/api/classes/Renderer.Component.Badge/#hierarchy","text":"Component < BadgeProps > \u21b3 Badge","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Badge/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Badge/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Badge/#properties","text":"context elem isExpanded props refs state badgeMeta contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Badge/#accessors","text":"isExpandable","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Badge/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onMouseUp render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Badge/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Badge/#constructor","text":"\u2022 new Badge ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Badge/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Badge/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Badge/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Badge/#isexpanded","text":"\u2022 isExpanded : boolean = false","title":"isExpanded"},{"location":"extensions/api/classes/Renderer.Component.Badge/#props","text":"\u2022 Readonly props : Readonly < BadgeProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Badge/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Badge/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Badge/#badgemeta","text":"\u25aa Static badgeMeta : Object","title":"badgeMeta"},{"location":"extensions/api/classes/Renderer.Component.Badge/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Badge/#defaultprops","text":"\u25aa Static defaultProps : Partial < BadgeProps >","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Badge/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Badge/#isexpandable","text":"\u2022 get isExpandable (): boolean","title":"isExpandable"},{"location":"extensions/api/classes/Renderer.Component.Badge/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Badge/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Badge/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Badge/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Badge/#bindref","text":"\u25b8 bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.Badge/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Badge/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Badge/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Badge/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Badge/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Badge/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Badge/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Badge/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Badge/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Badge/#onmouseup","text":"\u25b8 onMouseUp (): void","title":"onMouseUp"},{"location":"extensions/api/classes/Renderer.Component.Badge/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Badge/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Badge/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.BarChart/","text":"Class: BarChart # Renderer . Component .BarChart Hierarchy # Component < Props > \u21b3 BarChart Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new BarChart ( props ) Parameters # Name Type props Props | Readonly < Props > Inherited from # React.Component.constructor \u2022 new BarChart ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < Props > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Props >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: BarChart"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#class-barchart","text":"Renderer . Component .BarChart","title":"Class: BarChart"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#hierarchy","text":"Component < Props > \u21b3 BarChart","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#constructor","text":"\u2022 new BarChart ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#props","text":"\u2022 Readonly props : Readonly < Props > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.BarChart/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Button/","text":"Class: Button # Renderer . Component .Button Hierarchy # PureComponent < ButtonProps , Object > \u21b3 Button Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Button ( props ) Parameters # Name Type props ButtonProps | Readonly < ButtonProps > Inherited from # React.PureComponent.constructor \u2022 new Button ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props ButtonProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < ButtonProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.PureComponent.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ButtonProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ButtonProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < ButtonProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ButtonProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ButtonProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < ButtonProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < ButtonProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < ButtonProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Button"},{"location":"extensions/api/classes/Renderer.Component.Button/#class-button","text":"Renderer . Component .Button","title":"Class: Button"},{"location":"extensions/api/classes/Renderer.Component.Button/#hierarchy","text":"PureComponent < ButtonProps , Object > \u21b3 Button","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Button/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Button/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Button/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Button/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Button/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Button/#constructor","text":"\u2022 new Button ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Button/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Button/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Button/#props","text":"\u2022 Readonly props : Readonly < ButtonProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Button/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Button/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Button/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Button/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Button/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Button/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Button/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Button/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Button/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Button/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Button/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Button/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Button/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Button/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Button/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Button/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Button/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Button/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Button/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/","text":"Class: Checkbox # Renderer . Component .Checkbox Hierarchy # PureComponent < CheckboxProps > \u21b3 Checkbox Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getValue onChange render setState shouldComponentUpdate Constructors # constructor # \u2022 new Checkbox ( props ) Parameters # Name Type props CheckboxProps < boolean > | Readonly < CheckboxProps < boolean >> Inherited from # React.PureComponent.constructor \u2022 new Checkbox ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props CheckboxProps < boolean > context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < CheckboxProps < boolean >> & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.PureComponent.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < CheckboxProps < boolean >> nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < CheckboxProps < boolean >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < CheckboxProps < boolean >> prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < CheckboxProps < boolean >> nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < CheckboxProps < boolean >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < CheckboxProps < boolean >> prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate getValue # \u25b8 getValue (): boolean Returns # boolean onChange # \u25b8 onChange ( evt ): void Parameters # Name Type evt ChangeEvent < HTMLInputElement > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < CheckboxProps < boolean >>) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < CheckboxProps < boolean >> nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Checkbox"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#class-checkbox","text":"Renderer . Component .Checkbox","title":"Class: Checkbox"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#hierarchy","text":"PureComponent < CheckboxProps > \u21b3 Checkbox","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getValue onChange render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#constructor","text":"\u2022 new Checkbox ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#props","text":"\u2022 Readonly props : Readonly < CheckboxProps < boolean >> & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#getvalue","text":"\u25b8 getValue (): boolean","title":"getValue"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#onchange","text":"\u25b8 onChange ( evt ): void","title":"onChange"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Checkbox/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/","text":"Class: CommandOverlay # Renderer . Component .CommandOverlay Table of contents # Constructors # constructor Accessors # component isOpen Methods # close open Constructors # constructor # \u2022 new CommandOverlay () Accessors # component # \u2022 Static get component (): ReactElement < any , string | JSXElementConstructor < any >> Returns # ReactElement < any , string | JSXElementConstructor < any >> isOpen # \u2022 Static get isOpen (): boolean Returns # boolean Methods # close # \u25b8 Static close (): void Returns # void open # \u25b8 Static open ( component ): void Parameters # Name Type component ReactElement < any , string | JSXElementConstructor < any >> Returns # void","title":"Class: CommandOverlay"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#class-commandoverlay","text":"Renderer . Component .CommandOverlay","title":"Class: CommandOverlay"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#accessors","text":"component isOpen","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#methods","text":"close open","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#constructor","text":"\u2022 new CommandOverlay ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#component","text":"\u2022 Static get component (): ReactElement < any , string | JSXElementConstructor < any >>","title":"component"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#isopen","text":"\u2022 Static get isOpen (): boolean","title":"isOpen"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#close","text":"\u25b8 Static close (): void","title":"close"},{"location":"extensions/api/classes/Renderer.Component.CommandOverlay/#open","text":"\u25b8 Static open ( component ): void","title":"open"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/","text":"Class: ConfirmDialog # Renderer . Component .ConfirmDialog Hierarchy # Component < ConfirmDialogProps > \u21b3 ConfirmDialog Table of contents # Constructors # constructor Properties # context isSaving props refs state contextType defaultParams Accessors # params Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate ok onClose render setState shouldComponentUpdate confirm open Constructors # constructor # \u2022 new ConfirmDialog ( props ) Parameters # Name Type props ConfirmDialogProps Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context isSaving # \u2022 isSaving : boolean = false props # \u2022 Readonly props : Readonly < ConfirmDialogProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultParams # \u25aa Static defaultParams : Partial < ConfirmDialogParams > Accessors # params # \u2022 get params (): ConfirmDialogParams Returns # ConfirmDialogParams Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate close # \u25b8 close (): Promise < void > Returns # Promise < void > componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < ConfirmDialogProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < ConfirmDialogProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate ok # \u25b8 ok (): Promise < void > Returns # Promise < void > onClose # \u25b8 onClose (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < ConfirmDialogProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < ConfirmDialogProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate confirm # \u25b8 Static confirm ( params ): Promise < boolean > Parameters # Name Type params ConfirmDialogBooleanParams Returns # Promise < boolean > open # \u25b8 Static open ( params ): void Parameters # Name Type params ConfirmDialogParams Returns # void","title":"Class: ConfirmDialog"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#class-confirmdialog","text":"Renderer . Component .ConfirmDialog","title":"Class: ConfirmDialog"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#hierarchy","text":"Component < ConfirmDialogProps > \u21b3 ConfirmDialog","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#properties","text":"context isSaving props refs state contextType defaultParams","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#accessors","text":"params","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate ok onClose render setState shouldComponentUpdate confirm open","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#constructor","text":"\u2022 new ConfirmDialog ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#issaving","text":"\u2022 isSaving : boolean = false","title":"isSaving"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#props","text":"\u2022 Readonly props : Readonly < ConfirmDialogProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#defaultparams","text":"\u25aa Static defaultParams : Partial < ConfirmDialogParams >","title":"defaultParams"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#params","text":"\u2022 get params (): ConfirmDialogParams","title":"params"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#close","text":"\u25b8 close (): Promise < void >","title":"close"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#ok","text":"\u25b8 ok (): Promise < void >","title":"ok"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#onclose","text":"\u25b8 onClose (): void","title":"onClose"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#confirm","text":"\u25b8 Static confirm ( params ): Promise < boolean >","title":"confirm"},{"location":"extensions/api/classes/Renderer.Component.ConfirmDialog/#open","text":"\u25b8 Static open ( params ): void","title":"open"},{"location":"extensions/api/classes/Renderer.Component.Dialog/","text":"Class: Dialog # Renderer . Component .Dialog Hierarchy # PureComponent < DialogProps , DialogState > \u21b3 Dialog Table of contents # Constructors # constructor Properties # closeOnNavigate context props refs state contextType defaultProps Accessors # elem isOpen Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClickOutside onClose onEscapeKey onOpen open render setState shouldComponentUpdate toggle Constructors # constructor # \u2022 new Dialog ( props ) Parameters # Name Type props DialogProps | Readonly < DialogProps > Inherited from # React.PureComponent.constructor \u2022 new Dialog ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DialogProps context any Inherited from # React.PureComponent.constructor Properties # closeOnNavigate # \u2022 closeOnNavigate : IReactionDisposer context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < DialogProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : DialogState Overrides # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.PureComponent.contextType defaultProps # \u25aa Static defaultProps : DialogProps Accessors # elem # \u2022 get elem (): HTMLElement Returns # HTMLElement isOpen # \u2022 get isOpen (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DialogProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DialogProps > nextState Readonly < DialogState > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate close # \u25b8 close (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 componentDidUpdate ( prevProps ): void Parameters # Name Type prevProps DialogProps Returns # void Overrides # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DialogProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DialogProps > nextState Readonly < DialogState > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < DialogProps > prevState Readonly < DialogState > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate onClickOutside # \u25b8 onClickOutside ( evt ): void Parameters # Name Type evt MouseEvent Returns # void onClose # \u25b8 onClose (): void Returns # void onEscapeKey # \u25b8 onEscapeKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void onOpen # \u25b8 onOpen (): void Returns # void open # \u25b8 open (): void Returns # void render # \u25b8 render (): ReactPortal Returns # ReactPortal Overrides # React.PureComponent.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends \"isOpen\" Parameters # Name Type state DialogState | ( prevState : Readonly < DialogState >, props : Readonly < DialogProps >) => DialogState | Pick < DialogState , K > | Pick < DialogState , K > callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < DialogProps > nextState Readonly < DialogState > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate toggle # \u25b8 toggle ( isOpen ): void Parameters # Name Type isOpen boolean Returns # void","title":"Class: Dialog"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#class-dialog","text":"Renderer . Component .Dialog","title":"Class: Dialog"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#hierarchy","text":"PureComponent < DialogProps , DialogState > \u21b3 Dialog","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#properties","text":"closeOnNavigate context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#accessors","text":"elem isOpen","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClickOutside onClose onEscapeKey onOpen open render setState shouldComponentUpdate toggle","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#constructor","text":"\u2022 new Dialog ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#closeonnavigate","text":"\u2022 closeOnNavigate : IReactionDisposer","title":"closeOnNavigate"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#props","text":"\u2022 Readonly props : Readonly < DialogProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#state","text":"\u2022 state : DialogState","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#defaultprops","text":"\u25aa Static defaultProps : DialogProps","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#elem","text":"\u2022 get elem (): HTMLElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#isopen","text":"\u2022 get isOpen (): boolean","title":"isOpen"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#close","text":"\u25b8 close (): void","title":"close"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#componentdidupdate","text":"\u25b8 componentDidUpdate ( prevProps ): void","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#onclickoutside","text":"\u25b8 onClickOutside ( evt ): void","title":"onClickOutside"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#onclose","text":"\u25b8 onClose (): void","title":"onClose"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#onescapekey","text":"\u25b8 onEscapeKey ( evt ): void","title":"onEscapeKey"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#onopen","text":"\u25b8 onOpen (): void","title":"onOpen"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#open","text":"\u25b8 open (): void","title":"open"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#render","text":"\u25b8 render (): ReactPortal","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Dialog/#toggle","text":"\u25b8 toggle ( isOpen ): void","title":"toggle"},{"location":"extensions/api/classes/Renderer.Component.Drawer/","text":"Class: Drawer # Renderer . Component .Drawer Hierarchy # Component < DrawerProps > \u21b3 Drawer Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate copyK8sObjName forceUpdate getSnapshotBeforeUpdate onClickOutside onEscapeKey onMouseDown render restoreScrollPos saveScrollPos setState shouldComponentUpdate Constructors # constructor # \u2022 new Drawer ( props ) Parameters # Name Type props DrawerProps | Readonly < DrawerProps > Inherited from # React.Component.constructor \u2022 new Drawer ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < DrawerProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : State Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate close # \u25b8 close (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < DrawerProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate copyK8sObjName # \u25b8 copyK8sObjName (): void Returns # void forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < DrawerProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onClickOutside # \u25b8 onClickOutside ( evt ): void Parameters # Name Type evt MouseEvent Returns # void onEscapeKey # \u25b8 onEscapeKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void onMouseDown # \u25b8 onMouseDown ( evt ): void Parameters # Name Type evt MouseEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render restoreScrollPos # \u25b8 restoreScrollPos (): void Returns # void saveScrollPos # \u25b8 saveScrollPos (): void Returns # void setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < DrawerProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < DrawerProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Drawer"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#class-drawer","text":"Renderer . Component .Drawer","title":"Class: Drawer"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#hierarchy","text":"Component < DrawerProps > \u21b3 Drawer","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate copyK8sObjName forceUpdate getSnapshotBeforeUpdate onClickOutside onEscapeKey onMouseDown render restoreScrollPos saveScrollPos setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#constructor","text":"\u2022 new Drawer ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#props","text":"\u2022 Readonly props : Readonly < DrawerProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#close","text":"\u25b8 close (): void","title":"close"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#copyk8sobjname","text":"\u25b8 copyK8sObjName (): void","title":"copyK8sObjName"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#onclickoutside","text":"\u25b8 onClickOutside ( evt ): void","title":"onClickOutside"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#onescapekey","text":"\u25b8 onEscapeKey ( evt ): void","title":"onEscapeKey"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#onmousedown","text":"\u25b8 onMouseDown ( evt ): void","title":"onMouseDown"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#restorescrollpos","text":"\u25b8 restoreScrollPos (): void","title":"restoreScrollPos"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#savescrollpos","text":"\u25b8 saveScrollPos (): void","title":"saveScrollPos"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Drawer/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/","text":"Class: DrawerItem # Renderer . Component .DrawerItem Hierarchy # Component < DrawerItemProps > \u21b3 DrawerItem Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new DrawerItem ( props ) Parameters # Name Type props DrawerItemProps | Readonly < DrawerItemProps > Inherited from # React.Component.constructor \u2022 new DrawerItem ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerItemProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < DrawerItemProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerItemProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerItemProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < DrawerItemProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerItemProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerItemProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < DrawerItemProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < DrawerItemProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < DrawerItemProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: DrawerItem"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#class-draweritem","text":"Renderer . Component .DrawerItem","title":"Class: DrawerItem"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#hierarchy","text":"Component < DrawerItemProps > \u21b3 DrawerItem","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#constructor","text":"\u2022 new DrawerItem ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#props","text":"\u2022 Readonly props : Readonly < DrawerItemProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.DrawerItem/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/","text":"Class: DrawerParamToggler # Renderer . Component .DrawerParamToggler Hierarchy # Component < DrawerParamTogglerProps , State > \u21b3 DrawerParamToggler Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate toggle Constructors # constructor # \u2022 new DrawerParamToggler ( props ) Parameters # Name Type props DrawerParamTogglerProps | Readonly < DrawerParamTogglerProps > Inherited from # React.Component.constructor \u2022 new DrawerParamToggler ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerParamTogglerProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < DrawerParamTogglerProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : State = {} Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerParamTogglerProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerParamTogglerProps > nextState Readonly < State > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < DrawerParamTogglerProps > prevState Readonly < State > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerParamTogglerProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerParamTogglerProps > nextState Readonly < State > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < DrawerParamTogglerProps > prevState Readonly < State > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends \"open\" Parameters # Name Type state State | ( prevState : Readonly < State >, props : Readonly < DrawerParamTogglerProps >) => State | Pick < State , K > | Pick < State , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < DrawerParamTogglerProps > nextState Readonly < State > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate toggle # \u25b8 toggle (): void Returns # void","title":"Class: DrawerParamToggler"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#class-drawerparamtoggler","text":"Renderer . Component .DrawerParamToggler","title":"Class: DrawerParamToggler"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#hierarchy","text":"Component < DrawerParamTogglerProps , State > \u21b3 DrawerParamToggler","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate toggle","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#constructor","text":"\u2022 new DrawerParamToggler ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#props","text":"\u2022 Readonly props : Readonly < DrawerParamTogglerProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#state","text":"\u2022 state : State = {}","title":"state"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerParamToggler/#toggle","text":"\u25b8 toggle (): void","title":"toggle"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/","text":"Class: DrawerTitle # Renderer . Component .DrawerTitle Hierarchy # Component < DrawerTitleProps > \u21b3 DrawerTitle Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new DrawerTitle ( props ) Parameters # Name Type props DrawerTitleProps | Readonly < DrawerTitleProps > Inherited from # React.Component.constructor \u2022 new DrawerTitle ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props DrawerTitleProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < DrawerTitleProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerTitleProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerTitleProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < DrawerTitleProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerTitleProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < DrawerTitleProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < DrawerTitleProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < DrawerTitleProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < DrawerTitleProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: DrawerTitle"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#class-drawertitle","text":"Renderer . Component .DrawerTitle","title":"Class: DrawerTitle"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#hierarchy","text":"Component < DrawerTitleProps > \u21b3 DrawerTitle","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#constructor","text":"\u2022 new DrawerTitle ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#props","text":"\u2022 Readonly props : Readonly < DrawerTitleProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.DrawerTitle/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Icon/","text":"Class: Icon # Renderer . Component .Icon Hierarchy # PureComponent < IconProps > \u21b3 Icon Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # isInteractive Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick onKeyDown render setState shouldComponentUpdate Constructors # constructor # \u2022 new Icon ( props ) Parameters # Name Type props IconProps | Readonly < IconProps > Inherited from # React.PureComponent.constructor \u2022 new Icon ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props IconProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < IconProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.PureComponent.contextType defaultProps # \u25aa Static defaultProps : IconProps Accessors # isInteractive # \u2022 get isInteractive (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < IconProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < IconProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < IconProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < IconProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < IconProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < IconProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < Element , MouseEvent > Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < any > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < IconProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < IconProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Icon"},{"location":"extensions/api/classes/Renderer.Component.Icon/#class-icon","text":"Renderer . Component .Icon","title":"Class: Icon"},{"location":"extensions/api/classes/Renderer.Component.Icon/#hierarchy","text":"PureComponent < IconProps > \u21b3 Icon","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Icon/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Icon/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Icon/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Icon/#accessors","text":"isInteractive","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Icon/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick onKeyDown render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Icon/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Icon/#constructor","text":"\u2022 new Icon ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Icon/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Icon/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Icon/#props","text":"\u2022 Readonly props : Readonly < IconProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Icon/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Icon/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Icon/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Icon/#defaultprops","text":"\u25aa Static defaultProps : IconProps","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Icon/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Icon/#isinteractive","text":"\u2022 get isInteractive (): boolean","title":"isInteractive"},{"location":"extensions/api/classes/Renderer.Component.Icon/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Icon/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Icon/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Icon/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Icon/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Icon/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Icon/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Icon/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Icon/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Icon/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Icon/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Icon/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Icon/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Icon/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.Icon/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Icon/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Icon/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Icon/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Input/","text":"Class: Input # Renderer . Component .Input Hierarchy # Component < InputProps , State > \u21b3 Input Table of contents # Constructors # constructor Properties # context input props refs setDirtyOnChange state validators contextType defaultProps Accessors # isUncontrolled showMaxLenIndicator themeSelection Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef blur componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focus forceUpdate getSnapshotBeforeUpdate getValue onBlur onChange onFocus onKeyDown render select setDirty setState setValidation setValue shouldComponentUpdate validate Constructors # constructor # \u2022 new Input ( props ) Parameters # Name Type props InputProps | Readonly < InputProps > Inherited from # React.Component.constructor \u2022 new Input ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props InputProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context input # \u2022 input : InputElement = null props # \u2022 Readonly props : Readonly < InputProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs setDirtyOnChange # \u2022 setDirtyOnChange : () => void & Cancelable state # \u2022 state : State Overrides # React.Component.state validators # \u2022 validators : InputValidator [] = [] contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # isUncontrolled # \u2022 get isUncontrolled (): boolean Returns # boolean showMaxLenIndicator # \u2022 get showMaxLenIndicator (): boolean Returns # boolean themeSelection # \u2022 get themeSelection (): Record < string , boolean > Returns # Record < string , boolean > Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < InputProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < InputProps > nextState Readonly < State > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindRef # \u25b8 bindRef ( elem ): void Parameters # Name Type elem InputElement Returns # void blur # \u25b8 blur (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 componentDidUpdate ( prevProps ): void Parameters # Name Type prevProps InputProps Returns # void Overrides # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < InputProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < InputProps > nextState Readonly < State > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate focus # \u25b8 focus (): void Returns # void forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < InputProps > prevState Readonly < State > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate getValue # \u25b8 getValue (): string Returns # string onBlur # \u25b8 onBlur ( evt ): void Parameters # Name Type evt FocusEvent < InputElement , Element > Returns # void onChange # \u25b8 onChange ( evt ): void Parameters # Name Type evt ChangeEvent < any > Returns # void onFocus # \u25b8 onFocus ( evt ): void Parameters # Name Type evt FocusEvent < InputElement , Element > Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < InputElement > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render select # \u25b8 select (): void Returns # void setDirty # \u25b8 setDirty ( dirty? ): void Parameters # Name Type Default value dirty boolean true Returns # void setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends keyof State Parameters # Name Type state State | ( prevState : Readonly < State >, props : Readonly < InputProps >) => State | Pick < State , K > | Pick < State , K > callback? () => void Returns # void Inherited from # React.Component.setState setValidation # \u25b8 setValidation ( errors ): void Parameters # Name Type errors ReactNode [] Returns # void setValue # \u25b8 setValue ( value? ): void Parameters # Name Type Default value value string \"\" Returns # void shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < InputProps > nextState Readonly < State > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate validate # \u25b8 validate (): Promise < void > Returns # Promise < void >","title":"Class: Input"},{"location":"extensions/api/classes/Renderer.Component.Input/#class-input","text":"Renderer . Component .Input","title":"Class: Input"},{"location":"extensions/api/classes/Renderer.Component.Input/#hierarchy","text":"Component < InputProps , State > \u21b3 Input","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Input/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties","text":"context input props refs setDirtyOnChange state validators contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors","text":"isUncontrolled showMaxLenIndicator themeSelection","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef blur componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focus forceUpdate getSnapshotBeforeUpdate getValue onBlur onChange onFocus onKeyDown render select setDirty setState setValidation setValue shouldComponentUpdate validate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Input/#constructor","text":"\u2022 new Input ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Input/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Input/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Input/#input","text":"\u2022 input : InputElement = null","title":"input"},{"location":"extensions/api/classes/Renderer.Component.Input/#props","text":"\u2022 Readonly props : Readonly < InputProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Input/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirtyonchange","text":"\u2022 setDirtyOnChange : () => void & Cancelable","title":"setDirtyOnChange"},{"location":"extensions/api/classes/Renderer.Component.Input/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Input/#validators","text":"\u2022 validators : InputValidator [] = []","title":"validators"},{"location":"extensions/api/classes/Renderer.Component.Input/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Input/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Input/#isuncontrolled","text":"\u2022 get isUncontrolled (): boolean","title":"isUncontrolled"},{"location":"extensions/api/classes/Renderer.Component.Input/#showmaxlenindicator","text":"\u2022 get showMaxLenIndicator (): boolean","title":"showMaxLenIndicator"},{"location":"extensions/api/classes/Renderer.Component.Input/#themeselection","text":"\u2022 get themeSelection (): Record < string , boolean >","title":"themeSelection"},{"location":"extensions/api/classes/Renderer.Component.Input/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Input/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Input/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Input/#bindref","text":"\u25b8 bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.Input/#blur","text":"\u25b8 blur (): void","title":"blur"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentdidupdate","text":"\u25b8 componentDidUpdate ( prevProps ): void","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Input/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Input/#focus","text":"\u25b8 focus (): void","title":"focus"},{"location":"extensions/api/classes/Renderer.Component.Input/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Input/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Input/#getvalue","text":"\u25b8 getValue (): string","title":"getValue"},{"location":"extensions/api/classes/Renderer.Component.Input/#onblur","text":"\u25b8 onBlur ( evt ): void","title":"onBlur"},{"location":"extensions/api/classes/Renderer.Component.Input/#onchange","text":"\u25b8 onChange ( evt ): void","title":"onChange"},{"location":"extensions/api/classes/Renderer.Component.Input/#onfocus","text":"\u25b8 onFocus ( evt ): void","title":"onFocus"},{"location":"extensions/api/classes/Renderer.Component.Input/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Input/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Input/#select","text":"\u25b8 select (): void","title":"select"},{"location":"extensions/api/classes/Renderer.Component.Input/#setdirty","text":"\u25b8 setDirty ( dirty? ): void","title":"setDirty"},{"location":"extensions/api/classes/Renderer.Component.Input/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalidation","text":"\u25b8 setValidation ( errors ): void","title":"setValidation"},{"location":"extensions/api/classes/Renderer.Component.Input/#setvalue","text":"\u25b8 setValue ( value? ): void","title":"setValue"},{"location":"extensions/api/classes/Renderer.Component.Input/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Input/#validate","text":"\u25b8 validate (): Promise < void >","title":"validate"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/","text":"Class: KubeEventDetails # Renderer . Component .KubeEventDetails Hierarchy # Component < KubeEventDetailsProps > \u21b3 KubeEventDetails Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new KubeEventDetails ( props ) Parameters # Name Type props KubeEventDetailsProps | Readonly < KubeEventDetailsProps > Inherited from # React.Component.constructor \u2022 new KubeEventDetails ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props KubeEventDetailsProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < KubeEventDetailsProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeEventDetailsProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeEventDetailsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): Promise < void > Returns # Promise < void > Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < KubeEventDetailsProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeEventDetailsProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeEventDetailsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < KubeEventDetailsProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < KubeEventDetailsProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < KubeEventDetailsProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: KubeEventDetails"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#class-kubeeventdetails","text":"Renderer . Component .KubeEventDetails","title":"Class: KubeEventDetails"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#hierarchy","text":"Component < KubeEventDetailsProps > \u21b3 KubeEventDetails","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#constructor","text":"\u2022 new KubeEventDetails ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#props","text":"\u2022 Readonly props : Readonly < KubeEventDetailsProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#componentdidmount","text":"\u25b8 componentDidMount (): Promise < void >","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.KubeEventDetails/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/","text":"Class: KubeObjectDetails # Renderer . Component .KubeObjectDetails Hierarchy # Component \u21b3 KubeObjectDetails Table of contents # Constructors # constructor Properties # context isLoading loader loadingError props refs state contextType Accessors # object path Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new KubeObjectDetails ( props ) Parameters # Name Type props Object Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context isLoading # \u2022 isLoading : boolean = false loader # \u2022 loader : IReactionDisposer loadingError # \u2022 loadingError : ReactNode props # \u2022 Readonly props : Readonly < Object > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Accessors # object # \u2022 get object (): KubeObject < KubeObjectMetadata , any , any > Returns # KubeObject < KubeObjectMetadata , any , any > path # \u2022 get path (): string Returns # string Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < Object > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < Object > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Object >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: KubeObjectDetails"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#class-kubeobjectdetails","text":"Renderer . Component .KubeObjectDetails","title":"Class: KubeObjectDetails"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#hierarchy","text":"Component \u21b3 KubeObjectDetails","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#properties","text":"context isLoading loader loadingError props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#accessors","text":"object path","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#constructor","text":"\u2022 new KubeObjectDetails ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#loader","text":"\u2022 loader : IReactionDisposer","title":"loader"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#loadingerror","text":"\u2022 loadingError : ReactNode","title":"loadingError"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#props","text":"\u2022 Readonly props : Readonly < Object > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#object","text":"\u2022 get object (): KubeObject < KubeObjectMetadata , any , any >","title":"object"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#path","text":"\u2022 get path (): string","title":"path"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectDetails/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/","text":"Class: KubeObjectListLayout # Renderer . Component .KubeObjectListLayout Type parameters # Name Type K extends KubeObject Hierarchy # Component < KubeObjectListLayoutProps < K >> \u21b3 KubeObjectListLayout Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # selectedItem Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new KubeObjectListLayout < K >( props ) Type parameters # Name Type K extends KubeObject < KubeObjectMetadata , any , any , K > Parameters # Name Type props KubeObjectListLayoutProps < K > Overrides # React.Component\\>.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < KubeObjectListLayoutProps < K >> & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # selectedItem # \u2022 get selectedItem (): K Returns # K Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectListLayoutProps < K >> nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectListLayoutProps < K >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < KubeObjectListLayoutProps < K >> prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectListLayoutProps < K >> nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectListLayoutProps < K >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < KubeObjectListLayoutProps < K >> prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < KubeObjectListLayoutProps < K >>) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < KubeObjectListLayoutProps < K >> nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: KubeObjectListLayout"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#class-kubeobjectlistlayoutk","text":"Renderer . Component .KubeObjectListLayout","title":"Class: KubeObjectListLayout<K>"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#type-parameters","text":"Name Type K extends KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#hierarchy","text":"Component < KubeObjectListLayoutProps < K >> \u21b3 KubeObjectListLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#accessors","text":"selectedItem","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#constructor","text":"\u2022 new KubeObjectListLayout < K >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#props","text":"\u2022 Readonly props : Readonly < KubeObjectListLayoutProps < K >> & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#selecteditem","text":"\u2022 get selectedItem (): K","title":"selectedItem"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectListLayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/","text":"Class: KubeObjectMenu # Renderer . Component .KubeObjectMenu Type parameters # Name Type T extends KubeObject Hierarchy # Component < KubeObjectMenuProps < T >> \u21b3 KubeObjectMenu Table of contents # Constructors # constructor Properties # context props refs state contextType Accessors # isEditable isRemovable store Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getMenuItems getSnapshotBeforeUpdate remove render renderRemoveMessage setState shouldComponentUpdate update Constructors # constructor # \u2022 new KubeObjectMenu < T >( props ) Type parameters # Name Type T extends KubeObject < KubeObjectMetadata , any , any , T > Parameters # Name Type props KubeObjectMenuProps < T > | Readonly < KubeObjectMenuProps < T >> Inherited from # React.Component>.constructor \u2022 new KubeObjectMenu < T >( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Type parameters # Name Type T extends KubeObject < KubeObjectMetadata , any , any , T > Parameters # Name Type props KubeObjectMenuProps < T > context any Inherited from # React.Component>.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < KubeObjectMenuProps < T >> & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Accessors # isEditable # \u2022 get isEditable (): boolean Returns # boolean isRemovable # \u2022 get isRemovable (): boolean Returns # boolean store # \u2022 get store (): KubeObjectStore < KubeObject < KubeObjectMetadata , any , any >> Returns # KubeObjectStore < KubeObject < KubeObjectMetadata , any , any >> Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectMenuProps < T >> nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectMenuProps < T >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < KubeObjectMenuProps < T >> prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectMenuProps < T >> nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectMenuProps < T >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getMenuItems # \u25b8 getMenuItems (): ReactChild [] Returns # ReactChild [] getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < KubeObjectMenuProps < T >> prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate remove # \u25b8 remove (): Promise < void > Returns # Promise < void > render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderRemoveMessage # \u25b8 renderRemoveMessage (): Element Returns # Element setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < KubeObjectMenuProps < T >>) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < KubeObjectMenuProps < T >> nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate update # \u25b8 update (): Promise < void > Returns # Promise < void >","title":"Class: KubeObjectMenu"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#class-kubeobjectmenut","text":"Renderer . Component .KubeObjectMenu","title":"Class: KubeObjectMenu<T>"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#type-parameters","text":"Name Type T extends KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#hierarchy","text":"Component < KubeObjectMenuProps < T >> \u21b3 KubeObjectMenu","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#accessors","text":"isEditable isRemovable store","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getMenuItems getSnapshotBeforeUpdate remove render renderRemoveMessage setState shouldComponentUpdate update","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#constructor","text":"\u2022 new KubeObjectMenu < T >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#props","text":"\u2022 Readonly props : Readonly < KubeObjectMenuProps < T >> & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#iseditable","text":"\u2022 get isEditable (): boolean","title":"isEditable"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#isremovable","text":"\u2022 get isRemovable (): boolean","title":"isRemovable"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#store","text":"\u2022 get store (): KubeObjectStore < KubeObject < KubeObjectMetadata , any , any >>","title":"store"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#getmenuitems","text":"\u25b8 getMenuItems (): ReactChild []","title":"getMenuItems"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#remove","text":"\u25b8 remove (): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#renderremovemessage","text":"\u25b8 renderRemoveMessage (): Element","title":"renderRemoveMessage"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMenu/#update","text":"\u25b8 update (): Promise < void >","title":"update"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/","text":"Class: KubeObjectMeta # Renderer . Component .KubeObjectMeta Hierarchy # Component < KubeObjectMetaProps > \u21b3 KubeObjectMeta Table of contents # Constructors # constructor Properties # context props refs state contextType defaultHiddenFields Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate isHidden render setState shouldComponentUpdate Constructors # constructor # \u2022 new KubeObjectMeta ( props ) Parameters # Name Type props KubeObjectMetaProps | Readonly < KubeObjectMetaProps > Inherited from # React.Component.constructor \u2022 new KubeObjectMeta ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props KubeObjectMetaProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < KubeObjectMetaProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultHiddenFields # \u25aa Static defaultHiddenFields : keyof KubeObjectMetadata [] Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectMetaProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectMetaProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < KubeObjectMetaProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectMetaProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < KubeObjectMetaProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < KubeObjectMetaProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate isHidden # \u25b8 isHidden ( field ): boolean Parameters # Name Type field keyof KubeObjectMetadata Returns # boolean render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < KubeObjectMetaProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < KubeObjectMetaProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: KubeObjectMeta"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#class-kubeobjectmeta","text":"Renderer . Component .KubeObjectMeta","title":"Class: KubeObjectMeta"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#hierarchy","text":"Component < KubeObjectMetaProps > \u21b3 KubeObjectMeta","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#properties","text":"context props refs state contextType defaultHiddenFields","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate isHidden render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#constructor","text":"\u2022 new KubeObjectMeta ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#props","text":"\u2022 Readonly props : Readonly < KubeObjectMetaProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#defaulthiddenfields","text":"\u25aa Static defaultHiddenFields : keyof KubeObjectMetadata []","title":"defaultHiddenFields"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#ishidden","text":"\u25b8 isHidden ( field ): boolean","title":"isHidden"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.KubeObjectMeta/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/","text":"Class: LineProgress # Renderer . Component .LineProgress Hierarchy # PureComponent < LineProgressProps > \u21b3 LineProgress Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new LineProgress ( props ) Parameters # Name Type props LineProgressProps | Readonly < LineProgressProps > Inherited from # React.PureComponent.constructor \u2022 new LineProgress ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props LineProgressProps context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.PureComponent.context props # \u2022 Readonly props : Readonly < LineProgressProps > & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.PureComponent.contextType defaultProps # \u25aa Static defaultProps : LineProgressProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < LineProgressProps > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < LineProgressProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < LineProgressProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < LineProgressProps > nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < LineProgressProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < LineProgressProps > prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < LineProgressProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < LineProgressProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: LineProgress"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#class-lineprogress","text":"Renderer . Component .LineProgress","title":"Class: LineProgress"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#hierarchy","text":"PureComponent < LineProgressProps > \u21b3 LineProgress","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#constructor","text":"\u2022 new LineProgress ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#props","text":"\u2022 Readonly props : Readonly < LineProgressProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#defaultprops","text":"\u25aa Static defaultProps : LineProgressProps","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.LineProgress/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/","text":"Class: MainLayout # Renderer . Component .MainLayout Main layout is commonly used as a wrapper for \"global pages\" link https://api-docs.k8slens.dev/master/extensions/capabilities/common-capabilities/#global-pages Hierarchy # Component < Props > \u21b3 MainLayout Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onSidebarResize render setState shouldComponentUpdate Constructors # constructor # \u2022 new MainLayout ( props ) Parameters # Name Type props Props | Readonly < Props > Inherited from # React.Component.constructor \u2022 new MainLayout ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < Props > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onSidebarResize # \u25b8 onSidebarResize ( width ): void Parameters # Name Type width number Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Props >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: MainLayout"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#class-mainlayout","text":"Renderer . Component .MainLayout Main layout is commonly used as a wrapper for \"global pages\" link https://api-docs.k8slens.dev/master/extensions/capabilities/common-capabilities/#global-pages","title":"Class: MainLayout"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#hierarchy","text":"Component < Props > \u21b3 MainLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onSidebarResize render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#constructor","text":"\u2022 new MainLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#props","text":"\u2022 Readonly props : Readonly < Props > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#onsidebarresize","text":"\u25b8 onSidebarResize ( width ): void","title":"onSidebarResize"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.MainLayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Menu/","text":"Class: Menu # Renderer . Component .Menu Hierarchy # Component < MenuProps , State > \u21b3 Menu Table of contents # Constructors # constructor Properties # context elem items opener props refs state contextType defaultProps Accessors # focusableItems focusedItem isOpen Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindItemRef bindRef close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focusNextItem forceUpdate getSnapshotBeforeUpdate onBlur onClickOutside onContextMenu onKeyDown onScrollOutside onWindowResize open refreshPosition render setState shouldComponentUpdate toggle Constructors # constructor # \u2022 new Menu ( props ) Parameters # Name Type props MenuProps Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context elem # \u2022 elem : HTMLUListElement items # \u2022 Protected items : Object = {} Index signature # \u25aa [index: number ]: MenuItem opener # \u2022 opener : HTMLElement props # \u2022 Readonly props : Readonly < MenuProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : State = {} Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # focusableItems # \u2022 Protected get focusableItems (): MenuItem [] Returns # MenuItem [] focusedItem # \u2022 Protected get focusedItem (): MenuItem Returns # MenuItem isOpen # \u2022 get isOpen (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuProps > nextState Readonly < State > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindItemRef # \u25b8 Protected bindItemRef ( item , index ): void Parameters # Name Type item MenuItem index number Returns # void bindRef # \u25b8 Protected bindRef ( elem ): void Parameters # Name Type elem HTMLUListElement Returns # void close # \u25b8 close (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 componentDidUpdate ( prevProps ): void Parameters # Name Type prevProps MenuProps Returns # void Overrides # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuProps > nextState Readonly < State > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate focusNextItem # \u25b8 Protected focusNextItem ( reverse? ): void Parameters # Name Type Default value reverse boolean false Returns # void forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < MenuProps > prevState Readonly < State > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onBlur # \u25b8 onBlur (): void Returns # void onClickOutside # \u25b8 onClickOutside ( evt ): void Parameters # Name Type evt MouseEvent Returns # void onContextMenu # \u25b8 onContextMenu (): void Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void onScrollOutside # \u25b8 onScrollOutside ( evt ): void Parameters # Name Type evt UIEvent Returns # void onWindowResize # \u25b8 onWindowResize (): void Returns # void open # \u25b8 open (): void Returns # void refreshPosition # \u25b8 refreshPosition (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends keyof State Parameters # Name Type state State | ( prevState : Readonly < State >, props : Readonly < MenuProps >) => State | Pick < State , K > | Pick < State , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < MenuProps > nextState Readonly < State > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate toggle # \u25b8 toggle (): void Returns # void","title":"Class: Menu"},{"location":"extensions/api/classes/Renderer.Component.Menu/#class-menu","text":"Renderer . Component .Menu","title":"Class: Menu"},{"location":"extensions/api/classes/Renderer.Component.Menu/#hierarchy","text":"Component < MenuProps , State > \u21b3 Menu","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Menu/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Menu/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Menu/#properties","text":"context elem items opener props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Menu/#accessors","text":"focusableItems focusedItem isOpen","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Menu/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindItemRef bindRef close componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focusNextItem forceUpdate getSnapshotBeforeUpdate onBlur onClickOutside onContextMenu onKeyDown onScrollOutside onWindowResize open refreshPosition render setState shouldComponentUpdate toggle","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Menu/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Menu/#constructor","text":"\u2022 new Menu ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Menu/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Menu/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Menu/#elem","text":"\u2022 elem : HTMLUListElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Menu/#items","text":"\u2022 Protected items : Object = {}","title":"items"},{"location":"extensions/api/classes/Renderer.Component.Menu/#opener","text":"\u2022 opener : HTMLElement","title":"opener"},{"location":"extensions/api/classes/Renderer.Component.Menu/#props","text":"\u2022 Readonly props : Readonly < MenuProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Menu/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Menu/#state","text":"\u2022 state : State = {}","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Menu/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Menu/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Menu/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Menu/#focusableitems","text":"\u2022 Protected get focusableItems (): MenuItem []","title":"focusableItems"},{"location":"extensions/api/classes/Renderer.Component.Menu/#focuseditem","text":"\u2022 Protected get focusedItem (): MenuItem","title":"focusedItem"},{"location":"extensions/api/classes/Renderer.Component.Menu/#isopen","text":"\u2022 get isOpen (): boolean","title":"isOpen"},{"location":"extensions/api/classes/Renderer.Component.Menu/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Menu/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Menu/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Menu/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Menu/#binditemref","text":"\u25b8 Protected bindItemRef ( item , index ): void","title":"bindItemRef"},{"location":"extensions/api/classes/Renderer.Component.Menu/#bindref","text":"\u25b8 Protected bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.Menu/#close","text":"\u25b8 close (): void","title":"close"},{"location":"extensions/api/classes/Renderer.Component.Menu/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Menu/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Menu/#componentdidupdate","text":"\u25b8 componentDidUpdate ( prevProps ): void","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Menu/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Menu/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Menu/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Menu/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Menu/#focusnextitem","text":"\u25b8 Protected focusNextItem ( reverse? ): void","title":"focusNextItem"},{"location":"extensions/api/classes/Renderer.Component.Menu/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Menu/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Menu/#onblur","text":"\u25b8 onBlur (): void","title":"onBlur"},{"location":"extensions/api/classes/Renderer.Component.Menu/#onclickoutside","text":"\u25b8 onClickOutside ( evt ): void","title":"onClickOutside"},{"location":"extensions/api/classes/Renderer.Component.Menu/#oncontextmenu","text":"\u25b8 onContextMenu (): void","title":"onContextMenu"},{"location":"extensions/api/classes/Renderer.Component.Menu/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Menu/#onscrolloutside","text":"\u25b8 onScrollOutside ( evt ): void","title":"onScrollOutside"},{"location":"extensions/api/classes/Renderer.Component.Menu/#onwindowresize","text":"\u25b8 onWindowResize (): void","title":"onWindowResize"},{"location":"extensions/api/classes/Renderer.Component.Menu/#open","text":"\u25b8 open (): void","title":"open"},{"location":"extensions/api/classes/Renderer.Component.Menu/#refreshposition","text":"\u25b8 refreshPosition (): void","title":"refreshPosition"},{"location":"extensions/api/classes/Renderer.Component.Menu/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Menu/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Menu/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Menu/#toggle","text":"\u25b8 toggle (): void","title":"toggle"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/","text":"Class: MenuActions # Renderer . Component .MenuActions Hierarchy # Component < MenuActionsProps > \u21b3 MenuActions Table of contents # Constructors # constructor Properties # context id isOpen props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate remove render renderTriggerIcon setState shouldComponentUpdate toggle Constructors # constructor # \u2022 new MenuActions ( props ) Parameters # Name Type props MenuActionsProps Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context id # \u2022 id : string isOpen # \u2022 isOpen : boolean = !!this.props.toolbar props # \u2022 Readonly props : Readonly < MenuActionsProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : MenuActionsProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuActionsProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuActionsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < MenuActionsProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuActionsProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuActionsProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < MenuActionsProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate remove # \u25b8 remove (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderTriggerIcon # \u25b8 renderTriggerIcon (): Element Returns # Element setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < MenuActionsProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < MenuActionsProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate toggle # \u25b8 toggle (): void Returns # void","title":"Class: MenuActions"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#class-menuactions","text":"Renderer . Component .MenuActions","title":"Class: MenuActions"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#hierarchy","text":"Component < MenuActionsProps > \u21b3 MenuActions","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#properties","text":"context id isOpen props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate remove render renderTriggerIcon setState shouldComponentUpdate toggle","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#constructor","text":"\u2022 new MenuActions ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#id","text":"\u2022 id : string","title":"id"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#isopen","text":"\u2022 isOpen : boolean = !!this.props.toolbar","title":"isOpen"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#props","text":"\u2022 Readonly props : Readonly < MenuActionsProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#defaultprops","text":"\u25aa Static defaultProps : MenuActionsProps","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#remove","text":"\u25b8 remove (): void","title":"remove"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#rendertriggericon","text":"\u25b8 renderTriggerIcon (): Element","title":"renderTriggerIcon"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuActions/#toggle","text":"\u25b8 toggle (): void","title":"toggle"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/","text":"Class: MenuItem # Renderer . Component .MenuItem Hierarchy # Component < MenuItemProps > \u21b3 MenuItem Table of contents # Constructors # constructor Properties # context elem props refs state contextType defaultProps Accessors # isFocusable isLink Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick render setState shouldComponentUpdate Constructors # constructor # \u2022 new MenuItem ( props ) Parameters # Name Type props MenuItemProps Overrides # React.Component.constructor Properties # context # \u2022 context : Menu Overrides # React.Component.context elem # \u2022 elem : HTMLElement props # \u2022 Readonly props : Readonly < MenuItemProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static contextType : Context < Menu > Overrides # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # isFocusable # \u2022 get isFocusable (): boolean Returns # boolean isLink # \u2022 get isLink (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuItemProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuItemProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindRef # \u25b8 Protected bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < MenuItemProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuItemProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuItemProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < MenuItemProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < Element , MouseEvent > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < MenuItemProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < MenuItemProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: MenuItem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#class-menuitem","text":"Renderer . Component .MenuItem","title":"Class: MenuItem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#hierarchy","text":"Component < MenuItemProps > \u21b3 MenuItem","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties","text":"context elem props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors","text":"isFocusable isLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#constructor","text":"\u2022 new MenuItem ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#context","text":"\u2022 context : Menu","title":"context"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#props","text":"\u2022 Readonly props : Readonly < MenuItemProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#contexttype","text":"\u25aa Static contextType : Context < Menu >","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#isfocusable","text":"\u2022 get isFocusable (): boolean","title":"isFocusable"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#islink","text":"\u2022 get isLink (): boolean","title":"isLink"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#bindref","text":"\u25b8 Protected bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/","text":"Class: NamespaceSelect # Renderer . Component .NamespaceSelect Hierarchy # Component < Props > \u21b3 NamespaceSelect Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # options Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate formatOptionLabel getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new NamespaceSelect ( props ) Parameters # Name Type props Props Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < Props > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # options # \u2022 get options (): SelectOption < any >[] Returns # SelectOption < any >[] Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate formatOptionLabel # \u25b8 formatOptionLabel ( option ): Object Parameters # Name Type option SelectOption < any > Returns # Object getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Props >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: NamespaceSelect"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#class-namespaceselect","text":"Renderer . Component .NamespaceSelect","title":"Class: NamespaceSelect"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#hierarchy","text":"Component < Props > \u21b3 NamespaceSelect","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#accessors","text":"options","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate formatOptionLabel getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#constructor","text":"\u2022 new NamespaceSelect ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#props","text":"\u2022 Readonly props : Readonly < Props > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#options","text":"\u2022 get options (): SelectOption < any >[]","title":"options"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#formatoptionlabel","text":"\u25b8 formatOptionLabel ( option ): Object","title":"formatOptionLabel"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelect/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/","text":"Class: NamespaceSelectFilter # Renderer . Component .NamespaceSelectFilter Hierarchy # Component < SelectProps > \u21b3 NamespaceSelectFilter Table of contents # Constructors # constructor Properties # context props refs state contextType isMenuOpen isMultiSelection Accessors # isMenuOpen isMultiSelection Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate formatOptionLabel getSnapshotBeforeUpdate onChange onClick onKeyDown onKeyUp render reset setState shouldComponentUpdate Constructors # constructor # \u2022 new NamespaceSelectFilter ( props ) Parameters # Name Type props SelectProps < any > Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < SelectProps < any >> & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType isMenuOpen # \u25aa Static isMenuOpen : IObservableValue < boolean > isMultiSelection # \u25aa Static isMultiSelection : IObservableValue < boolean > Accessors # isMenuOpen # \u2022 get isMenuOpen (): boolean Returns # boolean \u2022 set isMenuOpen ( val ): void Parameters # Name Type val boolean Returns # void isMultiSelection # \u2022 get isMultiSelection (): boolean Returns # boolean \u2022 set isMultiSelection ( val ): void Parameters # Name Type val boolean Returns # void Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SelectProps < any >> nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SelectProps < any >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < SelectProps < any >> prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SelectProps < any >> nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SelectProps < any >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate formatOptionLabel # \u25b8 formatOptionLabel ( __namedParameters ): ReactNode Parameters # Name Type __namedParameters SelectOption < any > Returns # ReactNode getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < SelectProps < any >> prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onChange # \u25b8 onChange ( __namedParameters ): void Parameters # Name Type __namedParameters SelectOption < any >[] Returns # void onClick # \u25b8 onClick (): void Returns # void onKeyDown # \u25b8 onKeyDown ( e ): void Parameters # Name Type e KeyboardEvent < Element > Returns # void onKeyUp # \u25b8 onKeyUp ( e ): void Parameters # Name Type e KeyboardEvent < Element > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render reset # \u25b8 reset (): void Returns # void setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SelectProps < any >>) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < SelectProps < any >> nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: NamespaceSelectFilter"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#class-namespaceselectfilter","text":"Renderer . Component .NamespaceSelectFilter","title":"Class: NamespaceSelectFilter"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#hierarchy","text":"Component < SelectProps > \u21b3 NamespaceSelectFilter","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#properties","text":"context props refs state contextType isMenuOpen isMultiSelection","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#accessors","text":"isMenuOpen isMultiSelection","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate formatOptionLabel getSnapshotBeforeUpdate onChange onClick onKeyDown onKeyUp render reset setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#constructor","text":"\u2022 new NamespaceSelectFilter ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#props","text":"\u2022 Readonly props : Readonly < SelectProps < any >> & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#ismenuopen","text":"\u25aa Static isMenuOpen : IObservableValue < boolean >","title":"isMenuOpen"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#ismultiselection","text":"\u25aa Static isMultiSelection : IObservableValue < boolean >","title":"isMultiSelection"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#ismenuopen_1","text":"\u2022 get isMenuOpen (): boolean","title":"isMenuOpen"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#ismultiselection_1","text":"\u2022 get isMultiSelection (): boolean","title":"isMultiSelection"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#formatoptionlabel","text":"\u25b8 formatOptionLabel ( __namedParameters ): ReactNode","title":"formatOptionLabel"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#onchange","text":"\u25b8 onChange ( __namedParameters ): void","title":"onChange"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#onclick","text":"\u25b8 onClick (): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#onkeydown","text":"\u25b8 onKeyDown ( e ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#onkeyup","text":"\u25b8 onKeyUp ( e ): void","title":"onKeyUp"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.NamespaceSelectFilter/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Notifications/","text":"Class: Notifications # Renderer . Component .Notifications Hierarchy # Component \u21b3 Notifications Table of contents # Constructors # constructor Properties # context elem props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getMessage getSnapshotBeforeUpdate render scrollToLastNotification setState shouldComponentUpdate error info ok shortInfo Constructors # constructor # \u2022 new Notifications ( props ) Parameters # Name Type props {} | Readonly < Object > Inherited from # React.Component.constructor \u2022 new Notifications ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Object context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context elem # \u2022 elem : HTMLElement props # \u2022 Readonly props : Readonly < Object > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < Object > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getMessage # \u25b8 getMessage ( notification ): ( ReactChild | ReactFragment | ReactPortal )[] Parameters # Name Type notification Notification Returns # ( ReactChild | ReactFragment | ReactPortal )[] getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < Object > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render scrollToLastNotification # \u25b8 scrollToLastNotification (): void Returns # void setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Object >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < Object > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate error # \u25b8 Static error ( message , customOpts? ): void Parameters # Name Type message NotificationMessage customOpts Partial < Notification > Returns # void info # \u25b8 Static info ( message , customOpts? ): () => void Parameters # Name Type message NotificationMessage customOpts Partial < Notification > Returns # fn \u25b8 (): void Returns # void ok # \u25b8 Static ok ( message ): void Parameters # Name Type message NotificationMessage Returns # void shortInfo # \u25b8 Static shortInfo ( message , customOpts? ): void Parameters # Name Type message NotificationMessage customOpts Partial < Notification > Returns # void","title":"Class: Notifications"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#class-notifications","text":"Renderer . Component .Notifications","title":"Class: Notifications"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#hierarchy","text":"Component \u21b3 Notifications","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#properties","text":"context elem props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getMessage getSnapshotBeforeUpdate render scrollToLastNotification setState shouldComponentUpdate error info ok shortInfo","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#constructor","text":"\u2022 new Notifications ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#props","text":"\u2022 Readonly props : Readonly < Object > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#getmessage","text":"\u25b8 getMessage ( notification ): ( ReactChild | ReactFragment | ReactPortal )[]","title":"getMessage"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#scrolltolastnotification","text":"\u25b8 scrollToLastNotification (): void","title":"scrollToLastNotification"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#error","text":"\u25b8 Static error ( message , customOpts? ): void","title":"error"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#info","text":"\u25b8 Static info ( message , customOpts? ): () => void","title":"info"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#ok","text":"\u25b8 Static ok ( message ): void","title":"ok"},{"location":"extensions/api/classes/Renderer.Component.Notifications/#shortinfo","text":"\u25b8 Static shortInfo ( message , customOpts? ): void","title":"shortInfo"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/","text":"Class: NotificationsStore # Renderer . Component .NotificationsStore Table of contents # Constructors # constructor Properties # autoHideTimers notifications Methods # add addAutoHideTimer getById remove removeAutoHideTimer Constructors # constructor # \u2022 new NotificationsStore () Properties # autoHideTimers # \u2022 Protected autoHideTimers : Map < NotificationId , number > notifications # \u2022 notifications : IObservableArray < Notification > Methods # add # \u25b8 add ( notification ): () => void Parameters # Name Type notification Notification Returns # fn \u25b8 (): void Returns # void addAutoHideTimer # \u25b8 addAutoHideTimer ( id ): void Parameters # Name Type id NotificationId Returns # void getById # \u25b8 getById ( id ): Notification Parameters # Name Type id NotificationId Returns # Notification remove # \u25b8 remove ( id ): void Parameters # Name Type id NotificationId Returns # void removeAutoHideTimer # \u25b8 removeAutoHideTimer ( id ): void Parameters # Name Type id NotificationId Returns # void","title":"Class: NotificationsStore"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#class-notificationsstore","text":"Renderer . Component .NotificationsStore","title":"Class: NotificationsStore"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties","text":"autoHideTimers notifications","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods","text":"add addAutoHideTimer getById remove removeAutoHideTimer","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#constructor","text":"\u2022 new NotificationsStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#autohidetimers","text":"\u2022 Protected autoHideTimers : Map < NotificationId , number >","title":"autoHideTimers"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#notifications","text":"\u2022 notifications : IObservableArray < Notification >","title":"notifications"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#add","text":"\u25b8 add ( notification ): () => void","title":"add"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#addautohidetimer","text":"\u25b8 addAutoHideTimer ( id ): void","title":"addAutoHideTimer"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#getbyid","text":"\u25b8 getById ( id ): Notification","title":"getById"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#remove","text":"\u25b8 remove ( id ): void","title":"remove"},{"location":"extensions/api/classes/Renderer.Component.NotificationsStore/#removeautohidetimer","text":"\u25b8 removeAutoHideTimer ( id ): void","title":"removeAutoHideTimer"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/","text":"Class: PageLayout # Renderer . Component .PageLayout PageLayout is deprecated. See MainLayout & SettingLayout deprecated Hierarchy # SettingLayout \u21b3 PageLayout Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onEscapeKey render setState shouldComponentUpdate Constructors # constructor # \u2022 new PageLayout ( props ) Parameters # Name Type props SettingLayoutProps | Readonly < SettingLayoutProps > Inherited from # SettingLayout . constructor \u2022 new PageLayout ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SettingLayoutProps context any Inherited from # SettingLayout . constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # SettingLayout . context props # \u2022 Readonly props : Readonly < SettingLayoutProps > & Readonly < Object > Inherited from # SettingLayout . props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # SettingLayout . refs state # \u2022 state : Readonly < Object > Inherited from # SettingLayout . state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # SettingLayout . contextType defaultProps # \u25aa Static defaultProps : object Inherited from # SettingLayout . defaultProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # SettingLayout . UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextContext any Returns # void Inherited from # SettingLayout . UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # SettingLayout . UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # SettingLayout . componentDidCatch componentDidMount # \u25b8 componentDidMount (): Promise < void > Returns # Promise < void > Inherited from # SettingLayout . componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < SettingLayoutProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # SettingLayout . componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # SettingLayout . componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextContext any Returns # void Inherited from # SettingLayout . componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Inherited from # SettingLayout . componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # SettingLayout . componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # SettingLayout . forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < SettingLayoutProps > prevState Readonly < Object > Returns # any Inherited from # SettingLayout . getSnapshotBeforeUpdate onEscapeKey # \u25b8 onEscapeKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void Inherited from # SettingLayout . onEscapeKey render # \u25b8 render (): Element Returns # Element Inherited from # SettingLayout . render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SettingLayoutProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # SettingLayout . setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # SettingLayout . shouldComponentUpdate","title":"Class: PageLayout"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#class-pagelayout","text":"Renderer . Component .PageLayout PageLayout is deprecated. See MainLayout & SettingLayout deprecated","title":"Class: PageLayout"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#hierarchy","text":"SettingLayout \u21b3 PageLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onEscapeKey render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#constructor","text":"\u2022 new PageLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#props","text":"\u2022 Readonly props : Readonly < SettingLayoutProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentdidmount","text":"\u25b8 componentDidMount (): Promise < void >","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#onescapekey","text":"\u25b8 onEscapeKey ( evt ): void","title":"onEscapeKey"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.PageLayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.PieChart/","text":"Class: PieChart # Renderer . Component .PieChart Hierarchy # Component < Props > \u21b3 PieChart Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new PieChart ( props ) Parameters # Name Type props Props | Readonly < Props > Inherited from # React.Component.constructor \u2022 new PieChart ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < Props > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Props >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: PieChart"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#class-piechart","text":"Renderer . Component .PieChart","title":"Class: PieChart"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#hierarchy","text":"Component < Props > \u21b3 PieChart","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#constructor","text":"\u2022 new PieChart ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#props","text":"\u2022 Readonly props : Readonly < Props > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.PieChart/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/","text":"Class: PodDetailsList # Renderer . Component .PodDetailsList Hierarchy # Component < Props > \u21b3 PodDetailsList Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getTableRow render renderCpuUsage renderMemoryUsage setState shouldComponentUpdate Constructors # constructor # \u2022 new PodDetailsList ( props ) Parameters # Name Type props Props | Readonly < Props > Inherited from # React.Component.constructor \u2022 new PodDetailsList ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < Props > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : OptionalProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate getTableRow # \u25b8 getTableRow ( uid ): Element Parameters # Name Type uid string Returns # Element render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderCpuUsage # \u25b8 renderCpuUsage ( id , usage ): string | 0 | Element Parameters # Name Type id string usage number Returns # string | 0 | Element renderMemoryUsage # \u25b8 renderMemoryUsage ( id , usage ): string | 0 | Element Parameters # Name Type id string usage number Returns # string | 0 | Element setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Props >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: PodDetailsList"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#class-poddetailslist","text":"Renderer . Component .PodDetailsList","title":"Class: PodDetailsList"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#hierarchy","text":"Component < Props > \u21b3 PodDetailsList","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getTableRow render renderCpuUsage renderMemoryUsage setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#constructor","text":"\u2022 new PodDetailsList ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#props","text":"\u2022 Readonly props : Readonly < Props > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#defaultprops","text":"\u25aa Static defaultProps : OptionalProps","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#gettablerow","text":"\u25b8 getTableRow ( uid ): Element","title":"getTableRow"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#rendercpuusage","text":"\u25b8 renderCpuUsage ( id , usage ): string | 0 | Element","title":"renderCpuUsage"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#rendermemoryusage","text":"\u25b8 renderMemoryUsage ( id , usage ): string | 0 | Element","title":"renderMemoryUsage"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Radio/","text":"Class: Radio # Renderer . Component .Radio Hierarchy # Component < RadioProps > \u21b3 Radio Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onChange onKeyDown render setState shouldComponentUpdate Constructors # constructor # \u2022 new Radio ( props ) Parameters # Name Type props RadioProps | Readonly < RadioProps > Inherited from # React.Component.constructor \u2022 new Radio ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props RadioProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < RadioProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < RadioProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < RadioProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < RadioProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < RadioProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < RadioProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < RadioProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onChange # \u25b8 onChange (): void Returns # void onKeyDown # \u25b8 onKeyDown ( e ): void Parameters # Name Type e KeyboardEvent < any > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < RadioProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < RadioProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Radio"},{"location":"extensions/api/classes/Renderer.Component.Radio/#class-radio","text":"Renderer . Component .Radio","title":"Class: Radio"},{"location":"extensions/api/classes/Renderer.Component.Radio/#hierarchy","text":"Component < RadioProps > \u21b3 Radio","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Radio/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Radio/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Radio/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Radio/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onChange onKeyDown render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Radio/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Radio/#constructor","text":"\u2022 new Radio ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Radio/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Radio/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Radio/#props","text":"\u2022 Readonly props : Readonly < RadioProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Radio/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Radio/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Radio/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Radio/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Radio/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Radio/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Radio/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Radio/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Radio/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Radio/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Radio/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Radio/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Radio/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Radio/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Radio/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Radio/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Radio/#onchange","text":"\u25b8 onChange (): void","title":"onChange"},{"location":"extensions/api/classes/Renderer.Component.Radio/#onkeydown","text":"\u25b8 onKeyDown ( e ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Radio/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Radio/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Radio/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/","text":"Class: RadioGroup # Renderer . Component .RadioGroup Hierarchy # Component < RadioGroupProps , Object > \u21b3 RadioGroup Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new RadioGroup ( props ) Parameters # Name Type props RadioGroupProps | Readonly < RadioGroupProps > Inherited from # React.Component.constructor \u2022 new RadioGroup ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props RadioGroupProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < RadioGroupProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < RadioGroupProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < RadioGroupProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < RadioGroupProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < RadioGroupProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < RadioGroupProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < RadioGroupProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < RadioGroupProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < RadioGroupProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: RadioGroup"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#class-radiogroup","text":"Renderer . Component .RadioGroup","title":"Class: RadioGroup"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#hierarchy","text":"Component < RadioGroupProps , Object > \u21b3 RadioGroup","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#constructor","text":"\u2022 new RadioGroup ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#props","text":"\u2022 Readonly props : Readonly < RadioGroupProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.RadioGroup/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/","text":"Class: SearchInput # Renderer . Component .SearchInput Hierarchy # Component < Props > \u21b3 SearchInput Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate clear componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onGlobalKey onKeyDown render setState shouldComponentUpdate Constructors # constructor # \u2022 new SearchInput ( props ) Parameters # Name Type props Props | Readonly < Props > Inherited from # React.Component.constructor \u2022 new SearchInput ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < Props > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate clear # \u25b8 clear (): void Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onGlobalKey # \u25b8 onGlobalKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < any > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Props >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: SearchInput"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#class-searchinput","text":"Renderer . Component .SearchInput","title":"Class: SearchInput"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#hierarchy","text":"Component < Props > \u21b3 SearchInput","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate clear componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onGlobalKey onKeyDown render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#constructor","text":"\u2022 new SearchInput ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#props","text":"\u2022 Readonly props : Readonly < Props > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#clear","text":"\u25b8 clear (): void","title":"clear"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#onglobalkey","text":"\u25b8 onGlobalKey ( evt ): void","title":"onGlobalKey"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.SearchInput/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Select/","text":"Class: Select # Renderer . Component .Select Hierarchy # Component < SelectProps > \u21b3 Select Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # options selectedOption themeClass Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate isValidOption onChange onKeyDown render setState shouldComponentUpdate Constructors # constructor # \u2022 new Select ( props ) Parameters # Name Type props SelectProps < any > Overrides # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < SelectProps < any >> & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : SelectProps < any > Accessors # options # \u2022 get options (): SelectOption < any >[] Returns # SelectOption < any >[] selectedOption # \u2022 get selectedOption (): SelectOption < any > | SelectOption < any >[] Returns # SelectOption < any > | SelectOption < any >[] themeClass # \u2022 get themeClass (): string Returns # string Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SelectProps < any >> nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SelectProps < any >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < SelectProps < any >> prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SelectProps < any >> nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SelectProps < any >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < SelectProps < any >> prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate isValidOption # \u25b8 Protected isValidOption ( opt ): boolean Parameters # Name Type opt any Returns # boolean onChange # \u25b8 onChange ( value , meta ): void Parameters # Name Type value SelectOption < any > meta ActionMeta < any > Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < HTMLElement > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SelectProps < any >>) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < SelectProps < any >> nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Select"},{"location":"extensions/api/classes/Renderer.Component.Select/#class-select","text":"Renderer . Component .Select","title":"Class: Select"},{"location":"extensions/api/classes/Renderer.Component.Select/#hierarchy","text":"Component < SelectProps > \u21b3 Select","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Select/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Select/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Select/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Select/#accessors","text":"options selectedOption themeClass","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Select/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate isValidOption onChange onKeyDown render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Select/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Select/#constructor","text":"\u2022 new Select ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Select/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Select/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Select/#props","text":"\u2022 Readonly props : Readonly < SelectProps < any >> & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Select/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Select/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Select/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Select/#defaultprops","text":"\u25aa Static defaultProps : SelectProps < any >","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Select/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Select/#options","text":"\u2022 get options (): SelectOption < any >[]","title":"options"},{"location":"extensions/api/classes/Renderer.Component.Select/#selectedoption","text":"\u2022 get selectedOption (): SelectOption < any > | SelectOption < any >[]","title":"selectedOption"},{"location":"extensions/api/classes/Renderer.Component.Select/#themeclass","text":"\u2022 get themeClass (): string","title":"themeClass"},{"location":"extensions/api/classes/Renderer.Component.Select/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Select/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Select/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Select/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Select/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Select/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Select/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Select/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Select/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Select/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Select/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Select/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Select/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Select/#isvalidoption","text":"\u25b8 Protected isValidOption ( opt ): boolean","title":"isValidOption"},{"location":"extensions/api/classes/Renderer.Component.Select/#onchange","text":"\u25b8 onChange ( value , meta ): void","title":"onChange"},{"location":"extensions/api/classes/Renderer.Component.Select/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Select/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Select/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Select/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/","text":"Class: SettingLayout # Renderer . Component .SettingLayout Layout for settings like pages with navigation Hierarchy # Component < SettingLayoutProps > \u21b3 SettingLayout \u21b3\u21b3 PageLayout Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onEscapeKey render setState shouldComponentUpdate Constructors # constructor # \u2022 new SettingLayout ( props ) Parameters # Name Type props SettingLayoutProps | Readonly < SettingLayoutProps > Inherited from # React.Component.constructor \u2022 new SettingLayout ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SettingLayoutProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < SettingLayoutProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): Promise < void > Returns # Promise < void > Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < SettingLayoutProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < SettingLayoutProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onEscapeKey # \u25b8 onEscapeKey ( evt ): void Parameters # Name Type evt KeyboardEvent Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SettingLayoutProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: SettingLayout"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#class-settinglayout","text":"Renderer . Component .SettingLayout Layout for settings like pages with navigation","title":"Class: SettingLayout"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#hierarchy","text":"Component < SettingLayoutProps > \u21b3 SettingLayout \u21b3\u21b3 PageLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onEscapeKey render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#constructor","text":"\u2022 new SettingLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#props","text":"\u2022 Readonly props : Readonly < SettingLayoutProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentdidmount","text":"\u25b8 componentDidMount (): Promise < void >","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#onescapekey","text":"\u25b8 onEscapeKey ( evt ): void","title":"onEscapeKey"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.SettingLayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Slider/","text":"Class: Slider # Renderer . Component .Slider Hierarchy # Component < SliderProps > \u21b3 Slider Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Slider ( props ) Parameters # Name Type props SliderProps | Readonly < SliderProps > Inherited from # Component.constructor \u2022 new Slider ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SliderProps context any Inherited from # Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # Component.context props # \u2022 Readonly props : Readonly < SliderProps > & Readonly < Object > Inherited from # Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # Component.refs state # \u2022 state : Readonly < Object > Inherited from # Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # Component.contextType defaultProps # \u25aa Static defaultProps : object Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SliderProps > nextContext any Returns # void Inherited from # Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SliderProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < SliderProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SliderProps > nextContext any Returns # void Inherited from # Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SliderProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < SliderProps > prevState Readonly < Object > Returns # any Inherited from # Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SliderProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < SliderProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # Component.shouldComponentUpdate","title":"Class: Slider"},{"location":"extensions/api/classes/Renderer.Component.Slider/#class-slider","text":"Renderer . Component .Slider","title":"Class: Slider"},{"location":"extensions/api/classes/Renderer.Component.Slider/#hierarchy","text":"Component < SliderProps > \u21b3 Slider","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Slider/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Slider/#constructor","text":"\u2022 new Slider ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Slider/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Slider/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Slider/#props","text":"\u2022 Readonly props : Readonly < SliderProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Slider/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Slider/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Slider/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Slider/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Slider/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Slider/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Slider/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Slider/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Slider/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Slider/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Slider/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Slider/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Slider/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Slider/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Slider/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Slider/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Slider/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Slider/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Slider/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Slider/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Spinner/","text":"Class: Spinner # Renderer . Component .Spinner Hierarchy # Component < SpinnerProps , Object > \u21b3 Spinner Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Spinner ( props ) Parameters # Name Type props SpinnerProps | Readonly < SpinnerProps > Inherited from # React.Component.constructor \u2022 new Spinner ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SpinnerProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < SpinnerProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : Object Type declaration # Name Type center boolean singleColor boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SpinnerProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SpinnerProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < SpinnerProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SpinnerProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SpinnerProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < SpinnerProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < SpinnerProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < SpinnerProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Spinner"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#class-spinner","text":"Renderer . Component .Spinner","title":"Class: Spinner"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#hierarchy","text":"Component < SpinnerProps , Object > \u21b3 Spinner","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#constructor","text":"\u2022 new Spinner ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#props","text":"\u2022 Readonly props : Readonly < SpinnerProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#defaultprops","text":"\u25aa Static defaultProps : Object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Spinner/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/","text":"Class: StatusBrick # Renderer . Component .StatusBrick Hierarchy # Component < StatusBrickProps > \u21b3 StatusBrick Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new StatusBrick ( props ) Parameters # Name Type props StatusBrickProps | Readonly < StatusBrickProps > Inherited from # React.Component.constructor \u2022 new StatusBrick ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props StatusBrickProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < StatusBrickProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StatusBrickProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StatusBrickProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < StatusBrickProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StatusBrickProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StatusBrickProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < StatusBrickProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < StatusBrickProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < StatusBrickProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: StatusBrick"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#class-statusbrick","text":"Renderer . Component .StatusBrick","title":"Class: StatusBrick"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#hierarchy","text":"Component < StatusBrickProps > \u21b3 StatusBrick","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#constructor","text":"\u2022 new StatusBrick ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#props","text":"\u2022 Readonly props : Readonly < StatusBrickProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.StatusBrick/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Stepper/","text":"Class: Stepper # Renderer . Component .Stepper Hierarchy # Component < StepperProps , Object > \u21b3 Stepper Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Stepper ( props ) Parameters # Name Type props StepperProps | Readonly < StepperProps > Inherited from # React.Component.constructor \u2022 new Stepper ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props StepperProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < StepperProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StepperProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StepperProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < StepperProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StepperProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StepperProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < StepperProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < StepperProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < StepperProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Stepper"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#class-stepper","text":"Renderer . Component .Stepper","title":"Class: Stepper"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#hierarchy","text":"Component < StepperProps , Object > \u21b3 Stepper","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#constructor","text":"\u2022 new Stepper ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#props","text":"\u2022 Readonly props : Readonly < StepperProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Stepper/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/","text":"Class: SubTitle # Renderer . Component .SubTitle Hierarchy # Component < Props > \u21b3 SubTitle Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new SubTitle ( props ) Parameters # Name Type props Props | Readonly < Props > Inherited from # React.Component.constructor \u2022 new SubTitle ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props Props context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < Props > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < Props > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < Props >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < Props > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: SubTitle"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#class-subtitle","text":"Renderer . Component .SubTitle","title":"Class: SubTitle"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#hierarchy","text":"Component < Props > \u21b3 SubTitle","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#constructor","text":"\u2022 new SubTitle ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#props","text":"\u2022 Readonly props : Readonly < Props > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.SubTitle/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tab/","text":"Class: Tab # Renderer . Component .Tab Hierarchy # PureComponent < TabProps > \u21b3 Tab Table of contents # Constructors # constructor Properties # context props ref refs state contextType Accessors # isActive Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focus forceUpdate getSnapshotBeforeUpdate onClick onFocus onKeyDown render scrollIntoView setState shouldComponentUpdate Constructors # constructor # \u2022 new Tab ( props ) Parameters # Name Type props TabProps < any > | Readonly < TabProps < any >> Inherited from # React.PureComponent.constructor \u2022 new Tab ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TabProps < any > context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : TabsContextValue < any > Overrides # React.PureComponent.context props # \u2022 Readonly props : Readonly < TabProps < any >> & Readonly < Object > Inherited from # React.PureComponent.props ref # \u2022 ref : RefObject < HTMLDivElement > refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static contextType : Context < TabsContextValue < any >> Overrides # React.PureComponent.contextType Accessors # isActive # \u2022 get isActive (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabProps < any >> nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabProps < any >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < TabProps < any >> prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabProps < any >> nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabProps < any >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate focus # \u25b8 focus (): void Returns # void forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < TabProps < any >> prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < HTMLElement , MouseEvent > Returns # void onFocus # \u25b8 onFocus ( evt ): void Parameters # Name Type evt FocusEvent < HTMLElement , Element > Returns # void onKeyDown # \u25b8 onKeyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < HTMLElement > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render scrollIntoView # \u25b8 scrollIntoView (): void Returns # void setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TabProps < any >>) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < TabProps < any >> nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Tab"},{"location":"extensions/api/classes/Renderer.Component.Tab/#class-tab","text":"Renderer . Component .Tab","title":"Class: Tab"},{"location":"extensions/api/classes/Renderer.Component.Tab/#hierarchy","text":"PureComponent < TabProps > \u21b3 Tab","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Tab/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties","text":"context props ref refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors","text":"isActive","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate focus forceUpdate getSnapshotBeforeUpdate onClick onFocus onKeyDown render scrollIntoView setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#constructor","text":"\u2022 new Tab ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Tab/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tab/#context","text":"\u2022 context : TabsContextValue < any >","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Tab/#props","text":"\u2022 Readonly props : Readonly < TabProps < any >> & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Tab/#ref","text":"\u2022 ref : RefObject < HTMLDivElement >","title":"ref"},{"location":"extensions/api/classes/Renderer.Component.Tab/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Tab/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Tab/#contexttype","text":"\u25aa Static contextType : Context < TabsContextValue < any >>","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Tab/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tab/#isactive","text":"\u2022 get isActive (): boolean","title":"isActive"},{"location":"extensions/api/classes/Renderer.Component.Tab/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tab/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Tab/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Tab/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Tab/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tab/#focus","text":"\u25b8 focus (): void","title":"focus"},{"location":"extensions/api/classes/Renderer.Component.Tab/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tab/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onfocus","text":"\u25b8 onFocus ( evt ): void","title":"onFocus"},{"location":"extensions/api/classes/Renderer.Component.Tab/#onkeydown","text":"\u25b8 onKeyDown ( evt ): void","title":"onKeyDown"},{"location":"extensions/api/classes/Renderer.Component.Tab/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tab/#scrollintoview","text":"\u25b8 scrollIntoView (): void","title":"scrollIntoView"},{"location":"extensions/api/classes/Renderer.Component.Tab/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Tab/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Table/","text":"Class: Table- # Renderer . Component .Table Type parameters # Name Item Hierarchy # Component < TableProps < Item >> \u21b3 Table Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Accessors # sortParams Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getSorted onSort render renderHead renderRows setState shouldComponentUpdate sort Constructors # constructor # \u2022 new Table < Item >( props ) Type parameters # Name Item Parameters # Name Type props TableProps < Item > Overrides # React.Component\\>.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < TableProps < Item >> & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : TableProps < any > Accessors # sortParams # \u2022 get sortParams (): Partial < TableSortParams > Returns # Partial < TableSortParams > Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableProps < Item >> nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableProps < Item >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < TableProps < Item >> prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableProps < Item >> nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableProps < Item >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < TableProps < Item >> prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate getSorted # \u25b8 getSorted ( items ): any [] Parameters # Name Type items any [] Returns # any [] onSort # \u25b8 Protected onSort ( __namedParameters ): void Parameters # Name Type __namedParameters TableSortParams Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderHead # \u25b8 renderHead (): ReactElement < TableHeadProps , string | JSXElementConstructor < any >> Returns # ReactElement < TableHeadProps , string | JSXElementConstructor < any >> renderRows # \u25b8 renderRows (): Object Returns # Object setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TableProps < Item >>) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < TableProps < Item >> nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate sort # \u25b8 sort ( colName ): void Parameters # Name Type colName string Returns # void","title":"Class: Table"},{"location":"extensions/api/classes/Renderer.Component.Table/#class-tableitem","text":"Renderer . Component .Table","title":"Class: Table<Item>"},{"location":"extensions/api/classes/Renderer.Component.Table/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.Table/#hierarchy","text":"Component < TableProps < Item >> \u21b3 Table","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Table/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Table/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Table/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Table/#accessors","text":"sortParams","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Table/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate getSorted onSort render renderHead renderRows setState shouldComponentUpdate sort","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Table/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Table/#constructor","text":"\u2022 new Table < Item >( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Table/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Table/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Table/#props","text":"\u2022 Readonly props : Readonly < TableProps < Item >> & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Table/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Table/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Table/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Table/#defaultprops","text":"\u25aa Static defaultProps : TableProps < any >","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Table/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Table/#sortparams","text":"\u2022 get sortParams (): Partial < TableSortParams >","title":"sortParams"},{"location":"extensions/api/classes/Renderer.Component.Table/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Table/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Table/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Table/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Table/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Table/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Table/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Table/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Table/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Table/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Table/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Table/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Table/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Table/#getsorted","text":"\u25b8 getSorted ( items ): any []","title":"getSorted"},{"location":"extensions/api/classes/Renderer.Component.Table/#onsort","text":"\u25b8 Protected onSort ( __namedParameters ): void","title":"onSort"},{"location":"extensions/api/classes/Renderer.Component.Table/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Table/#renderhead","text":"\u25b8 renderHead (): ReactElement < TableHeadProps , string | JSXElementConstructor < any >>","title":"renderHead"},{"location":"extensions/api/classes/Renderer.Component.Table/#renderrows","text":"\u25b8 renderRows (): Object","title":"renderRows"},{"location":"extensions/api/classes/Renderer.Component.Table/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Table/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Table/#sort","text":"\u25b8 sort ( colName ): void","title":"sort"},{"location":"extensions/api/classes/Renderer.Component.TableCell/","text":"Class: TableCell # Renderer . Component .TableCell Hierarchy # Component < TableCellProps > \u21b3 TableCell Table of contents # Constructors # constructor Properties # context props refs state contextType Accessors # isSortable Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick render renderCheckbox renderSortIcon setState shouldComponentUpdate Constructors # constructor # \u2022 new TableCell ( props ) Parameters # Name Type props TableCellProps | Readonly < TableCellProps > Inherited from # React.Component.constructor \u2022 new TableCell ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TableCellProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < TableCellProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Accessors # isSortable # \u2022 get isSortable (): boolean Returns # boolean Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableCellProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableCellProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < TableCellProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableCellProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableCellProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < TableCellProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onClick # \u25b8 onClick ( evt ): void Parameters # Name Type evt MouseEvent < HTMLDivElement , MouseEvent > Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderCheckbox # \u25b8 renderCheckbox (): Element Returns # Element renderSortIcon # \u25b8 renderSortIcon (): Element Returns # Element setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TableCellProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < TableCellProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: TableCell"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#class-tablecell","text":"Renderer . Component .TableCell","title":"Class: TableCell"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#hierarchy","text":"Component < TableCellProps > \u21b3 TableCell","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#accessors","text":"isSortable","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate onClick render renderCheckbox renderSortIcon setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#constructor","text":"\u2022 new TableCell ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#props","text":"\u2022 Readonly props : Readonly < TableCellProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#issortable","text":"\u2022 get isSortable (): boolean","title":"isSortable"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#onclick","text":"\u25b8 onClick ( evt ): void","title":"onClick"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendercheckbox","text":"\u25b8 renderCheckbox (): Element","title":"renderCheckbox"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendersorticon","text":"\u25b8 renderSortIcon (): Element","title":"renderSortIcon"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableHead/","text":"Class: TableHead # Renderer . Component .TableHead Hierarchy # Component < TableHeadProps > \u21b3 TableHead Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new TableHead ( props ) Parameters # Name Type props TableHeadProps | Readonly < TableHeadProps > Inherited from # React.Component.constructor \u2022 new TableHead ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TableHeadProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < TableHeadProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : TableHeadProps Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableHeadProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableHeadProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < TableHeadProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableHeadProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableHeadProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < TableHeadProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TableHeadProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < TableHeadProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: TableHead"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#class-tablehead","text":"Renderer . Component .TableHead","title":"Class: TableHead"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#hierarchy","text":"Component < TableHeadProps > \u21b3 TableHead","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#constructor","text":"\u2022 new TableHead ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#props","text":"\u2022 Readonly props : Readonly < TableHeadProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#defaultprops","text":"\u25aa Static defaultProps : TableHeadProps","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.TableHead/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableRow/","text":"Class: TableRow # Renderer . Component .TableRow Hierarchy # Component < TableRowProps > \u21b3 TableRow Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new TableRow ( props ) Parameters # Name Type props TableRowProps | Readonly < TableRowProps > Inherited from # React.Component.constructor \u2022 new TableRow ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TableRowProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < TableRowProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableRowProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableRowProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < TableRowProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableRowProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableRowProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < TableRowProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TableRowProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < TableRowProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: TableRow"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#class-tablerow","text":"Renderer . Component .TableRow","title":"Class: TableRow"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#hierarchy","text":"Component < TableRowProps > \u21b3 TableRow","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#constructor","text":"\u2022 new TableRow ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#props","text":"\u2022 Readonly props : Readonly < TableRowProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tabs/","text":"Class: Tabs # Renderer . Component .Tabs Hierarchy # PureComponent < TabsProps > \u21b3 Tabs Table of contents # Constructors # constructor Properties # context elem props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new Tabs ( props ) Parameters # Name Type props TabsProps < any > | Readonly < TabsProps < any >> Inherited from # React.PureComponent.constructor \u2022 new Tabs ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props TabsProps < any > context any Inherited from # React.PureComponent.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.PureComponent.context elem # \u2022 elem : HTMLElement props # \u2022 Readonly props : Readonly < TabsProps < any >> & Readonly < Object > Inherited from # React.PureComponent.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.PureComponent.refs state # \u2022 state : Readonly < Object > Inherited from # React.PureComponent.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.PureComponent.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabsProps < any >> nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabsProps < any >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.UNSAFE_componentWillUpdate bindRef # \u25b8 Protected bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.PureComponent.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.PureComponent.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < TabsProps < any >> prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.PureComponent.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.PureComponent.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabsProps < any >> nextContext any Returns # void Inherited from # React.PureComponent.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.PureComponent.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabsProps < any >> nextState Readonly < Object > nextContext any Returns # void Inherited from # React.PureComponent.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.PureComponent.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < TabsProps < any >> prevState Readonly < Object > Returns # any Inherited from # React.PureComponent.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.PureComponent.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TabsProps < any >>) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.PureComponent.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < TabsProps < any >> nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.PureComponent.shouldComponentUpdate","title":"Class: Tabs"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#class-tabs","text":"Renderer . Component .Tabs","title":"Class: Tabs"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#hierarchy","text":"PureComponent < TabsProps > \u21b3 Tabs","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties","text":"context elem props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#constructor","text":"\u2022 new Tabs ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#props","text":"\u2022 Readonly props : Readonly < TabsProps < any >> & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#bindref","text":"\u25b8 Protected bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/","text":"Class: TerminalStore # Renderer . Component .TerminalStore Hierarchy # Singleton \u21b3 TerminalStore Table of contents # Constructors # constructor Properties # connections terminals Methods # connect disconnect getTerminal isConnected isDisconnected reconnect reset sendCommand createInstance getInstance resetInstance Constructors # constructor # \u2022 new TerminalStore () Overrides # Singleton . constructor Properties # connections # \u2022 Protected connections : ObservableMap < string , TerminalApi > terminals # \u2022 Protected terminals : Map < string , Terminal > Methods # connect # \u25b8 connect ( tabId ): void Parameters # Name Type tabId string Returns # void disconnect # \u25b8 disconnect ( tabId ): void Parameters # Name Type tabId string Returns # void getTerminal # \u25b8 getTerminal ( tabId ): Terminal Parameters # Name Type tabId string Returns # Terminal isConnected # \u25b8 isConnected ( tabId ): boolean Parameters # Name Type tabId string Returns # boolean isDisconnected # \u25b8 isDisconnected ( tabId ): boolean Parameters # Name Type tabId string Returns # boolean reconnect # \u25b8 reconnect ( tabId ): void Parameters # Name Type tabId string Returns # void reset # \u25b8 reset (): void Returns # void sendCommand # \u25b8 sendCommand ( command , options? ): Promise < void > Parameters # Name Type command string options Object options.enter? boolean options.newTab? boolean options.tabId? string Returns # Promise < void > createInstance # \u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # Singleton . createInstance getInstance # \u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # Singleton . getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # Singleton . resetInstance","title":"Class: TerminalStore"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#class-terminalstore","text":"Renderer . Component .TerminalStore","title":"Class: TerminalStore"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#hierarchy","text":"Singleton \u21b3 TerminalStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#properties","text":"connections terminals","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods","text":"connect disconnect getTerminal isConnected isDisconnected reconnect reset sendCommand createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#constructor","text":"\u2022 new TerminalStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#connections","text":"\u2022 Protected connections : ObservableMap < string , TerminalApi >","title":"connections"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#terminals","text":"\u2022 Protected terminals : Map < string , Terminal >","title":"terminals"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#connect","text":"\u25b8 connect ( tabId ): void","title":"connect"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#disconnect","text":"\u25b8 disconnect ( tabId ): void","title":"disconnect"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#getterminal","text":"\u25b8 getTerminal ( tabId ): Terminal","title":"getTerminal"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#isconnected","text":"\u25b8 isConnected ( tabId ): boolean","title":"isConnected"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#isdisconnected","text":"\u25b8 isDisconnected ( tabId ): boolean","title":"isDisconnected"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#reconnect","text":"\u25b8 reconnect ( tabId ): void","title":"reconnect"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#sendcommand","text":"\u25b8 sendCommand ( command , options? ): Promise < void >","title":"sendCommand"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#createinstance","text":"\u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#getinstance","text":"\u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/","text":"Class: Tooltip # Renderer . Component .Tooltip Hierarchy # Component < TooltipProps > \u21b3 Tooltip Table of contents # Constructors # constructor Properties # activePosition context elem isVisible props refs state contextType defaultProps Accessors # hoverTarget targetElem Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getPosition getSnapshotBeforeUpdate onEnterTarget onLeaveTarget refreshPosition render setPosition setState shouldComponentUpdate Constructors # constructor # \u2022 new Tooltip ( props ) Parameters # Name Type props TooltipProps Overrides # React.Component.constructor Properties # activePosition # \u2022 activePosition : TooltipPosition context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context elem # \u2022 elem : HTMLElement isVisible # \u2022 isVisible : boolean = !!this.props.visible props # \u2022 Readonly props : Readonly < TooltipProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : object Accessors # hoverTarget # \u2022 get hoverTarget (): HTMLElement Returns # HTMLElement targetElem # \u2022 get targetElem (): HTMLElement Returns # HTMLElement Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TooltipProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TooltipProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate bindRef # \u25b8 bindRef ( elem ): void Parameters # Name Type elem HTMLElement Returns # void componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 componentDidMount (): void Returns # void Overrides # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < TooltipProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TooltipProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TooltipProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getPosition # \u25b8 Protected getPosition ( position , tooltipBounds , targetBounds ): Object Parameters # Name Type position TooltipPosition tooltipBounds DOMRect targetBounds DOMRect Returns # Object Name Type bottom number left number right number top number getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < TooltipProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate onEnterTarget # \u25b8 Protected onEnterTarget (): void Returns # void onLeaveTarget # \u25b8 Protected onLeaveTarget (): void Returns # void refreshPosition # \u25b8 refreshPosition (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setPosition # \u25b8 Protected setPosition ( pos ): void Parameters # Name Type pos Object pos.left number pos.top number Returns # void setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < TooltipProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < TooltipProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Tooltip"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#class-tooltip","text":"Renderer . Component .Tooltip","title":"Class: Tooltip"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#hierarchy","text":"Component < TooltipProps > \u21b3 Tooltip","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#properties","text":"activePosition context elem isVisible props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#accessors","text":"hoverTarget targetElem","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate bindRef componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getPosition getSnapshotBeforeUpdate onEnterTarget onLeaveTarget refreshPosition render setPosition setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#constructor","text":"\u2022 new Tooltip ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#activeposition","text":"\u2022 activePosition : TooltipPosition","title":"activePosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#elem","text":"\u2022 elem : HTMLElement","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#isvisible","text":"\u2022 isVisible : boolean = !!this.props.visible","title":"isVisible"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#props","text":"\u2022 Readonly props : Readonly < TooltipProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#defaultprops","text":"\u25aa Static defaultProps : object","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#hovertarget","text":"\u2022 get hoverTarget (): HTMLElement","title":"hoverTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#targetelem","text":"\u2022 get targetElem (): HTMLElement","title":"targetElem"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#bindref","text":"\u25b8 bindRef ( elem ): void","title":"bindRef"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentdidmount","text":"\u25b8 componentDidMount (): void","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#getposition","text":"\u25b8 Protected getPosition ( position , tooltipBounds , targetBounds ): Object","title":"getPosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#onentertarget","text":"\u25b8 Protected onEnterTarget (): void","title":"onEnterTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#onleavetarget","text":"\u25b8 Protected onLeaveTarget (): void","title":"onLeaveTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#refreshposition","text":"\u25b8 refreshPosition (): void","title":"refreshPosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#setposition","text":"\u25b8 Protected setPosition ( pos ): void","title":"setPosition"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.Wizard/","text":"Class: Wizard # Renderer . Component .Wizard Hierarchy # Component < WizardProps , State > \u21b3 Wizard Table of contents # Constructors # constructor Properties # context props refs state contextType Accessors # step steps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate firstStep forceUpdate getSnapshotBeforeUpdate getValidStep isFirstStep isLastStep lastStep nextStep prevStep render setState shouldComponentUpdate Constructors # constructor # \u2022 new Wizard ( props ) Parameters # Name Type props WizardProps | Readonly < WizardProps > Inherited from # React.Component.constructor \u2022 new Wizard ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props WizardProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < WizardProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : State Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Accessors # step # \u2022 get step (): number Returns # number \u2022 set step ( step ): void Parameters # Name Type step number Returns # void steps # \u2022 get steps (): ReactElement < WizardStepProps < any >, string | JSXElementConstructor < any >>[] Returns # ReactElement < WizardStepProps < any >, string | JSXElementConstructor < any >>[] Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardProps > nextState Readonly < State > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < WizardProps > prevState Readonly < State > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardProps > nextState Readonly < State > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate firstStep # \u25b8 firstStep (): any Returns # any forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < WizardProps > prevState Readonly < State > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate getValidStep # \u25b8 Protected getValidStep ( step ): number Parameters # Name Type step number Returns # number isFirstStep # \u25b8 isFirstStep (): boolean Returns # boolean isLastStep # \u25b8 isLastStep (): boolean Returns # boolean lastStep # \u25b8 lastStep (): any Returns # any nextStep # \u25b8 nextStep (): any Returns # any prevStep # \u25b8 prevStep (): any Returns # any render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends \"step\" Parameters # Name Type state State | ( prevState : Readonly < State >, props : Readonly < WizardProps >) => State | Pick < State , K > | Pick < State , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < WizardProps > nextState Readonly < State > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Wizard"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#class-wizard","text":"Renderer . Component .Wizard","title":"Class: Wizard"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#hierarchy","text":"Component < WizardProps , State > \u21b3 Wizard","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors","text":"step steps","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate firstStep forceUpdate getSnapshotBeforeUpdate getValidStep isFirstStep isLastStep lastStep nextStep prevStep render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#constructor","text":"\u2022 new Wizard ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#props","text":"\u2022 Readonly props : Readonly < WizardProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#state","text":"\u2022 state : State","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#step","text":"\u2022 get step (): number","title":"step"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#steps","text":"\u2022 get steps (): ReactElement < WizardStepProps < any >, string | JSXElementConstructor < any >>[]","title":"steps"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#firststep","text":"\u25b8 firstStep (): any","title":"firstStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#getvalidstep","text":"\u25b8 Protected getValidStep ( step ): number","title":"getValidStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#isfirststep","text":"\u25b8 isFirstStep (): boolean","title":"isFirstStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#islaststep","text":"\u25b8 isLastStep (): boolean","title":"isLastStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#laststep","text":"\u25b8 lastStep (): any","title":"lastStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#nextstep","text":"\u25b8 nextStep (): any","title":"nextStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#prevstep","text":"\u25b8 prevStep (): any","title":"prevStep"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/","text":"Class: WizardLayout # Renderer . Component .WizardLayout Hierarchy # Component < WizardLayoutProps > \u21b3 WizardLayout Table of contents # Constructors # constructor Properties # context props refs state contextType Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate Constructors # constructor # \u2022 new WizardLayout ( props ) Parameters # Name Type props WizardLayoutProps | Readonly < WizardLayoutProps > Inherited from # React.Component.constructor \u2022 new WizardLayout ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props WizardLayoutProps context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < WizardLayoutProps > & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : Readonly < Object > Inherited from # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardLayoutProps > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < WizardLayoutProps > prevState Readonly < Object > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardLayoutProps > nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount . Returns # void Inherited from # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardLayoutProps > nextState Readonly < Object > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < WizardLayoutProps > prevState Readonly < Object > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state {} | ( prevState : Readonly < Object >, props : Readonly < WizardLayoutProps >) => {} | Pick < Object , K > | Pick < Object , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < WizardLayoutProps > nextState Readonly < Object > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: WizardLayout"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#class-wizardlayout","text":"Renderer . Component .WizardLayout","title":"Class: WizardLayout"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#hierarchy","text":"Component < WizardLayoutProps > \u21b3 WizardLayout","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#properties","text":"context props refs state contextType","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate render setState shouldComponentUpdate","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#constructor","text":"\u2022 new WizardLayout ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#props","text":"\u2022 Readonly props : Readonly < WizardLayoutProps > & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#state","text":"\u2022 state : Readonly < Object >","title":"state"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#componentwillunmount","text":"\u25b8 Optional componentWillUnmount (): void Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount .","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.WizardLayout/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/","text":"Class: WizardStep # Renderer . Component .WizardStep Hierarchy # Component < WizardStepProps , WizardStepState > \u21b3 WizardStep Table of contents # Constructors # constructor Properties # context props refs state contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate next prev render renderLoading setState shouldComponentUpdate submit Constructors # constructor # \u2022 new WizardStep ( props ) Parameters # Name Type props WizardStepProps < any > | Readonly < WizardStepProps < any >> Inherited from # React.Component.constructor \u2022 new WizardStep ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props WizardStepProps < any > context any Inherited from # React.Component.constructor Properties # context # \u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html Inherited from # React.Component.context props # \u2022 Readonly props : Readonly < WizardStepProps < any >> & Readonly < Object > Inherited from # React.Component.props refs # \u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs Index signature # \u25aa [key: string ]: ReactInstance Inherited from # React.Component.refs state # \u2022 state : WizardStepState = {} Overrides # React.Component.state contextType # \u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype Inherited from # React.Component.contextType defaultProps # \u25aa Static defaultProps : WizardStepProps < any > Methods # UNSAFE_componentWillMount # \u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps # \u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardStepProps < any >> nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate # \u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardStepProps < any >> nextState Readonly < WizardStepState > nextContext any Returns # void Inherited from # React.Component.UNSAFE_componentWillUpdate componentDidCatch # \u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount. Parameters # Name Type error Error errorInfo ErrorInfo Returns # void Inherited from # React.Component.componentDidCatch componentDidMount # \u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering. Returns # void Inherited from # React.Component.componentDidMount componentDidUpdate # \u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null. Parameters # Name Type prevProps Readonly < WizardStepProps < any >> prevState Readonly < WizardStepState > snapshot? any Returns # void Inherited from # React.Component.componentDidUpdate componentWillMount # \u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Returns # void Inherited from # React.Component.componentWillMount componentWillReceiveProps # \u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardStepProps < any >> nextContext any Returns # void Inherited from # React.Component.componentWillReceiveProps componentWillUnmount # \u25b8 componentWillUnmount (): void Returns # void Overrides # React.Component.componentWillUnmount componentWillUpdate # \u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardStepProps < any >> nextState Readonly < WizardStepState > nextContext any Returns # void Inherited from # React.Component.componentWillUpdate forceUpdate # \u25b8 forceUpdate ( callback? ): void Parameters # Name Type callback? () => void Returns # void Inherited from # React.Component.forceUpdate getSnapshotBeforeUpdate # \u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running. Parameters # Name Type prevProps Readonly < WizardStepProps < any >> prevState Readonly < WizardStepState > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate next # \u25b8 next (): void Returns # void prev # \u25b8 prev (): void Returns # void render # \u25b8 render (): Element Returns # Element Overrides # React.Component.render renderLoading # \u25b8 renderLoading (): Element Returns # Element setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends \"waiting\" Parameters # Name Type state WizardStepState | ( prevState : Readonly < WizardStepState >, props : Readonly < WizardStepProps < any >>) => WizardStepState | Pick < WizardStepState , K > | Pick < WizardStepState , K > callback? () => void Returns # void Inherited from # React.Component.setState shouldComponentUpdate # \u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called. Parameters # Name Type nextProps Readonly < WizardStepProps < any >> nextState Readonly < WizardStepState > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate submit # \u25b8 submit (): void Returns # void","title":"Class: WizardStep"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#class-wizardstep","text":"Renderer . Component .WizardStep","title":"Class: WizardStep"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#hierarchy","text":"Component < WizardStepProps , WizardStepState > \u21b3 WizardStep","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties","text":"context props refs state contextType defaultProps","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods","text":"UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate next prev render renderLoading setState shouldComponentUpdate submit","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#constructor","text":"\u2022 new WizardStep ( props )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#context","text":"\u2022 context : any If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType . Should be used with type annotation or static contextType. static contextType = MyContext // For TS pre-3.7: context !: React . ContextType < typeof MyContext > // For TS 3.7 and above: declare context : React.ContextType < typeof MyContext > see https://reactjs.org/docs/context.html","title":"context"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#props","text":"\u2022 Readonly props : Readonly < WizardStepProps < any >> & Readonly < Object >","title":"props"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#refs","text":"\u2022 refs : Object deprecated https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs","title":"refs"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#state","text":"\u2022 state : WizardStepState = {}","title":"state"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#contexttype","text":"\u25aa Static Optional contextType : Context < any > If set, this.context will be set at runtime to the current value of the given Context. Usage: type MyContext = number const Ctx = React . createContext < MyContext > ( 0 ) class Foo extends React . Component { static contextType = Ctx context !: React . ContextType < typeof Ctx > render () { return <> My context ' s value : { this . context } < />; } } see https://reactjs.org/docs/context.html#classcontexttype","title":"contextType"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#defaultprops","text":"\u25aa Static defaultProps : WizardStepProps < any >","title":"defaultProps"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#unsafe_componentwillmount","text":"\u25b8 Optional UNSAFE_componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#unsafe_componentwillreceiveprops","text":"\u25b8 Optional UNSAFE_componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#unsafe_componentwillupdate","text":"\u25b8 Optional UNSAFE_componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. This method will not stop working in React 17. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"UNSAFE_componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentdidcatch","text":"\u25b8 Optional componentDidCatch ( error , errorInfo ): void Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.","title":"componentDidCatch"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentdidmount","text":"\u25b8 Optional componentDidMount (): void Called immediately after a component is mounted. Setting state here will trigger re-rendering.","title":"componentDidMount"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentdidupdate","text":"\u25b8 Optional componentDidUpdate ( prevProps , prevState , snapshot? ): void Called immediately after updating occurs. Not called for the initial render. The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.","title":"componentDidUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentwillmount","text":"\u25b8 Optional componentWillMount (): void Called immediately before mounting occurs, and before Component#render . Avoid introducing any side-effects or subscriptions in this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillMount"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentwillreceiveprops","text":"\u25b8 Optional componentWillReceiveProps ( nextProps , nextContext ): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component#setState generally does not trigger this method. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillReceiveProps"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentwillunmount","text":"\u25b8 componentWillUnmount (): void","title":"componentWillUnmount"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#componentwillupdate","text":"\u25b8 Optional componentWillUpdate ( nextProps , nextState , nextContext ): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component#setState here. Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked. deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path","title":"componentWillUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#forceupdate","text":"\u25b8 forceUpdate ( callback? ): void","title":"forceUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#getsnapshotbeforeupdate","text":"\u25b8 Optional getSnapshotBeforeUpdate ( prevProps , prevState ): any Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it. Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.","title":"getSnapshotBeforeUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#next","text":"\u25b8 next (): void","title":"next"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#prev","text":"\u25b8 prev (): void","title":"prev"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#render","text":"\u25b8 render (): Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#renderloading","text":"\u25b8 renderLoading (): Element","title":"renderLoading"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#setstate","text":"\u25b8 setState < K >( state , callback? ): void","title":"setState"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#shouldcomponentupdate","text":"\u25b8 Optional shouldComponentUpdate ( nextProps , nextState , nextContext ): boolean Called to determine whether the change in props and state should trigger a re-render. Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed. If false is returned, Component#render , componentWillUpdate and componentDidUpdate will not be called.","title":"shouldComponentUpdate"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#submit","text":"\u25b8 submit (): void","title":"submit"},{"location":"extensions/api/classes/Renderer.Ipc/","text":"Class: Ipc # Renderer .Ipc Hierarchy # IpcRegistrar \u21b3 Ipc Table of contents # Constructors # constructor Properties # [IpcPrefix] extension Methods # broadcast invoke listen createInstance getInstance resetInstance Constructors # constructor # \u2022 new Ipc ( extension ) Parameters # Name Type extension LensExtension Overrides # IpcRegistrar.constructor Properties # [IpcPrefix] # \u2022 Readonly [IpcPrefix] : string Inherited from # IpcRegistrar.__@IpcPrefix@43995 extension # \u2022 Protected extension : LensExtension Inherited from # IpcRegistrar.extension Methods # broadcast # \u25b8 broadcast ( channel , ... args ): void Parameters # Name Type Description channel string The channel to broadcast to your whole extension, both main and renderer ...args any [] The arguments passed to all listeners Returns # void Inherited from # IpcRegistrar.broadcast invoke # \u25b8 invoke ( channel , ... args ): Promise < any > Request main to execute its function over the channel channel. This function only interacts with functions registered via Ipc.IpcMain.handleRpc An error will be thrown if no function has been registered on main with this channel ID. Parameters # Name Type Description channel string The channel to invoke a RPC on ...args any [] The arguments to pass to the RPC Returns # Promise < any > A promise of the resulting value listen # \u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension. If the lifetime of the listener should be tied to the mounted lifetime of a component then putting the returned value in a disposeOnUnmount call will suffice. Parameters # Name Type Description channel string The channel to listen for broadcasts on listener ( event : IpcRendererEvent , ... args : any []) => any The function that will be called with the arguments of the broadcast Returns # Disposer An optional disposer, Lens will cleanup even if this is not called createInstance # \u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description ...args R The constructor arguments for the child class Returns # T An instance of the child class Inherited from # IpcRegistrar.createInstance getInstance # \u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created. Type parameters # Name Type T T R extends any [] Parameters # Name Type Description strict boolean If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class Inherited from # IpcRegistrar.getInstance resetInstance # \u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that. Returns # void Inherited from # IpcRegistrar.resetInstance","title":"Class: Ipc"},{"location":"extensions/api/classes/Renderer.Ipc/#class-ipc","text":"Renderer .Ipc","title":"Class: Ipc"},{"location":"extensions/api/classes/Renderer.Ipc/#hierarchy","text":"IpcRegistrar \u21b3 Ipc","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.Ipc/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.Ipc/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Ipc/#properties","text":"[IpcPrefix] extension","title":"Properties"},{"location":"extensions/api/classes/Renderer.Ipc/#methods","text":"broadcast invoke listen createInstance getInstance resetInstance","title":"Methods"},{"location":"extensions/api/classes/Renderer.Ipc/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.Ipc/#constructor","text":"\u2022 new Ipc ( extension )","title":"constructor"},{"location":"extensions/api/classes/Renderer.Ipc/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.Ipc/#ipcprefix","text":"\u2022 Readonly [IpcPrefix] : string","title":"[IpcPrefix]"},{"location":"extensions/api/classes/Renderer.Ipc/#extension","text":"\u2022 Protected extension : LensExtension","title":"extension"},{"location":"extensions/api/classes/Renderer.Ipc/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Ipc/#broadcast","text":"\u25b8 broadcast ( channel , ... args ): void","title":"broadcast"},{"location":"extensions/api/classes/Renderer.Ipc/#invoke","text":"\u25b8 invoke ( channel , ... args ): Promise < any > Request main to execute its function over the channel channel. This function only interacts with functions registered via Ipc.IpcMain.handleRpc An error will be thrown if no function has been registered on main with this channel ID.","title":"invoke"},{"location":"extensions/api/classes/Renderer.Ipc/#listen","text":"\u25b8 listen ( channel , listener ): Disposer Listen for broadcasts within your extension. If the lifetime of the listener should be tied to the mounted lifetime of a component then putting the returned value in a disposeOnUnmount call will suffice.","title":"listen"},{"location":"extensions/api/classes/Renderer.Ipc/#createinstance","text":"\u25b8 Static createInstance < T , R >(... args ): T Creates the single instance of the child class if one was not already created. Multiple calls will return the same instance. Essentially throwing away the arguments to the subsequent calls. Note: this is a racy function, if two (or more) calls are racing to call this function only the first's arguments will be used.","title":"createInstance"},{"location":"extensions/api/classes/Renderer.Ipc/#getinstance","text":"\u25b8 Static getInstance < T , R >( strict ): T Get the instance of the child class that was previously created.","title":"getInstance"},{"location":"extensions/api/classes/Renderer.Ipc/#resetinstance","text":"\u25b8 Static resetInstance (): void Delete the instance of the child class. Note: this doesn't prevent callers of getInstance from storing the result in a global. There is no way in JS or TS to prevent globals like that.","title":"resetInstance"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/","text":"Class: CRDResourceStore # Renderer . K8sApi .CRDResourceStore Type parameters # Name Type K extends KubeObject Hierarchy # KubeObjectStore < K > \u21b3 CRDResourceStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CRDResourceStore < K >( api ) Type parameters # Name Type K extends KubeObject < KubeObjectMetadata , any , any , K > Parameters # Name Type api KubeApi < K > Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < K > Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < K > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < K , void , undefined > Returns # Generator < K , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < K > Returns # Promise < K > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < K > Returns # Promise < K > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): K [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # K [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): K Parameters # Name Type id string Returns # K Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): K [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # K [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): K Parameters # Name Type name string namespace? string Returns # K Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): K Parameters # Name Type path string Returns # K Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): K [] Returns # K [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items K [] Returns # Record < string , number > Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item K Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems K [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < K > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | K []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | K []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < K > Parameters # Name Type resourcePath string Returns # Promise < K > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < K > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < K []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < K > Returns # Promise < K []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): K [] Parameters # Name Type partialItems K [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # K [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < K > Parameters # Name Type item K patch Patch Returns # Promise < K > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | K []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | K []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item K Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item K request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): K [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items K [] the items to be sorted (default: the current items in this store) sorting ( item : K ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # K [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems K [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item K Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < K > Parameters # Name Type item K data Partial < K > Returns # Promise < K > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < K > Parameters # Name Type item K request () => Promise < K > Returns # Promise < K > Inherited from # KubeObjectStore . updateItem","title":"Class: CRDResourceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#class-crdresourcestorek","text":"Renderer . K8sApi .CRDResourceStore","title":"Class: CRDResourceStore<K>"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#type-parameters","text":"Name Type K extends KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#hierarchy","text":"KubeObjectStore < K > \u21b3 CRDResourceStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#constructor","text":"\u2022 new CRDResourceStore < K >( api )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#api","text":"\u2022 api : KubeApi < K >","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#items","text":"\u2022 items : IObservableArray < K >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#iterator","text":"\u25b8 [iterator] (): Generator < K , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#create","text":"\u25b8 create ( params , data? ): Promise < K >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < K >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): K []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): K []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyid","text":"\u25b8 getById ( id ): K","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): K []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): K","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbypath","text":"\u25b8 getByPath ( path ): K","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getitems","text":"\u25b8 getItems (): K []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#load","text":"\u25b8 load ( params ): Promise < K >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | K []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < K >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < K >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < K []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): K []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < K >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | K []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): K [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#update","text":"\u25b8 update ( item , data ): Promise < K >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < K >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/","text":"Class: CRDStore # Renderer . K8sApi .CRDStore Hierarchy # KubeObjectStore < CustomResourceDefinition > \u21b3 CRDStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady groups namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getByGroup getById getByLabel getByName getByObject getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CRDStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < CustomResourceDefinition > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < CustomResourceDefinition > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } groups # \u2022 get groups (): Record < string , CustomResourceDefinition []> Returns # Record < string , CustomResourceDefinition []> namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < CustomResourceDefinition , void , undefined > Returns # Generator < CustomResourceDefinition , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): CustomResourceDefinition [] Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): CustomResourceDefinition [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . getAllByNs getByGroup # \u25b8 getByGroup ( group , pluralName ): CustomResourceDefinition Parameters # Name Type group string pluralName string Returns # CustomResourceDefinition getById # \u25b8 getById ( id ): CustomResourceDefinition Parameters # Name Type id string Returns # CustomResourceDefinition Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): CustomResourceDefinition [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): CustomResourceDefinition Parameters # Name Type name string namespace? string Returns # CustomResourceDefinition Inherited from # KubeObjectStore . getByName getByObject # \u25b8 getByObject ( obj ): CustomResourceDefinition Parameters # Name Type obj KubeObject < KubeObjectMetadata , any , any > Returns # CustomResourceDefinition getByPath # \u25b8 getByPath ( path ): CustomResourceDefinition Parameters # Name Type path string Returns # CustomResourceDefinition Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items CustomResourceDefinition [] Returns # Record < string , number > Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item CustomResourceDefinition Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems CustomResourceDefinition [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | CustomResourceDefinition []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | CustomResourceDefinition []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < CustomResourceDefinition > Parameters # Name Type resourcePath string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < CustomResourceDefinition []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): CustomResourceDefinition [] Parameters # Name Type partialItems CustomResourceDefinition [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition patch Patch Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | CustomResourceDefinition []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | CustomResourceDefinition []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item CustomResourceDefinition Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item CustomResourceDefinition request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items ): CustomResourceDefinition [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems CustomResourceDefinition [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item CustomResourceDefinition Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition data Partial < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < CustomResourceDefinition > Parameters # Name Type item CustomResourceDefinition request () => Promise < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . updateItem","title":"Class: CRDStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#class-crdstore","text":"Renderer . K8sApi .CRDStore","title":"Class: CRDStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#hierarchy","text":"KubeObjectStore < CustomResourceDefinition > \u21b3 CRDStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors","text":"context contextItems contextReady groups namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getByGroup getById getByLabel getByName getByObject getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#constructor","text":"\u2022 new CRDStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#api","text":"\u2022 api : KubeApi < CustomResourceDefinition >","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#items","text":"\u2022 items : IObservableArray < CustomResourceDefinition >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#groups","text":"\u2022 get groups (): Record < string , CustomResourceDefinition []>","title":"groups"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#iterator","text":"\u25b8 [iterator] (): Generator < CustomResourceDefinition , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#create","text":"\u25b8 create ( params , data? ): Promise < CustomResourceDefinition >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < CustomResourceDefinition >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): CustomResourceDefinition []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): CustomResourceDefinition []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbygroup","text":"\u25b8 getByGroup ( group , pluralName ): CustomResourceDefinition","title":"getByGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyid","text":"\u25b8 getById ( id ): CustomResourceDefinition","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): CustomResourceDefinition []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): CustomResourceDefinition","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyobject","text":"\u25b8 getByObject ( obj ): CustomResourceDefinition","title":"getByObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbypath","text":"\u25b8 getByPath ( path ): CustomResourceDefinition","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getitems","text":"\u25b8 getItems (): CustomResourceDefinition []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#load","text":"\u25b8 load ( params ): Promise < CustomResourceDefinition >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | CustomResourceDefinition []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < CustomResourceDefinition >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < CustomResourceDefinition >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < CustomResourceDefinition []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): CustomResourceDefinition []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < CustomResourceDefinition >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | CustomResourceDefinition []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): CustomResourceDefinition [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#update","text":"\u25b8 update ( item , data ): Promise < CustomResourceDefinition >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < CustomResourceDefinition >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/","text":"Class: ClusterRole # Renderer . K8sApi .ClusterRole Hierarchy # KubeObject \u21b3 ClusterRole Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata rules spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRole ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata rules # \u2022 rules : { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[] spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterroles\" kind # \u25aa Static kind : string = \"ClusterRole\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRules # \u25b8 getRules (): { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[] Returns # { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[] getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < ClusterRole > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ClusterRole"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#class-clusterrole","text":"Renderer . K8sApi .ClusterRole","title":"Class: ClusterRole"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#hierarchy","text":"KubeObject \u21b3 ClusterRole","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#properties","text":"apiVersion kind managedFields metadata rules spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#constructor","text":"\u2022 new ClusterRole ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#rules","text":"\u2022 rules : { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[]","title":"rules"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#apibase","text":"\u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterroles\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#kind_1","text":"\u25aa Static kind : string = \"ClusterRole\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getrules","text":"\u25b8 getRules (): { apiGroups : string [] ; resourceNames? : string [] ; resources : string [] ; verbs : string [] }[]","title":"getRules"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/","text":"Class: ClusterRoleBinding # Renderer . K8sApi .ClusterRoleBinding Hierarchy # KubeObject \u21b3 ClusterRoleBinding Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata roleRef spec status subjects apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRoleBinding ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata roleRef # \u2022 roleRef : Object Type declaration # Name Type apiGroup? string kind string name string spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status subjects # \u2022 Optional subjects : ClusterRoleBindingSubject [] apiBase # \u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterrolebindings\" kind # \u25aa Static kind : string = \"ClusterRoleBinding\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSubjectNames # \u25b8 getSubjectNames (): string Returns # string getSubjects # \u25b8 getSubjects (): ClusterRoleBindingSubject [] Returns # ClusterRoleBindingSubject [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < ClusterRoleBinding > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ClusterRoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#class-clusterrolebinding","text":"Renderer . K8sApi .ClusterRoleBinding","title":"Class: ClusterRoleBinding"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#hierarchy","text":"KubeObject \u21b3 ClusterRoleBinding","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#properties","text":"apiVersion kind managedFields metadata roleRef spec status subjects apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#constructor","text":"\u2022 new ClusterRoleBinding ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#roleref","text":"\u2022 roleRef : Object","title":"roleRef"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#subjects","text":"\u2022 Optional subjects : ClusterRoleBindingSubject []","title":"subjects"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#apibase","text":"\u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterrolebindings\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#kind_1","text":"\u25aa Static kind : string = \"ClusterRoleBinding\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getsubjectnames","text":"\u25b8 getSubjectNames (): string","title":"getSubjectNames"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getsubjects","text":"\u25b8 getSubjects (): ClusterRoleBindingSubject []","title":"getSubjects"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/","text":"Class: ConfigMap # Renderer . K8sApi .ConfigMap Hierarchy # KubeObject \u21b3 ConfigMap Table of contents # Constructors # constructor Properties # apiVersion data kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ConfigMap ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion data # \u2022 data : Object Index signature # \u25aa [param: string ]: string kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/configmaps\" kind # \u25aa Static kind : string = \"ConfigMap\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getKeys # \u25b8 getKeys (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < ConfigMap > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#class-configmap","text":"Renderer . K8sApi .ConfigMap","title":"Class: ConfigMap"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#hierarchy","text":"KubeObject \u21b3 ConfigMap","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#properties","text":"apiVersion data kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#methods","text":"delete getAge getAnnotations getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#constructor","text":"\u2022 new ConfigMap ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#data","text":"\u2022 data : Object","title":"data"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/configmaps\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#kind_1","text":"\u25aa Static kind : string = \"ConfigMap\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getkeys","text":"\u25b8 getKeys (): string []","title":"getKeys"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/","text":"Class: ConfigMapsStore # Renderer . K8sApi .ConfigMapsStore Hierarchy # KubeObjectStore < ConfigMap > \u21b3 ConfigMapsStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ConfigMapsStore ( api? ) Parameters # Name Type api? KubeApi < ConfigMap > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < ConfigMap > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < ConfigMap > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < ConfigMap , void , undefined > Returns # Generator < ConfigMap , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): ConfigMap [] Parameters # Name Type items ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): ConfigMap [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # ConfigMap [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): ConfigMap Parameters # Name Type id string Returns # ConfigMap Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): ConfigMap [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # ConfigMap [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): ConfigMap Parameters # Name Type name string namespace? string Returns # ConfigMap Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): ConfigMap Parameters # Name Type path string Returns # ConfigMap Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items ConfigMap [] Returns # Record < string , number > Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item ConfigMap Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems ConfigMap [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | ConfigMap []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | ConfigMap []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < ConfigMap > Parameters # Name Type resourcePath string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < ConfigMap []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < ConfigMap > Returns # Promise < ConfigMap []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ConfigMap [] Parameters # Name Type partialItems ConfigMap [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # ConfigMap [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < ConfigMap > Parameters # Name Type item ConfigMap patch Patch Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | ConfigMap []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | ConfigMap []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item ConfigMap Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item ConfigMap request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): ConfigMap [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items ConfigMap [] the items to be sorted (default: the current items in this store) sorting ( item : ConfigMap ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # ConfigMap [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems ConfigMap [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item ConfigMap Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < ConfigMap > Parameters # Name Type item ConfigMap data Partial < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < ConfigMap > Parameters # Name Type item ConfigMap request () => Promise < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . updateItem","title":"Class: ConfigMapsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#class-configmapsstore","text":"Renderer . K8sApi .ConfigMapsStore","title":"Class: ConfigMapsStore"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#hierarchy","text":"KubeObjectStore < ConfigMap > \u21b3 ConfigMapsStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#constructor","text":"\u2022 new ConfigMapsStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#api","text":"\u2022 api : KubeApi < ConfigMap >","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#items","text":"\u2022 items : IObservableArray < ConfigMap >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#iterator","text":"\u25b8 [iterator] (): Generator < ConfigMap , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#create","text":"\u25b8 create ( params , data? ): Promise < ConfigMap >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < ConfigMap >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): ConfigMap []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): ConfigMap []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyid","text":"\u25b8 getById ( id ): ConfigMap","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): ConfigMap []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): ConfigMap","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbypath","text":"\u25b8 getByPath ( path ): ConfigMap","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getitems","text":"\u25b8 getItems (): ConfigMap []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#load","text":"\u25b8 load ( params ): Promise < ConfigMap >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | ConfigMap []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < ConfigMap >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < ConfigMap >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < ConfigMap []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): ConfigMap []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < ConfigMap >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | ConfigMap []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): ConfigMap [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#update","text":"\u25b8 update ( item , data ): Promise < ConfigMap >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < ConfigMap >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/","text":"Class: CronJob # Renderer . K8sApi .CronJob Hierarchy # KubeObject \u21b3 CronJob Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getSearchFields getSuspendFlag getTimeDiffFromNow isNeverRun isSuspend patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new CronJob ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type concurrencyPolicy string failedJobsHistoryLimit number jobTemplate Object jobTemplate.metadata Object jobTemplate.metadata.annotations? Object jobTemplate.metadata.creationTimestamp? string jobTemplate.metadata.labels? Object jobTemplate.spec Object jobTemplate.spec.template Object jobTemplate.spec.template.metadata Object jobTemplate.spec.template.metadata.creationTimestamp? string jobTemplate.spec.template.spec Object jobTemplate.spec.template.spec.containers IPodContainer [] jobTemplate.spec.template.spec.dnsPolicy string jobTemplate.spec.template.spec.hostPID boolean jobTemplate.spec.template.spec.restartPolicy string jobTemplate.spec.template.spec.schedulerName string jobTemplate.spec.template.spec.terminationGracePeriodSeconds number schedule string successfulJobsHistoryLimit number suspend boolean Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type lastScheduleTime? string Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/batch/v1beta1/cronjobs\" kind # \u25aa Static kind : string = \"CronJob\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLastScheduleTime # \u25b8 getLastScheduleTime (): string Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSchedule # \u25b8 getSchedule (): string Returns # string getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSuspendFlag # \u25b8 getSuspendFlag (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow isNeverRun # \u25b8 isNeverRun (): boolean Returns # boolean isSuspend # \u25b8 isSuspend (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < CronJob > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#class-cronjob","text":"Renderer . K8sApi .CronJob","title":"Class: CronJob"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#hierarchy","text":"KubeObject \u21b3 CronJob","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getSearchFields getSuspendFlag getTimeDiffFromNow isNeverRun isSuspend patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#constructor","text":"\u2022 new CronJob ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#apibase","text":"\u25aa Static apiBase : string = \"/apis/batch/v1beta1/cronjobs\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#kind_1","text":"\u25aa Static kind : string = \"CronJob\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getlastscheduletime","text":"\u25b8 getLastScheduleTime (): string","title":"getLastScheduleTime"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getschedule","text":"\u25b8 getSchedule (): string","title":"getSchedule"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getsuspendflag","text":"\u25b8 getSuspendFlag (): string","title":"getSuspendFlag"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#isneverrun","text":"\u25b8 isNeverRun (): boolean","title":"isNeverRun"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#issuspend","text":"\u25b8 isSuspend (): boolean","title":"isSuspend"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/","text":"Class: CronJobStore # Renderer . K8sApi .CronJobStore Hierarchy # KubeObjectStore < CronJob > \u21b3 CronJobStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getActiveJobsNum getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CronJobStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : CronJobApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < CronJob > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < CronJob , void , undefined > Returns # Generator < CronJob , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): CronJob [] Parameters # Name Type items CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore . filterItemsOnLoad getActiveJobsNum # \u25b8 getActiveJobsNum ( cronJob ): number Parameters # Name Type cronJob CronJob Returns # number getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): CronJob [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # CronJob [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): CronJob Parameters # Name Type id string Returns # CronJob Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): CronJob [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # CronJob [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): CronJob Parameters # Name Type name string namespace? string Returns # CronJob Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): CronJob Parameters # Name Type path string Returns # CronJob Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 getStatuses ( cronJobs? ): Object Parameters # Name Type cronJobs? CronJob [] Returns # Object Name Type scheduled number suspended number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item CronJob Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems CronJob [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CronJob > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | CronJob []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | CronJob []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < CronJob > Parameters # Name Type resourcePath string Returns # Promise < CronJob > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < CronJob > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < CronJob > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < CronJob []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < CronJob > Returns # Promise < CronJob []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): CronJob [] Parameters # Name Type partialItems CronJob [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # CronJob [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < CronJob > Parameters # Name Type item CronJob patch Patch Returns # Promise < CronJob > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | CronJob []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | CronJob []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item CronJob Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item CronJob request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): CronJob [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items CronJob [] the items to be sorted (default: the current items in this store) sorting ( item : CronJob ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # CronJob [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems CronJob [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item CronJob Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < CronJob > Parameters # Name Type item CronJob data Partial < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < CronJob > Parameters # Name Type item CronJob request () => Promise < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore . updateItem","title":"Class: CronJobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#class-cronjobstore","text":"Renderer . K8sApi .CronJobStore","title":"Class: CronJobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#hierarchy","text":"KubeObjectStore < CronJob > \u21b3 CronJobStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getActiveJobsNum getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#constructor","text":"\u2022 new CronJobStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#api","text":"\u2022 api : CronJobApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#items","text":"\u2022 items : IObservableArray < CronJob >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#iterator","text":"\u25b8 [iterator] (): Generator < CronJob , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#create","text":"\u25b8 create ( params , data? ): Promise < CronJob >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < CronJob >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): CronJob []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getactivejobsnum","text":"\u25b8 getActiveJobsNum ( cronJob ): number","title":"getActiveJobsNum"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): CronJob []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyid","text":"\u25b8 getById ( id ): CronJob","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): CronJob []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): CronJob","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbypath","text":"\u25b8 getByPath ( path ): CronJob","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getitems","text":"\u25b8 getItems (): CronJob []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getstatuses","text":"\u25b8 getStatuses ( cronJobs? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#load","text":"\u25b8 load ( params ): Promise < CronJob >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | CronJob []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < CronJob >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < CronJob >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < CronJob []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): CronJob []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < CronJob >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | CronJob []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): CronJob [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#update","text":"\u25b8 update ( item , data ): Promise < CronJob >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < CronJob >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/","text":"Class: CustomResourceDefinition # Renderer . K8sApi .CustomResourceDefinition Hierarchy # KubeObject \u21b3 CustomResourceDefinition Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getConversion getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getSearchFields getStoredVersions getTimeDiffFromNow getValidation getVersion isNamespaced patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new CustomResourceDefinition ( data ) Parameters # Name Type data CRDApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type additionalPrinterColumns? AdditionalPrinterColumnsV1Beta [] conversion Object conversion.strategy? string conversion.webhook? any group string names Object names.kind string names.listKind string names.plural string names.singular string scope string validation? object version? string versions? CRDVersion [] Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type acceptedNames Object acceptedNames.kind string acceptedNames.listKind string acceptedNames.plural string acceptedNames.shortNames string [] acceptedNames.singular string conditions { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type? : string }[] storedVersions string [] Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/apiextensions.k8s.io/v1/customresourcedefinitions\" kind # \u25aa Static kind : string = \"CustomResourceDefinition\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type? : string }[] Returns # { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type? : string }[] getConversion # \u25b8 getConversion (): string Returns # string getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getGroup # \u25b8 getGroup (): string Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNames # \u25b8 getNames (): Object Returns # Object Name Type kind string listKind string plural string singular string getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPluralName # \u25b8 getPluralName (): string Returns # string getPreferedVersion # \u25b8 getPreferedVersion (): CRDVersion Returns # CRDVersion getPrinterColumns # \u25b8 getPrinterColumns ( ignorePriority? ): AdditionalPrinterColumnsV1 [] Parameters # Name Type Default value ignorePriority boolean true Returns # AdditionalPrinterColumnsV1 [] getResourceApiBase # \u25b8 getResourceApiBase (): string Returns # string getResourceKind # \u25b8 getResourceKind (): string Returns # string getResourceTitle # \u25b8 getResourceTitle (): string Returns # string getResourceUrl # \u25b8 getResourceUrl (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScope # \u25b8 getScope (): string Returns # string getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getStoredVersions # \u25b8 getStoredVersions (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow getValidation # \u25b8 getValidation (): string Returns # string getVersion # \u25b8 getVersion (): string Returns # string isNamespaced # \u25b8 isNamespaced (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < CustomResourceDefinition > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#class-customresourcedefinition","text":"Renderer . K8sApi .CustomResourceDefinition","title":"Class: CustomResourceDefinition"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#hierarchy","text":"KubeObject \u21b3 CustomResourceDefinition","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#methods","text":"delete getAge getAnnotations getConditions getConversion getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getSearchFields getStoredVersions getTimeDiffFromNow getValidation getVersion isNamespaced patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#constructor","text":"\u2022 new CustomResourceDefinition ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#apibase","text":"\u25aa Static apiBase : string = \"/apis/apiextensions.k8s.io/v1/customresourcedefinitions\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#kind_1","text":"\u25aa Static kind : string = \"CustomResourceDefinition\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getconditions","text":"\u25b8 getConditions (): { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type? : string }[]","title":"getConditions"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getconversion","text":"\u25b8 getConversion (): string","title":"getConversion"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getgroup","text":"\u25b8 getGroup (): string","title":"getGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getnames","text":"\u25b8 getNames (): Object","title":"getNames"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getpluralname","text":"\u25b8 getPluralName (): string","title":"getPluralName"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getpreferedversion","text":"\u25b8 getPreferedVersion (): CRDVersion","title":"getPreferedVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getprintercolumns","text":"\u25b8 getPrinterColumns ( ignorePriority? ): AdditionalPrinterColumnsV1 []","title":"getPrinterColumns"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getresourceapibase","text":"\u25b8 getResourceApiBase (): string","title":"getResourceApiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getresourcekind","text":"\u25b8 getResourceKind (): string","title":"getResourceKind"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getresourcetitle","text":"\u25b8 getResourceTitle (): string","title":"getResourceTitle"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getresourceurl","text":"\u25b8 getResourceUrl (): string","title":"getResourceUrl"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getscope","text":"\u25b8 getScope (): string","title":"getScope"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getstoredversions","text":"\u25b8 getStoredVersions (): string","title":"getStoredVersions"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getvalidation","text":"\u25b8 getValidation (): string","title":"getValidation"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getversion","text":"\u25b8 getVersion (): string","title":"getVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#isnamespaced","text":"\u25b8 isNamespaced (): boolean","title":"isNamespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/","text":"Class: DaemonSet # Renderer . K8sApi .DaemonSet Hierarchy # WorkloadKubeObject \u21b3 DaemonSet Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new DaemonSet ( data ) Parameters # Name Type data KubeJsonApiData Overrides # WorkloadKubeObject.constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # WorkloadKubeObject.apiVersion kind # \u2022 kind : string Inherited from # WorkloadKubeObject.kind managedFields # \u2022 Optional managedFields : any Inherited from # WorkloadKubeObject.managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # WorkloadKubeObject.metadata spec # \u2022 spec : Object Type declaration # Name Type revisionHistoryLimit number selector Object selector.matchLabels Object template Object template.metadata Object template.metadata.creationTimestamp? string template.metadata.labels Object template.metadata.labels.name string template.spec Object template.spec.affinity? IAffinity template.spec.containers IPodContainer [] template.spec.dnsPolicy string template.spec.hostPID boolean template.spec.initContainers? IPodContainer [] template.spec.nodeSelector? Object template.spec.restartPolicy string template.spec.schedulerName string template.spec.securityContext Object template.spec.terminationGracePeriodSeconds number template.spec.tolerations { effect : string ; key : string ; operator : string ; tolerationSeconds : number }[] updateStrategy Object updateStrategy.rollingUpdate Object updateStrategy.rollingUpdate.maxUnavailable number updateStrategy.type string Overrides # WorkloadKubeObject.spec status # \u2022 status : Object Type declaration # Name Type currentNumberScheduled number desiredNumberScheduled number numberAvailable number numberMisscheduled number numberReady number numberUnavailable number observedGeneration number updatedNumberScheduled number Overrides # WorkloadKubeObject.status apiBase # \u25aa Static apiBase : string = \"/apis/apps/v1/daemonsets\" kind # \u25aa Static kind : string = \"DaemonSet\" Overrides # WorkloadKubeObject.kind namespaced # \u25aa Static namespaced : boolean = true Overrides # WorkloadKubeObject.namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # WorkloadKubeObject.delete getAffinity # \u25b8 getAffinity (): IAffinity Returns # IAffinity Inherited from # WorkloadKubeObject.getAffinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number Inherited from # WorkloadKubeObject.getAffinityNumber getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # WorkloadKubeObject.getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # WorkloadKubeObject.getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # WorkloadKubeObject.getId getImages # \u25b8 getImages (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getLabels getName # \u25b8 getName (): string Returns # string Inherited from # WorkloadKubeObject.getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getNodeSelectors getNs # \u25b8 getNs (): string Returns # string Inherited from # WorkloadKubeObject.getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # WorkloadKubeObject.getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # WorkloadKubeObject.getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSelectors getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getTemplateLabels getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # WorkloadKubeObject.getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): IToleration [] Returns # IToleration [] Inherited from # WorkloadKubeObject.getTolerations patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # WorkloadKubeObject.patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # WorkloadKubeObject.toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < DaemonSet > Returns # Promise < KubeJsonApiData > Inherited from # WorkloadKubeObject.update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # WorkloadKubeObject.create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # WorkloadKubeObject.isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # WorkloadKubeObject.isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # WorkloadKubeObject.isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # WorkloadKubeObject.stringifyLabels","title":"Class: DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#class-daemonset","text":"Renderer . K8sApi .DaemonSet","title":"Class: DaemonSet"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#hierarchy","text":"WorkloadKubeObject \u21b3 DaemonSet","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#constructor","text":"\u2022 new DaemonSet ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#apibase","text":"\u25aa Static apiBase : string = \"/apis/apps/v1/daemonsets\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#kind_1","text":"\u25aa Static kind : string = \"DaemonSet\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getaffinity","text":"\u25b8 getAffinity (): IAffinity","title":"getAffinity"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getimages","text":"\u25b8 getImages (): string []","title":"getImages"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#gettolerations","text":"\u25b8 getTolerations (): IToleration []","title":"getTolerations"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/","text":"Class: DaemonSetStore # Renderer . K8sApi .DaemonSetStore Hierarchy # KubeObjectStore < DaemonSet > \u21b3 DaemonSetStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DaemonSetStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : DaemonSetApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < DaemonSet > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < DaemonSet , void , undefined > Returns # Generator < DaemonSet , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): DaemonSet [] Parameters # Name Type items DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): DaemonSet [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # DaemonSet [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): DaemonSet Parameters # Name Type id string Returns # DaemonSet Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): DaemonSet [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # DaemonSet [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): DaemonSet Parameters # Name Type name string namespace? string Returns # DaemonSet Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): DaemonSet Parameters # Name Type path string Returns # DaemonSet Inherited from # KubeObjectStore . getByPath getChildPods # \u25b8 getChildPods ( daemonSet ): Pod [] Parameters # Name Type daemonSet DaemonSet Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 getStatuses ( daemonSets? ): Object Parameters # Name Type daemonSets? DaemonSet [] Returns # Object Name Type failed number pending number running number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item DaemonSet Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems DaemonSet [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | DaemonSet []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | DaemonSet []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < DaemonSet > Parameters # Name Type resourcePath string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < DaemonSet []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < DaemonSet > Returns # Promise < DaemonSet []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): DaemonSet [] Parameters # Name Type partialItems DaemonSet [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # DaemonSet [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < DaemonSet > Parameters # Name Type item DaemonSet patch Patch Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | DaemonSet []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | DaemonSet []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item DaemonSet Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item DaemonSet request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): DaemonSet [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items DaemonSet [] the items to be sorted (default: the current items in this store) sorting ( item : DaemonSet ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # DaemonSet [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems DaemonSet [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item DaemonSet Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < DaemonSet > Parameters # Name Type item DaemonSet data Partial < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < DaemonSet > Parameters # Name Type item DaemonSet request () => Promise < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . updateItem","title":"Class: DaemonSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#class-daemonsetstore","text":"Renderer . K8sApi .DaemonSetStore","title":"Class: DaemonSetStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#hierarchy","text":"KubeObjectStore < DaemonSet > \u21b3 DaemonSetStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#constructor","text":"\u2022 new DaemonSetStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#api","text":"\u2022 api : DaemonSetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#items","text":"\u2022 items : IObservableArray < DaemonSet >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#iterator","text":"\u25b8 [iterator] (): Generator < DaemonSet , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#create","text":"\u25b8 create ( params , data? ): Promise < DaemonSet >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < DaemonSet >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): DaemonSet []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): DaemonSet []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyid","text":"\u25b8 getById ( id ): DaemonSet","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): DaemonSet []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): DaemonSet","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbypath","text":"\u25b8 getByPath ( path ): DaemonSet","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getchildpods","text":"\u25b8 getChildPods ( daemonSet ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getitems","text":"\u25b8 getItems (): DaemonSet []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getstatuses","text":"\u25b8 getStatuses ( daemonSets? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#load","text":"\u25b8 load ( params ): Promise < DaemonSet >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | DaemonSet []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < DaemonSet >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < DaemonSet >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < DaemonSet []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): DaemonSet []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < DaemonSet >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | DaemonSet []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): DaemonSet [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#update","text":"\u25b8 update ( item , data ): Promise < DaemonSet >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < DaemonSet >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/","text":"Class: Deployment # Renderer . K8sApi .Deployment Hierarchy # WorkloadKubeObject \u21b3 Deployment Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getConditions getConditionsText getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Deployment ( data ) Parameters # Name Type data KubeJsonApiData Overrides # WorkloadKubeObject.constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # WorkloadKubeObject.apiVersion kind # \u2022 kind : string Inherited from # WorkloadKubeObject.kind managedFields # \u2022 Optional managedFields : any Inherited from # WorkloadKubeObject.managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # WorkloadKubeObject.metadata spec # \u2022 spec : Object Type declaration # Name Type replicas number selector Object selector.matchLabels Object strategy Object strategy.rollingUpdate Object strategy.rollingUpdate.maxSurge number strategy.rollingUpdate.maxUnavailable number strategy.type string template Object template.metadata Object template.metadata.annotations? Object template.metadata.creationTimestamp? string template.metadata.labels Object template.spec Object template.spec.affinity? IAffinity template.spec.containers { args? : string [] ; env? : { name : string ; value : string }[] ; image : string ; imagePullPolicy : string ; livenessProbe? : IContainerProbe ; name : string ; ports? : { containerPort : number ; name : string ; protocol : string }[] ; readinessProbe? : IContainerProbe ; resources : { limits? : { cpu : string ; memory : string } ; requests : { cpu : string ; memory : string } } ; startupProbe? : IContainerProbe ; terminationMessagePath : string ; terminationMessagePolicy : string ; volumeMounts? : { mountPath : string ; name : string }[] }[] template.spec.dnsPolicy string template.spec.nodeSelector? Object template.spec.restartPolicy string template.spec.schedulerName string template.spec.securityContext Object template.spec.serviceAccount string template.spec.serviceAccountName string template.spec.terminationGracePeriodSeconds number template.spec.tolerations? { effect : string ; key : string ; operator : string ; tolerationSeconds : number }[] template.spec.volumes? { configMap : { defaultMode : number ; name : string ; optional : boolean } ; name : string }[] Overrides # WorkloadKubeObject.spec status # \u2022 status : Object Type declaration # Name Type availableReplicas? number conditions { lastTransitionTime : string ; lastUpdateTime : string ; message : string ; reason : string ; status : string ; type : string }[] observedGeneration number readyReplicas number replicas number unavailableReplicas? number updatedReplicas number Overrides # WorkloadKubeObject.status apiBase # \u25aa Static apiBase : string = \"/apis/apps/v1/deployments\" kind # \u25aa Static kind : string = \"Deployment\" Overrides # WorkloadKubeObject.kind namespaced # \u25aa Static namespaced : boolean = true Overrides # WorkloadKubeObject.namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # WorkloadKubeObject.delete getAffinity # \u25b8 getAffinity (): IAffinity Returns # IAffinity Inherited from # WorkloadKubeObject.getAffinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number Inherited from # WorkloadKubeObject.getAffinityNumber getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # WorkloadKubeObject.getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # WorkloadKubeObject.getAnnotations getConditions # \u25b8 getConditions ( activeOnly? ): { lastTransitionTime : string ; lastUpdateTime : string ; message : string ; reason : string ; status : string ; type : string }[] Parameters # Name Type Default value activeOnly boolean false Returns # { lastTransitionTime : string ; lastUpdateTime : string ; message : string ; reason : string ; status : string ; type : string }[] getConditionsText # \u25b8 getConditionsText ( activeOnly? ): string Parameters # Name Type Default value activeOnly boolean true Returns # string getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # WorkloadKubeObject.getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getLabels getName # \u25b8 getName (): string Returns # string Inherited from # WorkloadKubeObject.getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getNodeSelectors getNs # \u25b8 getNs (): string Returns # string Inherited from # WorkloadKubeObject.getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # WorkloadKubeObject.getOwnerRefs getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # WorkloadKubeObject.getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSelectors getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getTemplateLabels getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # WorkloadKubeObject.getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): IToleration [] Returns # IToleration [] Inherited from # WorkloadKubeObject.getTolerations patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # WorkloadKubeObject.patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # WorkloadKubeObject.toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Deployment > Returns # Promise < KubeJsonApiData > Inherited from # WorkloadKubeObject.update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # WorkloadKubeObject.create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # WorkloadKubeObject.isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # WorkloadKubeObject.isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # WorkloadKubeObject.isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # WorkloadKubeObject.stringifyLabels","title":"Class: Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#class-deployment","text":"Renderer . K8sApi .Deployment","title":"Class: Deployment"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#hierarchy","text":"WorkloadKubeObject \u21b3 Deployment","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getConditions getConditionsText getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#constructor","text":"\u2022 new Deployment ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#apibase","text":"\u25aa Static apiBase : string = \"/apis/apps/v1/deployments\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#kind_1","text":"\u25aa Static kind : string = \"Deployment\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getaffinity","text":"\u25b8 getAffinity (): IAffinity","title":"getAffinity"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getconditions","text":"\u25b8 getConditions ( activeOnly? ): { lastTransitionTime : string ; lastUpdateTime : string ; message : string ; reason : string ; status : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getconditionstext","text":"\u25b8 getConditionsText ( activeOnly? ): string","title":"getConditionsText"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#gettolerations","text":"\u25b8 getTolerations (): IToleration []","title":"getTolerations"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/","text":"Class: DeploymentApi # Renderer . K8sApi .DeploymentApi Hierarchy # KubeApi < Deployment > \u21b3 DeploymentApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getReplicas getResourceVersion getScaleApiUrl getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion restart scale setResourceVersion update watch Constructors # constructor # \u2022 new DeploymentApi ( options ) Parameters # Name Type options IKubeApiOptions < Deployment > Inherited from # KubeApi . constructor Properties # apiBase # \u2022 Readonly apiBase : string Inherited from # KubeApi . apiBase apiGroup # \u2022 Readonly apiGroup : string Inherited from # KubeApi . apiGroup apiPrefix # \u2022 Readonly apiPrefix : string Inherited from # KubeApi . apiPrefix apiResource # \u2022 Readonly apiResource : string Inherited from # KubeApi . apiResource apiVersion # \u2022 Readonly apiVersion : string Inherited from # KubeApi . apiVersion apiVersionPreferred # \u2022 Optional Readonly apiVersionPreferred : string Inherited from # KubeApi . apiVersionPreferred isNamespaced # \u2022 Readonly isNamespaced : boolean Inherited from # KubeApi . isNamespaced kind # \u2022 Readonly kind : string Inherited from # KubeApi . kind objectConstructor # \u2022 objectConstructor : KubeObjectConstructor < Deployment > Inherited from # KubeApi . objectConstructor options # \u2022 Protected options : IKubeApiOptions < Deployment > Inherited from # KubeApi . options request # \u2022 Protected request : KubeJsonApi Inherited from # KubeApi . request resourceVersions # \u2022 Protected resourceVersions : Map < string , string > Inherited from # KubeApi . resourceVersions watchDisposer # \u2022 Protected watchDisposer : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # KubeApi . watchDisposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise < void > Returns # Promise < void > Inherited from # KubeApi . checkPreferredVersion create # \u25b8 create ( __namedParameters? , data? ): Promise < Deployment > Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string data? Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeApi . create delete # \u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData > Parameters # Name Type __namedParameters Object Returns # Promise < KubeJsonApiData > Inherited from # KubeApi . delete get # \u25b8 get ( __namedParameters? , query? ): Promise < Deployment > Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string query? IKubeApiQueryParams Returns # Promise < Deployment > Inherited from # KubeApi . get getReplicas # \u25b8 getReplicas ( params ): Promise < number > Parameters # Name Type params Object params.name string params.namespace string Returns # Promise < number > getResourceVersion # \u25b8 getResourceVersion ( namespace? ): string Parameters # Name Type Default value namespace string \"\" Returns # string Inherited from # KubeApi . getResourceVersion getScaleApiUrl # \u25b8 Protected getScaleApiUrl ( params ): string Parameters # Name Type params Object params.name string params.namespace string Returns # string getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string query? Partial < IKubeApiQueryParams > Returns # string Inherited from # KubeApi . getUrl getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query IKubeApiQueryParams {} Returns # string Inherited from # KubeApi . getWatchUrl list # \u25b8 list ( __namedParameters? , query? ): Promise < Deployment []> Parameters # Name Type __namedParameters KubeApiListOptions query? IKubeApiQueryParams Returns # Promise < Deployment []> Inherited from # KubeApi . list modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent < KubeJsonApiData > Returns # void Inherited from # KubeApi . modifyWatchEvent normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial < IKubeApiQueryParams > Parameters # Name Type query Partial < IKubeApiQueryParams > Returns # Partial < IKubeApiQueryParams > Inherited from # KubeApi . normalizeQuery parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): Deployment | Deployment [] Parameters # Name Type data unknown namespace? string Returns # Deployment | Deployment [] Inherited from # KubeApi . parseResponse refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < Deployment []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < Deployment []> Inherited from # KubeApi . refreshResourceVersion restart # \u25b8 restart ( params ): Promise < KubeJsonApiData > Parameters # Name Type params Object params.name string params.namespace string Returns # Promise < KubeJsonApiData > scale # \u25b8 scale ( params , replicas ): Promise < KubeJsonApiData > Parameters # Name Type params Object params.name string params.namespace string replicas number Returns # Promise < KubeJsonApiData > setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void Inherited from # KubeApi . setResourceVersion update # \u25b8 update ( __namedParameters? , data? ): Promise < Deployment > Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string data? Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeApi . update watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions Returns # fn \u25b8 (): void Returns # void Inherited from # KubeApi . watch","title":"Class: DeploymentApi"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#class-deploymentapi","text":"Renderer . K8sApi .DeploymentApi","title":"Class: DeploymentApi"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#hierarchy","text":"KubeApi < Deployment > \u21b3 DeploymentApi","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#properties","text":"apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#accessors","text":"apiVersionWithGroup","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#methods","text":"checkPreferredVersion create delete get getReplicas getResourceVersion getScaleApiUrl getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion restart scale setResourceVersion update watch","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#constructor","text":"\u2022 new DeploymentApi ( options )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apibase","text":"\u2022 Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apigroup","text":"\u2022 Readonly apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apiprefix","text":"\u2022 Readonly apiPrefix : string","title":"apiPrefix"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apiresource","text":"\u2022 Readonly apiResource : string","title":"apiResource"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apiversionpreferred","text":"\u2022 Optional Readonly apiVersionPreferred : string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#isnamespaced","text":"\u2022 Readonly isNamespaced : boolean","title":"isNamespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#objectconstructor","text":"\u2022 objectConstructor : KubeObjectConstructor < Deployment >","title":"objectConstructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#options","text":"\u2022 Protected options : IKubeApiOptions < Deployment >","title":"options"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#request","text":"\u2022 Protected request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#resourceversions","text":"\u2022 Protected resourceVersions : Map < string , string >","title":"resourceVersions"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#watchdisposer","text":"\u2022 Protected watchDisposer : () => void","title":"watchDisposer"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apiversionwithgroup","text":"\u2022 get apiVersionWithGroup (): string","title":"apiVersionWithGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#checkpreferredversion","text":"\u25b8 Protected checkPreferredVersion (): Promise < void >","title":"checkPreferredVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#create","text":"\u25b8 create ( __namedParameters? , data? ): Promise < Deployment >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#get","text":"\u25b8 get ( __namedParameters? , query? ): Promise < Deployment >","title":"get"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#getreplicas","text":"\u25b8 getReplicas ( params ): Promise < number >","title":"getReplicas"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#getscaleapiurl","text":"\u25b8 Protected getScaleApiUrl ( params ): string","title":"getScaleApiUrl"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#geturl","text":"\u25b8 getUrl ( __namedParameters? , query? ): string","title":"getUrl"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#getwatchurl","text":"\u25b8 getWatchUrl ( namespace? , query? ): string","title":"getWatchUrl"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#list","text":"\u25b8 list ( __namedParameters? , query? ): Promise < Deployment []>","title":"list"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#modifywatchevent","text":"\u25b8 Protected modifyWatchEvent ( event ): void","title":"modifyWatchEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#normalizequery","text":"\u25b8 Protected normalizeQuery ( query? ): Partial < IKubeApiQueryParams >","title":"normalizeQuery"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): Deployment | Deployment []","title":"parseResponse"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < Deployment []>","title":"refreshResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#restart","text":"\u25b8 restart ( params ): Promise < KubeJsonApiData >","title":"restart"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#scale","text":"\u25b8 scale ( params , replicas ): Promise < KubeJsonApiData >","title":"scale"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#setresourceversion","text":"\u25b8 setResourceVersion ( namespace? , newVersion ): void","title":"setResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#update","text":"\u25b8 update ( __namedParameters? , data? ): Promise < Deployment >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#watch","text":"\u25b8 watch ( opts? ): () => void","title":"watch"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/","text":"Class: DeploymentStore # Renderer . K8sApi .DeploymentStore Hierarchy # KubeObjectStore < Deployment > \u21b3 DeploymentStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DeploymentStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : DeploymentApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Deployment > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Deployment , void , undefined > Returns # Generator < Deployment , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Deployment [] Parameters # Name Type items Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Deployment [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Deployment [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Deployment Parameters # Name Type id string Returns # Deployment Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Deployment [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Deployment [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Deployment Parameters # Name Type name string namespace? string Returns # Deployment Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Deployment Parameters # Name Type path string Returns # Deployment Inherited from # KubeObjectStore . getByPath getChildPods # \u25b8 getChildPods ( deployment ): Pod [] Parameters # Name Type deployment Deployment Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 getStatuses ( deployments? ): Object Parameters # Name Type deployments? Deployment [] Returns # Object Name Type failed number pending number running number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Deployment Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Deployment [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Deployment > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | Deployment []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | Deployment []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Deployment > Parameters # Name Type resourcePath string Returns # Promise < Deployment > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Deployment > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Deployment > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Deployment []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Deployment > Returns # Promise < Deployment []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Deployment [] Parameters # Name Type partialItems Deployment [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # Deployment [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Deployment > Parameters # Name Type item Deployment patch Patch Returns # Promise < Deployment > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | Deployment []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | Deployment []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Deployment Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Deployment request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items ): Deployment [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type items Deployment [] Returns # Deployment [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Deployment [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Deployment Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Deployment > Parameters # Name Type item Deployment data Partial < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Deployment > Parameters # Name Type item Deployment request () => Promise < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore . updateItem","title":"Class: DeploymentStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#class-deploymentstore","text":"Renderer . K8sApi .DeploymentStore","title":"Class: DeploymentStore"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#hierarchy","text":"KubeObjectStore < Deployment > \u21b3 DeploymentStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#constructor","text":"\u2022 new DeploymentStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#api","text":"\u2022 api : DeploymentApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#items","text":"\u2022 items : IObservableArray < Deployment >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#iterator","text":"\u25b8 [iterator] (): Generator < Deployment , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#create","text":"\u25b8 create ( params , data? ): Promise < Deployment >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Deployment >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Deployment []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Deployment []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyid","text":"\u25b8 getById ( id ): Deployment","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Deployment []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Deployment","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbypath","text":"\u25b8 getByPath ( path ): Deployment","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getchildpods","text":"\u25b8 getChildPods ( deployment ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getitems","text":"\u25b8 getItems (): Deployment []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getstatuses","text":"\u25b8 getStatuses ( deployments? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#load","text":"\u25b8 load ( params ): Promise < Deployment >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | Deployment []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Deployment >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Deployment >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Deployment []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Deployment []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Deployment >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | Deployment []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): Deployment [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#update","text":"\u25b8 update ( item , data ): Promise < Deployment >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Deployment >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/","text":"Class: Endpoint # Renderer . K8sApi .Endpoint Hierarchy # KubeObject \u21b3 Endpoint Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status subsets apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject toString update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Endpoint ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status subsets # \u2022 subsets : IEndpointSubset [] apiBase # \u25aa Static apiBase : string = \"/api/v1/endpoints\" kind # \u25aa Static kind : string = \"Endpoints\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getEndpointSubsets # \u25b8 getEndpointSubsets (): EndpointSubset [] Returns # EndpointSubset [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject toString # \u25b8 toString (): string Returns # string update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Endpoint > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#class-endpoint","text":"Renderer . K8sApi .Endpoint","title":"Class: Endpoint"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#hierarchy","text":"KubeObject \u21b3 Endpoint","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#properties","text":"apiVersion kind managedFields metadata spec status subsets apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#methods","text":"delete getAge getAnnotations getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject toString update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#constructor","text":"\u2022 new Endpoint ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#subsets","text":"\u2022 subsets : IEndpointSubset []","title":"subsets"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/endpoints\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#kind_1","text":"\u25aa Static kind : string = \"Endpoints\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getendpointsubsets","text":"\u25b8 getEndpointSubsets (): EndpointSubset []","title":"getEndpointSubsets"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#tostring","text":"\u25b8 toString (): string","title":"toString"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/","text":"Class: EndpointStore # Renderer . K8sApi .EndpointStore Hierarchy # KubeObjectStore < Endpoint > \u21b3 EndpointStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EndpointStore ( api? ) Parameters # Name Type api? KubeApi < Endpoint > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < Endpoint > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Endpoint > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Endpoint , void , undefined > Returns # Generator < Endpoint , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Endpoint [] Parameters # Name Type items Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Endpoint [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Endpoint [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Endpoint Parameters # Name Type id string Returns # Endpoint Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Endpoint [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Endpoint [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Endpoint Parameters # Name Type name string namespace? string Returns # Endpoint Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Endpoint Parameters # Name Type path string Returns # Endpoint Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items Endpoint [] Returns # Record < string , number > Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Endpoint Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Endpoint [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Endpoint > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | Endpoint []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | Endpoint []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Endpoint > Parameters # Name Type resourcePath string Returns # Promise < Endpoint > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Endpoint > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Endpoint > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Endpoint []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Endpoint > Returns # Promise < Endpoint []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Endpoint [] Parameters # Name Type partialItems Endpoint [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # Endpoint [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Endpoint > Parameters # Name Type item Endpoint patch Patch Returns # Promise < Endpoint > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | Endpoint []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | Endpoint []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Endpoint Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Endpoint request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Endpoint [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Endpoint [] the items to be sorted (default: the current items in this store) sorting ( item : Endpoint ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Endpoint [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Endpoint [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Endpoint Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Endpoint > Parameters # Name Type item Endpoint data Partial < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Endpoint > Parameters # Name Type item Endpoint request () => Promise < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore . updateItem","title":"Class: EndpointStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#class-endpointstore","text":"Renderer . K8sApi .EndpointStore","title":"Class: EndpointStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#hierarchy","text":"KubeObjectStore < Endpoint > \u21b3 EndpointStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#constructor","text":"\u2022 new EndpointStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#api","text":"\u2022 api : KubeApi < Endpoint >","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#items","text":"\u2022 items : IObservableArray < Endpoint >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#iterator","text":"\u25b8 [iterator] (): Generator < Endpoint , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#create","text":"\u25b8 create ( params , data? ): Promise < Endpoint >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Endpoint >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Endpoint []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Endpoint []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyid","text":"\u25b8 getById ( id ): Endpoint","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Endpoint []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Endpoint","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbypath","text":"\u25b8 getByPath ( path ): Endpoint","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getitems","text":"\u25b8 getItems (): Endpoint []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#load","text":"\u25b8 load ( params ): Promise < Endpoint >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | Endpoint []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Endpoint >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Endpoint >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Endpoint []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Endpoint []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Endpoint >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | Endpoint []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Endpoint [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#update","text":"\u25b8 update ( item , data ): Promise < Endpoint >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Endpoint >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/","text":"Class: EventStore # Renderer . K8sApi .EventStore Hierarchy # KubeObjectStore < KubeEvent > \u21b3 EventStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit saveLimit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getEventsByObject getIndexById getItems getStatuses getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EventStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < KubeEvent > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < KubeEvent > Inherited from # KubeObjectStore . items limit # \u2022 limit : number = 1000 Overrides # KubeObjectStore . limit saveLimit # \u2022 saveLimit : number = 50000 selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < KubeEvent , void , undefined > Returns # Generator < KubeEvent , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater (): void Returns # void Overrides # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): KubeEvent [] Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): KubeEvent [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # KubeEvent [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): KubeEvent Parameters # Name Type id string Returns # KubeEvent Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): KubeEvent [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # KubeEvent [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): KubeEvent Parameters # Name Type name string namespace? string Returns # KubeEvent Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): KubeEvent Parameters # Name Type path string Returns # KubeEvent Inherited from # KubeObjectStore . getByPath getEventsByObject # \u25b8 getEventsByObject ( obj ): KubeEvent [] Parameters # Name Type obj KubeObject < KubeObjectMetadata , any , any > Returns # KubeEvent [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items KubeEvent [] Returns # Record < string , number > Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount getWarnings # \u25b8 getWarnings (): KubeEvent [] Returns # KubeEvent [] getWarningsCount # \u25b8 getWarningsCount (): number Returns # number isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item KubeEvent Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems KubeEvent [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | KubeEvent []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | KubeEvent []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < KubeEvent > Parameters # Name Type resourcePath string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < KubeEvent []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < KubeEvent > Returns # Promise < KubeEvent []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): KubeEvent [] Parameters # Name Type partialItems KubeEvent [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # KubeEvent [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < KubeEvent > Parameters # Name Type item KubeEvent patch Patch Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | KubeEvent []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | KubeEvent []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item KubeEvent Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item KubeEvent request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items ): KubeEvent [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems KubeEvent [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item KubeEvent Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < KubeEvent > Parameters # Name Type item KubeEvent data Partial < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < KubeEvent > Parameters # Name Type item KubeEvent request () => Promise < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . updateItem","title":"Class: EventStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#class-eventstore","text":"Renderer . K8sApi .EventStore","title":"Class: EventStore"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#hierarchy","text":"KubeObjectStore < KubeEvent > \u21b3 EventStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit saveLimit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getEventsByObject getIndexById getItems getStatuses getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#constructor","text":"\u2022 new EventStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#api","text":"\u2022 api : KubeApi < KubeEvent >","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#items","text":"\u2022 items : IObservableArray < KubeEvent >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#limit","text":"\u2022 limit : number = 1000","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#savelimit","text":"\u2022 saveLimit : number = 50000","title":"saveLimit"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#iterator","text":"\u25b8 [iterator] (): Generator < KubeEvent , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater (): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#create","text":"\u25b8 create ( params , data? ): Promise < KubeEvent >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < KubeEvent >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): KubeEvent []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): KubeEvent []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyid","text":"\u25b8 getById ( id ): KubeEvent","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): KubeEvent []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): KubeEvent","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbypath","text":"\u25b8 getByPath ( path ): KubeEvent","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#geteventsbyobject","text":"\u25b8 getEventsByObject ( obj ): KubeEvent []","title":"getEventsByObject"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getitems","text":"\u25b8 getItems (): KubeEvent []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarnings","text":"\u25b8 getWarnings (): KubeEvent []","title":"getWarnings"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getwarningscount","text":"\u25b8 getWarningsCount (): number","title":"getWarningsCount"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#load","text":"\u25b8 load ( params ): Promise < KubeEvent >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | KubeEvent []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < KubeEvent >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < KubeEvent >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < KubeEvent []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): KubeEvent []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < KubeEvent >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | KubeEvent []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#sortitems","text":"\u25b8 Protected sortItems ( items ): KubeEvent [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#update","text":"\u25b8 update ( item , data ): Promise < KubeEvent >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < KubeEvent >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/","text":"Class: HPAStore # Renderer . K8sApi .HPAStore Hierarchy # KubeObjectStore < HorizontalPodAutoscaler > \u21b3 HPAStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new HPAStore ( api? ) Parameters # Name Type api? KubeApi < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < HorizontalPodAutoscaler > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < HorizontalPodAutoscaler , void , undefined > Returns # Generator < HorizontalPodAutoscaler , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): HorizontalPodAutoscaler [] Parameters # Name Type items HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): HorizontalPodAutoscaler [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): HorizontalPodAutoscaler Parameters # Name Type id string Returns # HorizontalPodAutoscaler Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): HorizontalPodAutoscaler [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): HorizontalPodAutoscaler Parameters # Name Type name string namespace? string Returns # HorizontalPodAutoscaler Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): HorizontalPodAutoscaler Parameters # Name Type path string Returns # HorizontalPodAutoscaler Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items HorizontalPodAutoscaler [] Returns # Record < string , number > Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item HorizontalPodAutoscaler Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems HorizontalPodAutoscaler [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | HorizontalPodAutoscaler []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | HorizontalPodAutoscaler []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < HorizontalPodAutoscaler > Parameters # Name Type resourcePath string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < HorizontalPodAutoscaler []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): HorizontalPodAutoscaler [] Parameters # Name Type partialItems HorizontalPodAutoscaler [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler patch Patch Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | HorizontalPodAutoscaler []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | HorizontalPodAutoscaler []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item HorizontalPodAutoscaler Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item HorizontalPodAutoscaler request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): HorizontalPodAutoscaler [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items HorizontalPodAutoscaler [] the items to be sorted (default: the current items in this store) sorting ( item : HorizontalPodAutoscaler ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems HorizontalPodAutoscaler [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item HorizontalPodAutoscaler Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler data Partial < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < HorizontalPodAutoscaler > Parameters # Name Type item HorizontalPodAutoscaler request () => Promise < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . updateItem","title":"Class: HPAStore"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#class-hpastore","text":"Renderer . K8sApi .HPAStore","title":"Class: HPAStore"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#hierarchy","text":"KubeObjectStore < HorizontalPodAutoscaler > \u21b3 HPAStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#constructor","text":"\u2022 new HPAStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#api","text":"\u2022 api : KubeApi < HorizontalPodAutoscaler >","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#items","text":"\u2022 items : IObservableArray < HorizontalPodAutoscaler >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#iterator","text":"\u25b8 [iterator] (): Generator < HorizontalPodAutoscaler , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#create","text":"\u25b8 create ( params , data? ): Promise < HorizontalPodAutoscaler >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < HorizontalPodAutoscaler >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): HorizontalPodAutoscaler []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): HorizontalPodAutoscaler []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyid","text":"\u25b8 getById ( id ): HorizontalPodAutoscaler","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): HorizontalPodAutoscaler []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): HorizontalPodAutoscaler","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbypath","text":"\u25b8 getByPath ( path ): HorizontalPodAutoscaler","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getitems","text":"\u25b8 getItems (): HorizontalPodAutoscaler []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#load","text":"\u25b8 load ( params ): Promise < HorizontalPodAutoscaler >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | HorizontalPodAutoscaler []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < HorizontalPodAutoscaler >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < HorizontalPodAutoscaler >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < HorizontalPodAutoscaler []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): HorizontalPodAutoscaler []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < HorizontalPodAutoscaler >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | HorizontalPodAutoscaler []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): HorizontalPodAutoscaler [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#update","text":"\u25b8 update ( item , data ): Promise < HorizontalPodAutoscaler >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < HorizontalPodAutoscaler >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/","text":"Class: HorizontalPodAutoscaler # Renderer . K8sApi .HorizontalPodAutoscaler Hierarchy # KubeObject \u21b3 HorizontalPodAutoscaler Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getCurrentMetrics getFinalizers getId getLabels getMaxPods getMetricName getMetricValues getMetrics getMinPods getName getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new HorizontalPodAutoscaler ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type maxReplicas number metrics IHpaMetric [] minReplicas number scaleTargetRef Object scaleTargetRef.apiVersion string scaleTargetRef.kind string scaleTargetRef.name string Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type conditions { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type : string }[] currentMetrics IHpaMetric [] currentReplicas number desiredReplicas number Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/autoscaling/v2beta1/horizontalpodautoscalers\" kind # \u25aa Static kind : string = \"HorizontalPodAutoscaler\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getConditions # \u25b8 getConditions (): { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type : string }[] getCurrentMetrics # \u25b8 getCurrentMetrics (): IHpaMetric [] Returns # IHpaMetric [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMaxPods # \u25b8 getMaxPods (): number Returns # number getMetricName # \u25b8 Protected getMetricName ( metric ): string Parameters # Name Type metric IHpaMetric Returns # string getMetricValues # \u25b8 getMetricValues ( metric ): string Parameters # Name Type metric IHpaMetric Returns # string getMetrics # \u25b8 getMetrics (): IHpaMetric [] Returns # IHpaMetric [] getMinPods # \u25b8 getMinPods (): number Returns # number getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < HorizontalPodAutoscaler > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#class-horizontalpodautoscaler","text":"Renderer . K8sApi .HorizontalPodAutoscaler","title":"Class: HorizontalPodAutoscaler"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#hierarchy","text":"KubeObject \u21b3 HorizontalPodAutoscaler","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#methods","text":"delete getAge getAnnotations getConditions getCurrentMetrics getFinalizers getId getLabels getMaxPods getMetricName getMetricValues getMetrics getMinPods getName getNs getOwnerRefs getReplicas getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#constructor","text":"\u2022 new HorizontalPodAutoscaler ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#apibase","text":"\u25aa Static apiBase : string = \"/apis/autoscaling/v2beta1/horizontalpodautoscalers\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#kind_1","text":"\u25aa Static kind : string = \"HorizontalPodAutoscaler\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getconditions","text":"\u25b8 getConditions (): { isReady : boolean ; lastTransitionTime : string ; message : string ; reason : string ; status : string ; tooltip : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getcurrentmetrics","text":"\u25b8 getCurrentMetrics (): IHpaMetric []","title":"getCurrentMetrics"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getmaxpods","text":"\u25b8 getMaxPods (): number","title":"getMaxPods"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getmetricname","text":"\u25b8 Protected getMetricName ( metric ): string","title":"getMetricName"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getmetricvalues","text":"\u25b8 getMetricValues ( metric ): string","title":"getMetricValues"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getmetrics","text":"\u25b8 getMetrics (): IHpaMetric []","title":"getMetrics"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getminpods","text":"\u25b8 getMinPods (): number","title":"getMinPods"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/","text":"Class: Ingress # Renderer . K8sApi .Ingress Hierarchy # KubeObject \u21b3 Ingress Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getSearchFields getServiceNamePort getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Ingress ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type backend? IExtensionsBackend defaultBackend? INetworkingBackend & { resource : { apiGroup : string ; kind : string ; name : string } } rules? { host? : string ; http : { paths : { backend : IIngressBackend ; path? : string }[] } }[] tls { secretName : string }[] Inherited from # KubeObject . spec status # \u2022 status : Object Type declaration # Name Type loadBalancer Object loadBalancer.ingress ILoadBalancerIngress [] Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/networking.k8s.io/v1/ingresses\" kind # \u25aa Static kind : string = \"Ingress\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getHosts # \u25b8 getHosts (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLoadBalancers # \u25b8 getLoadBalancers (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPorts # \u25b8 getPorts (): string Returns # string getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRoutes # \u25b8 getRoutes (): string [] Returns # string [] getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getServiceNamePort # \u25b8 getServiceNamePort (): Object Returns # Object Name Type serviceName string servicePort string | number getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Ingress > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#class-ingress","text":"Renderer . K8sApi .Ingress","title":"Class: Ingress"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#hierarchy","text":"KubeObject \u21b3 Ingress","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#methods","text":"delete getAge getAnnotations getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getSearchFields getServiceNamePort getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#constructor","text":"\u2022 new Ingress ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#apibase","text":"\u25aa Static apiBase : string = \"/apis/networking.k8s.io/v1/ingresses\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#kind_1","text":"\u25aa Static kind : string = \"Ingress\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#gethosts","text":"\u25b8 getHosts (): string []","title":"getHosts"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getloadbalancers","text":"\u25b8 getLoadBalancers (): string []","title":"getLoadBalancers"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getports","text":"\u25b8 getPorts (): string","title":"getPorts"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getroutes","text":"\u25b8 getRoutes (): string []","title":"getRoutes"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getservicenameport","text":"\u25b8 getServiceNamePort (): Object","title":"getServiceNamePort"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/","text":"Class: IngressApi # Renderer . K8sApi .IngressApi Hierarchy # KubeApi < Ingress > \u21b3 IngressApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch Constructors # constructor # \u2022 new IngressApi ( options ) Parameters # Name Type options IKubeApiOptions < Ingress > Inherited from # KubeApi . constructor Properties # apiBase # \u2022 Readonly apiBase : string Inherited from # KubeApi . apiBase apiGroup # \u2022 Readonly apiGroup : string Inherited from # KubeApi . apiGroup apiPrefix # \u2022 Readonly apiPrefix : string Inherited from # KubeApi . apiPrefix apiResource # \u2022 Readonly apiResource : string Inherited from # KubeApi . apiResource apiVersion # \u2022 Readonly apiVersion : string Inherited from # KubeApi . apiVersion apiVersionPreferred # \u2022 Optional Readonly apiVersionPreferred : string Inherited from # KubeApi . apiVersionPreferred isNamespaced # \u2022 Readonly isNamespaced : boolean Inherited from # KubeApi . isNamespaced kind # \u2022 Readonly kind : string Inherited from # KubeApi . kind objectConstructor # \u2022 objectConstructor : KubeObjectConstructor < Ingress > Inherited from # KubeApi . objectConstructor options # \u2022 Protected options : IKubeApiOptions < Ingress > Inherited from # KubeApi . options request # \u2022 Protected request : KubeJsonApi Inherited from # KubeApi . request resourceVersions # \u2022 Protected resourceVersions : Map < string , string > Inherited from # KubeApi . resourceVersions watchDisposer # \u2022 Protected watchDisposer : () => void Type declaration # \u25b8 (): void Returns # void Inherited from # KubeApi . watchDisposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise < void > Returns # Promise < void > Inherited from # KubeApi . checkPreferredVersion create # \u25b8 create ( __namedParameters? , data? ): Promise < Ingress > Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string data? Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeApi . create delete # \u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData > Parameters # Name Type __namedParameters Object Returns # Promise < KubeJsonApiData > Inherited from # KubeApi . delete get # \u25b8 get ( __namedParameters? , query? ): Promise < Ingress > Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string query? IKubeApiQueryParams Returns # Promise < Ingress > Inherited from # KubeApi . get getResourceVersion # \u25b8 getResourceVersion ( namespace? ): string Parameters # Name Type Default value namespace string \"\" Returns # string Inherited from # KubeApi . getResourceVersion getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string query? Partial < IKubeApiQueryParams > Returns # string Inherited from # KubeApi . getUrl getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query IKubeApiQueryParams {} Returns # string Inherited from # KubeApi . getWatchUrl list # \u25b8 list ( __namedParameters? , query? ): Promise < Ingress []> Parameters # Name Type __namedParameters KubeApiListOptions query? IKubeApiQueryParams Returns # Promise < Ingress []> Inherited from # KubeApi . list modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent < KubeJsonApiData > Returns # void Inherited from # KubeApi . modifyWatchEvent normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial < IKubeApiQueryParams > Parameters # Name Type query Partial < IKubeApiQueryParams > Returns # Partial < IKubeApiQueryParams > Inherited from # KubeApi . normalizeQuery parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): Ingress | Ingress [] Parameters # Name Type data unknown namespace? string Returns # Ingress | Ingress [] Inherited from # KubeApi . parseResponse refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < Ingress []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < Ingress []> Inherited from # KubeApi . refreshResourceVersion setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void Inherited from # KubeApi . setResourceVersion update # \u25b8 update ( __namedParameters? , data? ): Promise < Ingress > Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string data? Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeApi . update watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions Returns # fn \u25b8 (): void Returns # void Inherited from # KubeApi . watch","title":"Class: IngressApi"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#class-ingressapi","text":"Renderer . K8sApi .IngressApi","title":"Class: IngressApi"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#hierarchy","text":"KubeApi < Ingress > \u21b3 IngressApi","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#properties","text":"apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#accessors","text":"apiVersionWithGroup","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#methods","text":"checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#constructor","text":"\u2022 new IngressApi ( options )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apibase","text":"\u2022 Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apigroup","text":"\u2022 Readonly apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apiprefix","text":"\u2022 Readonly apiPrefix : string","title":"apiPrefix"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apiresource","text":"\u2022 Readonly apiResource : string","title":"apiResource"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apiversionpreferred","text":"\u2022 Optional Readonly apiVersionPreferred : string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#isnamespaced","text":"\u2022 Readonly isNamespaced : boolean","title":"isNamespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#objectconstructor","text":"\u2022 objectConstructor : KubeObjectConstructor < Ingress >","title":"objectConstructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#options","text":"\u2022 Protected options : IKubeApiOptions < Ingress >","title":"options"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#request","text":"\u2022 Protected request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#resourceversions","text":"\u2022 Protected resourceVersions : Map < string , string >","title":"resourceVersions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#watchdisposer","text":"\u2022 Protected watchDisposer : () => void","title":"watchDisposer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apiversionwithgroup","text":"\u2022 get apiVersionWithGroup (): string","title":"apiVersionWithGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#checkpreferredversion","text":"\u25b8 Protected checkPreferredVersion (): Promise < void >","title":"checkPreferredVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#create","text":"\u25b8 create ( __namedParameters? , data? ): Promise < Ingress >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#get","text":"\u25b8 get ( __namedParameters? , query? ): Promise < Ingress >","title":"get"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#geturl","text":"\u25b8 getUrl ( __namedParameters? , query? ): string","title":"getUrl"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#getwatchurl","text":"\u25b8 getWatchUrl ( namespace? , query? ): string","title":"getWatchUrl"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#list","text":"\u25b8 list ( __namedParameters? , query? ): Promise < Ingress []>","title":"list"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#modifywatchevent","text":"\u25b8 Protected modifyWatchEvent ( event ): void","title":"modifyWatchEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#normalizequery","text":"\u25b8 Protected normalizeQuery ( query? ): Partial < IKubeApiQueryParams >","title":"normalizeQuery"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): Ingress | Ingress []","title":"parseResponse"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < Ingress []>","title":"refreshResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#setresourceversion","text":"\u25b8 setResourceVersion ( namespace? , newVersion ): void","title":"setResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#update","text":"\u25b8 update ( __namedParameters? , data? ): Promise < Ingress >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#watch","text":"\u25b8 watch ( opts? ): () => void","title":"watch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/","text":"Class: IngressStore # Renderer . K8sApi .IngressStore Hierarchy # KubeObjectStore < Ingress > \u21b3 IngressStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new IngressStore ( api? ) Parameters # Name Type api? KubeApi < Ingress > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : IngressApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Ingress > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Ingress , void , undefined > Returns # Generator < Ingress , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Ingress [] Parameters # Name Type items Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Ingress [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Ingress [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Ingress Parameters # Name Type id string Returns # Ingress Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Ingress [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Ingress [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Ingress Parameters # Name Type name string namespace? string Returns # Ingress Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Ingress Parameters # Name Type path string Returns # Ingress Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items Ingress [] Returns # Record < string , number > Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Ingress Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Ingress [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Ingress > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | Ingress []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | Ingress []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Ingress > Parameters # Name Type resourcePath string Returns # Promise < Ingress > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Ingress > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Ingress > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Ingress []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Ingress > Returns # Promise < Ingress []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Ingress [] Parameters # Name Type partialItems Ingress [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # Ingress [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Ingress > Parameters # Name Type item Ingress patch Patch Returns # Promise < Ingress > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | Ingress []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | Ingress []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Ingress Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Ingress request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Ingress [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Ingress [] the items to be sorted (default: the current items in this store) sorting ( item : Ingress ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Ingress [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Ingress [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Ingress Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Ingress > Parameters # Name Type item Ingress data Partial < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Ingress > Parameters # Name Type item Ingress request () => Promise < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore . updateItem","title":"Class: IngressStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#class-ingressstore","text":"Renderer . K8sApi .IngressStore","title":"Class: IngressStore"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#hierarchy","text":"KubeObjectStore < Ingress > \u21b3 IngressStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#constructor","text":"\u2022 new IngressStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#api","text":"\u2022 api : IngressApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#items","text":"\u2022 items : IObservableArray < Ingress >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#iterator","text":"\u25b8 [iterator] (): Generator < Ingress , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#create","text":"\u25b8 create ( params , data? ): Promise < Ingress >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Ingress >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Ingress []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Ingress []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyid","text":"\u25b8 getById ( id ): Ingress","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Ingress []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Ingress","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbypath","text":"\u25b8 getByPath ( path ): Ingress","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getitems","text":"\u25b8 getItems (): Ingress []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#load","text":"\u25b8 load ( params ): Promise < Ingress >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | Ingress []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Ingress >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Ingress >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Ingress []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Ingress []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Ingress >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | Ingress []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Ingress [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#update","text":"\u25b8 update ( item , data ): Promise < Ingress >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Ingress >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/","text":"Class: Job # Renderer . K8sApi .Job Hierarchy # WorkloadKubeObject \u21b3 Job Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCompletions getCondition getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Job ( data ) Parameters # Name Type data KubeJsonApiData Overrides # WorkloadKubeObject.constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # WorkloadKubeObject.apiVersion kind # \u2022 kind : string Inherited from # WorkloadKubeObject.kind managedFields # \u2022 Optional managedFields : any Inherited from # WorkloadKubeObject.managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # WorkloadKubeObject.metadata spec # \u2022 spec : Object Type declaration # Name Type backoffLimit? number completions? number containers? IPodContainer [] dnsPolicy? string parallelism? number restartPolicy? string schedulerName? string selector? Object selector.matchLabels Object serviceAccount? string serviceAccountName? string template Object template.metadata Object template.metadata.annotations? Object template.metadata.creationTimestamp? string template.metadata.labels? Object template.spec Object template.spec.affinity? IAffinity template.spec.containers IPodContainer [] template.spec.dnsPolicy string template.spec.hostPID boolean template.spec.nodeSelector? Object template.spec.restartPolicy string template.spec.schedulerName string template.spec.terminationGracePeriodSeconds number template.spec.tolerations? { effect : string ; key : string ; operator : string ; tolerationSeconds : number }[] terminationGracePeriodSeconds? number Overrides # WorkloadKubeObject.spec status # \u2022 status : Object Type declaration # Name Type completionTime string conditions { lastProbeTime : string ; lastTransitionTime : string ; message? : string ; status : string ; type : string }[] startTime string succeeded number Overrides # WorkloadKubeObject.status apiBase # \u25aa Static apiBase : string = \"/apis/batch/v1/jobs\" kind # \u25aa Static kind : string = \"Job\" Overrides # WorkloadKubeObject.kind namespaced # \u25aa Static namespaced : boolean = true Overrides # WorkloadKubeObject.namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete (): Promise < KubeJsonApiData > Returns # Promise < KubeJsonApiData > Overrides # WorkloadKubeObject.delete getAffinity # \u25b8 getAffinity (): IAffinity Returns # IAffinity Inherited from # WorkloadKubeObject.getAffinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number Inherited from # WorkloadKubeObject.getAffinityNumber getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # WorkloadKubeObject.getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # WorkloadKubeObject.getAnnotations getCompletions # \u25b8 getCompletions (): number Returns # number getCondition # \u25b8 getCondition (): Object Returns # Object Name Type lastProbeTime string lastTransitionTime string message? string status string type string getDesiredCompletions # \u25b8 getDesiredCompletions (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # WorkloadKubeObject.getId getImages # \u25b8 getImages (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getLabels getName # \u25b8 getName (): string Returns # string Inherited from # WorkloadKubeObject.getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getNodeSelectors getNs # \u25b8 getNs (): string Returns # string Inherited from # WorkloadKubeObject.getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # WorkloadKubeObject.getOwnerRefs getParallelism # \u25b8 getParallelism (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # WorkloadKubeObject.getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getSelectors getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] Inherited from # WorkloadKubeObject.getTemplateLabels getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # WorkloadKubeObject.getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): IToleration [] Returns # IToleration [] Inherited from # WorkloadKubeObject.getTolerations patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # WorkloadKubeObject.patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # WorkloadKubeObject.toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Job > Returns # Promise < KubeJsonApiData > Inherited from # WorkloadKubeObject.update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # WorkloadKubeObject.create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # WorkloadKubeObject.isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # WorkloadKubeObject.isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # WorkloadKubeObject.isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # WorkloadKubeObject.isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # WorkloadKubeObject.isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # WorkloadKubeObject.stringifyLabels","title":"Class: Job"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#class-job","text":"Renderer . K8sApi .Job","title":"Class: Job"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#hierarchy","text":"WorkloadKubeObject \u21b3 Job","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#methods","text":"delete getAffinity getAffinityNumber getAge getAnnotations getCompletions getCondition getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getSearchFields getSelectors getTemplateLabels getTimeDiffFromNow getTolerations patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#constructor","text":"\u2022 new Job ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#status","text":"\u2022 status : Object","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#apibase","text":"\u25aa Static apiBase : string = \"/apis/batch/v1/jobs\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#kind_1","text":"\u25aa Static kind : string = \"Job\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#delete","text":"\u25b8 delete (): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getaffinity","text":"\u25b8 getAffinity (): IAffinity","title":"getAffinity"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getaffinitynumber","text":"\u25b8 getAffinityNumber (): number","title":"getAffinityNumber"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getcompletions","text":"\u25b8 getCompletions (): number","title":"getCompletions"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getcondition","text":"\u25b8 getCondition (): Object","title":"getCondition"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getdesiredcompletions","text":"\u25b8 getDesiredCompletions (): number","title":"getDesiredCompletions"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getimages","text":"\u25b8 getImages (): string []","title":"getImages"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getnodeselectors","text":"\u25b8 getNodeSelectors (): string []","title":"getNodeSelectors"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getparallelism","text":"\u25b8 getParallelism (): number","title":"getParallelism"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getselectors","text":"\u25b8 getSelectors (): string []","title":"getSelectors"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#gettemplatelabels","text":"\u25b8 getTemplateLabels (): string []","title":"getTemplateLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#gettolerations","text":"\u25b8 getTolerations (): IToleration []","title":"getTolerations"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/","text":"Class: JobStore # Renderer . K8sApi .JobStore Hierarchy # KubeObjectStore < Job > \u21b3 JobStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getJobsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new JobStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : JobApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Job > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Job , void , undefined > Returns # Generator < Job , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Job > Returns # Promise < Job > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Job > Returns # Promise < Job > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Job [] Parameters # Name Type items Job [] Returns # Job [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Job [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Job [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Job Parameters # Name Type id string Returns # Job Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Job [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Job [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Job Parameters # Name Type name string namespace? string Returns # Job Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Job Parameters # Name Type path string Returns # Job Inherited from # KubeObjectStore . getByPath getChildPods # \u25b8 getChildPods ( job ): Pod [] Parameters # Name Type job Job Returns # Pod [] getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Job [] Returns # Job [] Inherited from # KubeObjectStore . getItems getJobsByOwner # \u25b8 getJobsByOwner ( cronJob ): Job [] Parameters # Name Type cronJob CronJob Returns # Job [] getStatuses # \u25b8 getStatuses ( jobs? ): Object Parameters # Name Type jobs? Job [] Returns # Object Name Type failed number pending number running number succeeded number Overrides # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Job Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Job [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Job > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | Job []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | Job []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Job > Parameters # Name Type resourcePath string Returns # Promise < Job > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Job > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Job > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Job []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < Job > Returns # Promise < Job []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Job [] Parameters # Name Type partialItems Job [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # Job [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < Job > Parameters # Name Type item Job patch Patch Returns # Promise < Job > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | Job []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | Job []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Job Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Job request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Job [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Job [] the items to be sorted (default: the current items in this store) sorting ( item : Job ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Job [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Job [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Job Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Job > Parameters # Name Type item Job data Partial < Job > Returns # Promise < Job > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Job > Parameters # Name Type item Job request () => Promise < Job > Returns # Promise < Job > Inherited from # KubeObjectStore . updateItem","title":"Class: JobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#class-jobstore","text":"Renderer . K8sApi .JobStore","title":"Class: JobStore"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#hierarchy","text":"KubeObjectStore < Job > \u21b3 JobStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getChildPods getIndexById getItems getJobsByOwner getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#constructor","text":"\u2022 new JobStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#api","text":"\u2022 api : JobApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#items","text":"\u2022 items : IObservableArray < Job >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#iterator","text":"\u25b8 [iterator] (): Generator < Job , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#create","text":"\u25b8 create ( params , data? ): Promise < Job >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Job >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Job []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Job []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyid","text":"\u25b8 getById ( id ): Job","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Job []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Job","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbypath","text":"\u25b8 getByPath ( path ): Job","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getchildpods","text":"\u25b8 getChildPods ( job ): Pod []","title":"getChildPods"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getitems","text":"\u25b8 getItems (): Job []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getjobsbyowner","text":"\u25b8 getJobsByOwner ( cronJob ): Job []","title":"getJobsByOwner"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getstatuses","text":"\u25b8 getStatuses ( jobs? ): Object","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#load","text":"\u25b8 load ( params ): Promise < Job >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | Job []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Job >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Job >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < Job []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Job []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Job >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | Job []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Job [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#update","text":"\u25b8 update ( item , data ): Promise < Job >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Job >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/","text":"Class: KubeApi # Renderer . K8sApi .KubeApi Type parameters # Name Type T extends KubeObject Hierarchy # KubeApi \u21b3 PodsApi \u21b3 NodesApi \u21b3 DeploymentApi \u21b3 IngressApi \u21b3 PersistentVolumeClaimsApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch Constructors # constructor # \u2022 new KubeApi < T >( options ) Type parameters # Name Type T extends KubeObject < KubeObjectMetadata , any , any , T > Parameters # Name Type options IKubeApiOptions < T > Properties # apiBase # \u2022 Readonly apiBase : string apiGroup # \u2022 Readonly apiGroup : string apiPrefix # \u2022 Readonly apiPrefix : string apiResource # \u2022 Readonly apiResource : string apiVersion # \u2022 Readonly apiVersion : string apiVersionPreferred # \u2022 Optional Readonly apiVersionPreferred : string isNamespaced # \u2022 Readonly isNamespaced : boolean kind # \u2022 Readonly kind : string objectConstructor # \u2022 objectConstructor : KubeObjectConstructor < T > options # \u2022 Protected options : IKubeApiOptions < T > request # \u2022 Protected request : KubeJsonApi resourceVersions # \u2022 Protected resourceVersions : Map < string , string > watchDisposer # \u2022 Protected watchDisposer : () => void Type declaration # \u25b8 (): void Returns # void Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise < void > Returns # Promise < void > create # \u25b8 create ( __namedParameters? , data? ): Promise < T > Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string data? Partial < T > Returns # Promise < T > delete # \u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData > Parameters # Name Type __namedParameters Object Returns # Promise < KubeJsonApiData > get # \u25b8 get ( __namedParameters? , query? ): Promise < T > Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string query? IKubeApiQueryParams Returns # Promise < T > getResourceVersion # \u25b8 getResourceVersion ( namespace? ): string Parameters # Name Type Default value namespace string \"\" Returns # string getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string query? Partial < IKubeApiQueryParams > Returns # string getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query IKubeApiQueryParams {} Returns # string list # \u25b8 list ( __namedParameters? , query? ): Promise < T []> Parameters # Name Type __namedParameters KubeApiListOptions query? IKubeApiQueryParams Returns # Promise < T []> modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent < KubeJsonApiData > Returns # void normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial < IKubeApiQueryParams > Parameters # Name Type query Partial < IKubeApiQueryParams > Returns # Partial < IKubeApiQueryParams > parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): T | T [] Parameters # Name Type data unknown namespace? string Returns # T | T [] refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < T []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < T []> setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void update # \u25b8 update ( __namedParameters? , data? ): Promise < T > Parameters # Name Type __namedParameters Object __namedParameters.name string __namedParameters.namespace string data? Partial < T > Returns # Promise < T > watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions Returns # fn \u25b8 (): void Returns # void","title":"Class: KubeApi"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#class-kubeapit","text":"Renderer . K8sApi .KubeApi","title":"Class: KubeApi<T>"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#type-parameters","text":"Name Type T extends KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#hierarchy","text":"KubeApi \u21b3 PodsApi \u21b3 NodesApi \u21b3 DeploymentApi \u21b3 IngressApi \u21b3 PersistentVolumeClaimsApi","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#properties","text":"apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred isNamespaced kind objectConstructor options request resourceVersions watchDisposer","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#accessors","text":"apiVersionWithGroup","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#methods","text":"checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse refreshResourceVersion setResourceVersion update watch","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#constructor","text":"\u2022 new KubeApi < T >( options )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apibase","text":"\u2022 Readonly apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apigroup","text":"\u2022 Readonly apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apiprefix","text":"\u2022 Readonly apiPrefix : string","title":"apiPrefix"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apiresource","text":"\u2022 Readonly apiResource : string","title":"apiResource"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apiversion","text":"\u2022 Readonly apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apiversionpreferred","text":"\u2022 Optional Readonly apiVersionPreferred : string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#isnamespaced","text":"\u2022 Readonly isNamespaced : boolean","title":"isNamespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#kind","text":"\u2022 Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#objectconstructor","text":"\u2022 objectConstructor : KubeObjectConstructor < T >","title":"objectConstructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#options","text":"\u2022 Protected options : IKubeApiOptions < T >","title":"options"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#request","text":"\u2022 Protected request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#resourceversions","text":"\u2022 Protected resourceVersions : Map < string , string >","title":"resourceVersions"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#watchdisposer","text":"\u2022 Protected watchDisposer : () => void","title":"watchDisposer"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apiversionwithgroup","text":"\u2022 get apiVersionWithGroup (): string","title":"apiVersionWithGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#checkpreferredversion","text":"\u25b8 Protected checkPreferredVersion (): Promise < void >","title":"checkPreferredVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#create","text":"\u25b8 create ( __namedParameters? , data? ): Promise < T >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#get","text":"\u25b8 get ( __namedParameters? , query? ): Promise < T >","title":"get"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#geturl","text":"\u25b8 getUrl ( __namedParameters? , query? ): string","title":"getUrl"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#getwatchurl","text":"\u25b8 getWatchUrl ( namespace? , query? ): string","title":"getWatchUrl"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#list","text":"\u25b8 list ( __namedParameters? , query? ): Promise < T []>","title":"list"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#modifywatchevent","text":"\u25b8 Protected modifyWatchEvent ( event ): void","title":"modifyWatchEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#normalizequery","text":"\u25b8 Protected normalizeQuery ( query? ): Partial < IKubeApiQueryParams >","title":"normalizeQuery"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): T | T []","title":"parseResponse"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < T []>","title":"refreshResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#setresourceversion","text":"\u25b8 setResourceVersion ( namespace? , newVersion ): void","title":"setResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#update","text":"\u25b8 update ( __namedParameters? , data? ): Promise < T >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#watch","text":"\u25b8 watch ( opts? ): () => void","title":"watch"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/","text":"Class: KubeEvent # Renderer . K8sApi .KubeEvent Hierarchy # KubeObject \u21b3 KubeEvent Table of contents # Constructors # constructor Properties # apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp managedFields message metadata reason reportingComponent reportingInstance source spec status type apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getSearchFields getSource getTimeDiffFromNow isWarning patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new KubeEvent ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion count # \u2022 count : number eventTime # \u2022 eventTime : null firstTimestamp # \u2022 firstTimestamp : string involvedObject # \u2022 involvedObject : Object Type declaration # Name Type apiVersion string fieldPath string kind string name string namespace string resourceVersion string uid string kind # \u2022 kind : string Inherited from # KubeObject . kind lastTimestamp # \u2022 lastTimestamp : string managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields message # \u2022 message : string metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata reason # \u2022 reason : string reportingComponent # \u2022 reportingComponent : string reportingInstance # \u2022 reportingInstance : string source # \u2022 source : Object Type declaration # Name Type component string host string spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status type # \u2022 type : string apiBase # \u25aa Static apiBase : string = \"/api/v1/events\" kind # \u25aa Static kind : string = \"Event\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getFirstSeenTime # \u25b8 getFirstSeenTime (): string Returns # string getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getLastSeenTime # \u25b8 getLastSeenTime (): string Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSource # \u25b8 getSource (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow isWarning # \u25b8 isWarning (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < KubeEvent > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#class-kubeevent","text":"Renderer . K8sApi .KubeEvent","title":"Class: KubeEvent"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#hierarchy","text":"KubeObject \u21b3 KubeEvent","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#properties","text":"apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp managedFields message metadata reason reportingComponent reportingInstance source spec status type apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#methods","text":"delete getAge getAnnotations getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getSearchFields getSource getTimeDiffFromNow isWarning patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#constructor","text":"\u2022 new KubeEvent ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#count","text":"\u2022 count : number","title":"count"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#eventtime","text":"\u2022 eventTime : null","title":"eventTime"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#firsttimestamp","text":"\u2022 firstTimestamp : string","title":"firstTimestamp"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#involvedobject","text":"\u2022 involvedObject : Object","title":"involvedObject"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#lasttimestamp","text":"\u2022 lastTimestamp : string","title":"lastTimestamp"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#message","text":"\u2022 message : string","title":"message"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#reason","text":"\u2022 reason : string","title":"reason"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#reportingcomponent","text":"\u2022 reportingComponent : string","title":"reportingComponent"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#reportinginstance","text":"\u2022 reportingInstance : string","title":"reportingInstance"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#source","text":"\u2022 source : Object","title":"source"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#type","text":"\u2022 type : string","title":"type"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/events\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#kind_1","text":"\u25aa Static kind : string = \"Event\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getfirstseentime","text":"\u25b8 getFirstSeenTime (): string","title":"getFirstSeenTime"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getlastseentime","text":"\u25b8 getLastSeenTime (): string","title":"getLastSeenTime"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getsource","text":"\u25b8 getSource (): string","title":"getSource"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#iswarning","text":"\u25b8 isWarning (): boolean","title":"isWarning"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/","text":"Class: KubeObject # Renderer . K8sApi .KubeObject Type parameters # Name Type Metadata extends KubeObjectMetadata``KubeObjectMetadata Status any Spec any Hierarchy # KubeObject \u21b3 Node \u21b3 CronJob \u21b3 ConfigMap \u21b3 Secret \u21b3 ResourceQuota \u21b3 LimitRange \u21b3 HorizontalPodAutoscaler \u21b3 PodDisruptionBudget \u21b3 Service \u21b3 Endpoint \u21b3 Ingress \u21b3 NetworkPolicy \u21b3 PersistentVolume \u21b3 PersistentVolumeClaim \u21b3 StorageClass \u21b3 Namespace \u21b3 KubeEvent \u21b3 ServiceAccount \u21b3 Role \u21b3 RoleBinding \u21b3 ClusterRole \u21b3 ClusterRoleBinding \u21b3 CustomResourceDefinition Implements # ItemObject Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new KubeObject < Metadata , Status , Spec >( data ) Type parameters # Name Type Metadata extends KubeObjectMetadata``KubeObjectMetadata Status any Spec any Parameters # Name Type data KubeJsonApiData Properties # apiVersion # \u2022 apiVersion : string kind # \u2022 kind : string managedFields # \u2022 Optional managedFields : any metadata # \u2022 metadata : Metadata spec # \u2022 Optional spec : Spec status # \u2022 Optional status : Status kind # \u25aa Static Readonly kind : string namespaced # \u25aa Static Readonly namespaced : boolean Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] getId # \u25b8 getId (): string Returns # string Implementation of # ItemObject.getId getLabels # \u25b8 getLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Implementation of # ItemObject.getName getNs # \u25b8 getNs (): string Returns # string getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > toPlainObject # \u25b8 toPlainObject (): object Returns # object update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < KubeObject < Metadata , Status , Spec >> Returns # Promise < KubeJsonApiData > create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string []","title":"Class: KubeObject"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#class-kubeobjectmetadata-status-spec","text":"Renderer . K8sApi .KubeObject","title":"Class: KubeObject<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#type-parameters","text":"Name Type Metadata extends KubeObjectMetadata``KubeObjectMetadata Status any Spec any","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#hierarchy","text":"KubeObject \u21b3 Node \u21b3 CronJob \u21b3 ConfigMap \u21b3 Secret \u21b3 ResourceQuota \u21b3 LimitRange \u21b3 HorizontalPodAutoscaler \u21b3 PodDisruptionBudget \u21b3 Service \u21b3 Endpoint \u21b3 Ingress \u21b3 NetworkPolicy \u21b3 PersistentVolume \u21b3 PersistentVolumeClaim \u21b3 StorageClass \u21b3 Namespace \u21b3 KubeEvent \u21b3 ServiceAccount \u21b3 Role \u21b3 RoleBinding \u21b3 ClusterRole \u21b3 ClusterRoleBinding \u21b3 CustomResourceDefinition","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#implements","text":"ItemObject","title":"Implements"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#properties","text":"apiVersion kind managedFields metadata spec status kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#constructor","text":"\u2022 new KubeObject < Metadata , Status , Spec >( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#spec","text":"\u2022 Optional spec : Spec","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#status","text":"\u2022 Optional status : Status","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#kind_1","text":"\u25aa Static Readonly kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#namespaced","text":"\u25aa Static Readonly namespaced : boolean","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObject/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/","text":"Class: KubeObjectStore # Renderer . K8sApi .KubeObjectStore Type parameters # Name Type T extends KubeObject Hierarchy # ItemStore < T > \u21b3 KubeObjectStore \u21b3\u21b3 EventStore \u21b3\u21b3 PodsStore \u21b3\u21b3 NodesStore \u21b3\u21b3 DeploymentStore \u21b3\u21b3 DaemonSetStore \u21b3\u21b3 StatefulSetStore \u21b3\u21b3 JobStore \u21b3\u21b3 CronJobStore \u21b3\u21b3 ConfigMapsStore \u21b3\u21b3 SecretsStore \u21b3\u21b3 ReplicaSetStore \u21b3\u21b3 ResourceQuotasStore \u21b3\u21b3 LimitRangesStore \u21b3\u21b3 HPAStore \u21b3\u21b3 PodDisruptionBudgetsStore \u21b3\u21b3 ServiceStore \u21b3\u21b3 EndpointStore \u21b3\u21b3 IngressStore \u21b3\u21b3 NetworkPolicyStore \u21b3\u21b3 PersistentVolumesStore \u21b3\u21b3 VolumeClaimStore \u21b3\u21b3 StorageClassStore \u21b3\u21b3 NamespaceStore \u21b3\u21b3 ServiceAccountsStore \u21b3\u21b3 RolesStore \u21b3\u21b3 RoleBindingsStore \u21b3\u21b3 CRDStore \u21b3\u21b3 CRDResourceStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new KubeObjectStore < T >( api? ) Type parameters # Name Type T extends KubeObject < KubeObjectMetadata , any , any , T > Parameters # Name Type api? KubeApi < T > Overrides # ItemStore.constructor Properties # api # \u2022 api : KubeApi < T > bufferSize # \u2022 Readonly bufferSize : number = 50000 eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> failedLoading # \u2022 failedLoading : boolean = false Inherited from # ItemStore.failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # ItemStore.isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # ItemStore.isLoading items # \u2022 items : IObservableArray < T > Inherited from # ItemStore.items limit # \u2022 Optional Readonly limit : number selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # ItemStore.selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < T , void , undefined > Returns # Generator < T , void , undefined > Inherited from # ItemStore.__@iterator@544 bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void create # \u25b8 create ( params , data? ): Promise < T > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < T > Returns # Promise < T > createItem # \u25b8 Protected createItem ( params , data? ): Promise < T > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < T > Returns # Promise < T > Overrides # ItemStore.createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # ItemStore.defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): T [] Parameters # Name Type items T [] Returns # T [] getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): T [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # T [] getById # \u25b8 getById ( id ): T Parameters # Name Type id string Returns # T getByLabel # \u25b8 getByLabel ( labels ): T [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # T [] getByName # \u25b8 getByName ( name , namespace? ): T Parameters # Name Type name string namespace? string Returns # T Overrides # ItemStore.getByName getByPath # \u25b8 getByPath ( path ): T Parameters # Name Type path string Returns # T getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # ItemStore.getIndexById getItems # \u25b8 getItems (): T [] Returns # T [] Inherited from # ItemStore.getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items T [] Returns # Record < string , number > getTotalCount # \u25b8 getTotalCount (): number Returns # number Overrides # ItemStore.getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item T Returns # boolean Inherited from # ItemStore.isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems T [] Returns # boolean Inherited from # ItemStore.isSelectedAll load # \u25b8 load ( params ): Promise < T > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < T > loadAll # \u25b8 loadAll ( options? ): Promise < void | T []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | T []> Overrides # ItemStore.loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < T > Parameters # Name Type resourcePath string Returns # Promise < T > loadItem # \u25b8 Protected loadItem ( params ): Promise < T > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < T > Overrides # ItemStore.loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < T []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < T > Returns # Promise < T []> Overrides # ItemStore.loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): T [] Parameters # Name Type partialItems T [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # T [] patch # \u25b8 patch ( item , patch ): Promise < T > Parameters # Name Type item T patch Patch Returns # Promise < T > reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | T []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | T []> remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item T Returns # Promise < void > removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item T request () => Promise < any > Returns # Promise < void > Inherited from # ItemStore.removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Overrides # ItemStore.removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # ItemStore.reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # ItemStore.resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item T Returns # void Inherited from # ItemStore.select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): T [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items T [] the items to be sorted (default: the current items in this store) sorting ( item : T ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # T [] Inherited from # ItemStore.sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item T Returns # void Inherited from # ItemStore.toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems T [] Returns # void Inherited from # ItemStore.toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item T Returns # void Inherited from # ItemStore.unselect update # \u25b8 update ( item , data ): Promise < T > Parameters # Name Type item T data Partial < T > Returns # Promise < T > updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void updateItem # \u25b8 Protected updateItem ( item , request ): Promise < T > Parameters # Name Type item T request () => Promise < T > Returns # Promise < T > Inherited from # ItemStore.updateItem","title":"Class: KubeObjectStore"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#class-kubeobjectstoret","text":"Renderer . K8sApi .KubeObjectStore","title":"Class: KubeObjectStore<T>"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#type-parameters","text":"Name Type T extends KubeObject","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#hierarchy","text":"ItemStore < T > \u21b3 KubeObjectStore \u21b3\u21b3 EventStore \u21b3\u21b3 PodsStore \u21b3\u21b3 NodesStore \u21b3\u21b3 DeploymentStore \u21b3\u21b3 DaemonSetStore \u21b3\u21b3 StatefulSetStore \u21b3\u21b3 JobStore \u21b3\u21b3 CronJobStore \u21b3\u21b3 ConfigMapsStore \u21b3\u21b3 SecretsStore \u21b3\u21b3 ReplicaSetStore \u21b3\u21b3 ResourceQuotasStore \u21b3\u21b3 LimitRangesStore \u21b3\u21b3 HPAStore \u21b3\u21b3 PodDisruptionBudgetsStore \u21b3\u21b3 ServiceStore \u21b3\u21b3 EndpointStore \u21b3\u21b3 IngressStore \u21b3\u21b3 NetworkPolicyStore \u21b3\u21b3 PersistentVolumesStore \u21b3\u21b3 VolumeClaimStore \u21b3\u21b3 StorageClassStore \u21b3\u21b3 NamespaceStore \u21b3\u21b3 ServiceAccountsStore \u21b3\u21b3 RolesStore \u21b3\u21b3 RoleBindingsStore \u21b3\u21b3 CRDStore \u21b3\u21b3 CRDResourceStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#constructor","text":"\u2022 new KubeObjectStore < T >( api? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#api","text":"\u2022 api : KubeApi < T >","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#items","text":"\u2022 items : IObservableArray < T >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#iterator","text":"\u25b8 [iterator] (): Generator < T , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#create","text":"\u25b8 create ( params , data? ): Promise < T >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < T >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): T []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): T []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbyid","text":"\u25b8 getById ( id ): T","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): T []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): T","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getbypath","text":"\u25b8 getByPath ( path ): T","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getitems","text":"\u25b8 getItems (): T []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#load","text":"\u25b8 load ( params ): Promise < T >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | T []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < T >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < T >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < T []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): T []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < T >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | T []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): T [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#update","text":"\u25b8 update ( item , data ): Promise < T >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeObjectStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < T >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/","text":"Class: LimitRange # Renderer . K8sApi .LimitRange Hierarchy # KubeObject \u21b3 LimitRange Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getContainerLimits getFinalizers getId getLabels getName getNs getOwnerRefs getPVCLimits getPodLimits getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new LimitRange ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type limits LimitRangeItem [] Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/limitranges\" kind # \u25aa Static kind : string = \"LimitRange\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getContainerLimits # \u25b8 getContainerLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPVCLimits # \u25b8 getPVCLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getPodLimits # \u25b8 getPodLimits (): LimitRangeItem [] Returns # LimitRangeItem [] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < LimitRange > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#class-limitrange","text":"Renderer . K8sApi .LimitRange","title":"Class: LimitRange"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#hierarchy","text":"KubeObject \u21b3 LimitRange","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#methods","text":"delete getAge getAnnotations getContainerLimits getFinalizers getId getLabels getName getNs getOwnerRefs getPVCLimits getPodLimits getResourceVersion getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#constructor","text":"\u2022 new LimitRange ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#spec","text":"\u2022 spec : Object","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#status","text":"\u2022 Optional status : any","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/limitranges\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#kind_1","text":"\u25aa Static kind : string = \"LimitRange\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#namespaced","text":"\u25aa Static namespaced : boolean = true","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getcontainerlimits","text":"\u25b8 getContainerLimits (): LimitRangeItem []","title":"getContainerLimits"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getpvclimits","text":"\u25b8 getPVCLimits (): LimitRangeItem []","title":"getPVCLimits"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getpodlimits","text":"\u25b8 getPodLimits (): LimitRangeItem []","title":"getPodLimits"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRange/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/","text":"Class: LimitRangesStore # Renderer . K8sApi .LimitRangesStore Hierarchy # KubeObjectStore < LimitRange > \u21b3 LimitRangesStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # context contextItems contextReady namespacesReady query selectedItems Methods # [iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new LimitRangesStore ( api? ) Parameters # Name Type api? KubeApi < LimitRange > Inherited from # KubeObjectStore . constructor Properties # api # \u2022 api : KubeApi < LimitRange > Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < LimitRange > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Methods # [iterator] # \u25b8 [iterator] (): Generator < LimitRange , void , undefined > Returns # Generator < LimitRange , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater create # \u25b8 create ( params , data? ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): LimitRange [] Parameters # Name Type items LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): LimitRange [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # LimitRange [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): LimitRange Parameters # Name Type id string Returns # LimitRange Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): LimitRange [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # LimitRange [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): LimitRange Parameters # Name Type name string namespace? string Returns # LimitRange Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): LimitRange Parameters # Name Type path string Returns # LimitRange Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): LimitRange [] Returns # LimitRange [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items LimitRange [] Returns # Record < string , number > Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item LimitRange Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems LimitRange [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < LimitRange > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | LimitRange []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | LimitRange []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < LimitRange > Parameters # Name Type resourcePath string Returns # Promise < LimitRange > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < LimitRange > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < LimitRange > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < LimitRange []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams < LimitRange > Returns # Promise < LimitRange []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): LimitRange [] Parameters # Name Type partialItems LimitRange [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # LimitRange [] Inherited from # KubeObjectStore . mergeItems patch # \u25b8 patch ( item , patch ): Promise < LimitRange > Parameters # Name Type item LimitRange patch Patch Returns # Promise < LimitRange > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | LimitRange []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | LimitRange []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item LimitRange Returns # Promise < void > Inherited from # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item LimitRange request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore . select sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): LimitRange [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items LimitRange [] the items to be sorted (default: the current items in this store) sorting ( item : LimitRange ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # LimitRange [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): () => void Returns # fn \u25b8 (): void Returns # void Inherited from # KubeObjectStore . subscribe toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems LimitRange [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll unselect # \u25b8 unselect ( item ): void Parameters # Name Type item LimitRange Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < LimitRange > Parameters # Name Type item LimitRange data Partial < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < LimitRange > Parameters # Name Type item LimitRange request () => Promise < LimitRange > Returns # Promise < LimitRange > Inherited from # KubeObjectStore . updateItem","title":"Class: LimitRangesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#class-limitrangesstore","text":"Renderer . K8sApi .LimitRangesStore","title":"Class: LimitRangesStore"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#hierarchy","text":"KubeObjectStore < LimitRange > \u21b3 LimitRangesStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors","text":"context contextItems contextReady namespacesReady query selectedItems","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods","text":"[iterator] bindWatchEventsUpdater create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#constructor","text":"\u2022 new LimitRangesStore ( api? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#api","text":"\u2022 api : KubeApi < LimitRange >","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#items","text":"\u2022 items : IObservableArray < LimitRange >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#iterator","text":"\u25b8 [iterator] (): Generator < LimitRange , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#create","text":"\u25b8 create ( params , data? ): Promise < LimitRange >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < LimitRange >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): LimitRange []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): LimitRange []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyid","text":"\u25b8 getById ( id ): LimitRange","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): LimitRange []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): LimitRange","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getbypath","text":"\u25b8 getByPath ( path ): LimitRange","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getitems","text":"\u25b8 getItems (): LimitRange []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#load","text":"\u25b8 load ( params ): Promise < LimitRange >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | LimitRange []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < LimitRange >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < LimitRange >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#loaditems","text":"\u25b8 Protected loadItems ( __namedParameters ): Promise < LimitRange []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): LimitRange []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < LimitRange >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | LimitRange []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): LimitRange [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#subscribe","text":"\u25b8 subscribe (): () => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#update","text":"\u25b8 update ( item , data ): Promise < LimitRange >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.LimitRangesStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < LimitRange >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/","text":"Class: Namespace # Renderer . K8sApi .Namespace Hierarchy # KubeObject \u21b3 Namespace Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getStatus getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Namespace ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 Optional spec : any Inherited from # KubeObject . spec status # \u2022 Optional status : Object Type declaration # Name Type phase string Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/namespaces\" kind # \u25aa Static kind : string = \"Namespace\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getStatus # \u25b8 getStatus (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < Namespace > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiData isPartialJsonApiMetadata # \u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial Parameters # Name Type object unknown Returns # object is Partial Inherited from # KubeObject . isPartialJsonApiMetadata stringifyLabels # \u25b8 Static stringifyLabels ( labels? ): string [] Parameters # Name Type labels? Object Returns # string [] Inherited from # KubeObject . stringifyLabels","title":"Class: Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#class-namespace","text":"Renderer . K8sApi .Namespace","title":"Class: Namespace"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#hierarchy","text":"KubeObject \u21b3 Namespace","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#properties","text":"apiVersion kind managedFields metadata spec status apiBase kind namespaced","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#accessors","text":"selfLink","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#methods","text":"delete getAge getAnnotations getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getStatus getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#constructor","text":"\u2022 new Namespace ( data )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#managedfields","text":"\u2022 Optional managedFields : any","title":"managedFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#metadata","text":"\u2022 metadata : KubeObjectMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#spec","text":"\u2022 Optional spec : any","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#status","text":"\u2022 Optional status : Object","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#apibase","text":"\u25aa Static apiBase : string = \"/api/v1/namespaces\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#kind_1","text":"\u25aa Static kind : string = \"Namespace\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#namespaced","text":"\u25aa Static namespaced : boolean = false","title":"namespaced"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#selflink","text":"\u2022 get selfLink (): string","title":"selfLink"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#delete","text":"\u25b8 delete ( params? ): Promise < KubeJsonApiData >","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getfinalizers","text":"\u25b8 getFinalizers (): string []","title":"getFinalizers"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getid","text":"\u25b8 getId (): string","title":"getId"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getlabels","text":"\u25b8 getLabels (): string []","title":"getLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getname","text":"\u25b8 getName (): string","title":"getName"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getns","text":"\u25b8 getNs (): string","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[]","title":"getOwnerRefs"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getsearchfields","text":"\u25b8 getSearchFields (): string []","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#getstatus","text":"\u25b8 getStatus (): string","title":"getStatus"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#patch","text":"\u25b8 patch ( patch ): Promise < KubeJsonApiData >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#toplainobject","text":"\u25b8 toPlainObject (): object","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#update","text":"\u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition.","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#create","text":"\u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData","title":"isJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#isjsonapidatalist","text":"\u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList","title":"isJsonApiDataList"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#iskubejsonapilistmetadata","text":"\u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata","title":"isKubeJsonApiListMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#iskubejsonapimetadata","text":"\u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata","title":"isKubeJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#isnonsystem","text":"\u25b8 Static isNonSystem ( item ): boolean","title":"isNonSystem"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#ispartialjsonapidata","text":"\u25b8 Static isPartialJsonApiData ( object ): object is Partial","title":"isPartialJsonApiData"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#ispartialjsonapimetadata","text":"\u25b8 Static isPartialJsonApiMetadata ( object ): object is Partial","title":"isPartialJsonApiMetadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Namespace/#stringifylabels","text":"\u25b8 Static stringifyLabels ( labels? ): string []","title":"stringifyLabels"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/","text":"Class: NamespaceStore # Renderer . K8sApi .NamespaceStore Hierarchy # KubeObjectStore < Namespace > \u21b3 NamespaceStore Table of contents # Constructors # constructor Properties # api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext Accessors # allowedNamespaces context contextItems contextNamespaces contextReady hasAllContexts namespacesReady query selectedItems selectedNamespaces Methods # [iterator] bindWatchEventsUpdater clearSelected create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount hasContext isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems onContextChange patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select selectNamespaces sortItems subscribe toggleAll toggleContext toggleSelection toggleSelectionAll toggleSingle unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new NamespaceStore () Overrides # KubeObjectStore . constructor Properties # api # \u2022 api : NamespaceApi Overrides # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number = 50000 Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >> Inherited from # KubeObjectStore . eventsBuffer failedLoading # \u2022 failedLoading : boolean = false Inherited from # KubeObjectStore . failedLoading isLoaded # \u2022 isLoaded : boolean = false Inherited from # KubeObjectStore . isLoaded isLoading # \u2022 isLoading : boolean = false Inherited from # KubeObjectStore . isLoading items # \u2022 items : IObservableArray < Namespace > Inherited from # KubeObjectStore . items limit # \u2022 Optional Readonly limit : number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableMap < string , boolean > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static defaultContext : IObservableValue < ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # allowedNamespaces # \u2022 get allowedNamespaces (): string [] Returns # string [] context # \u2022 get context (): ClusterContext Returns # ClusterContext contextItems # \u2022 get contextItems (): T [] Returns # T [] contextNamespaces # \u2022 get contextNamespaces (): string [] Returns # string [] contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } hasAllContexts # \u2022 get hasAllContexts (): boolean Returns # boolean namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } query # \u2022 get query (): IKubeApiQueryParams Returns # IKubeApiQueryParams selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] selectedNamespaces # \u2022 get selectedNamespaces (): string [] Returns # string [] Methods # [iterator] # \u25b8 [iterator] (): Generator < Namespace , void , undefined > Returns # Generator < Namespace , void , undefined > Inherited from # KubeObjectStore . [iterator] bindWatchEventsUpdater # \u25b8 Protected bindWatchEventsUpdater ( delay? ): void Parameters # Name Type Default value delay number 1000 Returns # void Inherited from # KubeObjectStore . bindWatchEventsUpdater clearSelected # \u25b8 clearSelected ( namespaces? ): void Parameters # Name Type namespaces? string | string [] Returns # void create # \u25b8 create ( params , data? ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string data? Partial < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore . createItem defaultSorting # \u25b8 Protected defaultSorting ( item ): string Parameters # Name Type item Item Returns # string Inherited from # KubeObjectStore . defaultSorting filterItemsOnLoad # \u25b8 Protected filterItemsOnLoad ( items ): Namespace [] Parameters # Name Type items Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore . filterItemsOnLoad getAllByNs # \u25b8 getAllByNs ( namespace , strict? ): Namespace [] Parameters # Name Type Default value namespace string | string [] undefined strict boolean false Returns # Namespace [] Inherited from # KubeObjectStore . getAllByNs getById # \u25b8 getById ( id ): Namespace Parameters # Name Type id string Returns # Namespace Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Namespace [] Parameters # Name Type labels string [] | { [label: string]: string ; } Returns # Namespace [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): Namespace Parameters # Name Type name string namespace? string Returns # Namespace Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): Namespace Parameters # Name Type path string Returns # Namespace Inherited from # KubeObjectStore . getByPath getIndexById # \u25b8 getIndexById ( id ): number Parameters # Name Type id string Returns # number Inherited from # KubeObjectStore . getIndexById getItems # \u25b8 getItems (): Namespace [] Returns # Namespace [] Inherited from # KubeObjectStore . getItems getStatuses # \u25b8 Optional getStatuses ( items ): Record < string , number > Parameters # Name Type items Namespace [] Returns # Record < string , number > Inherited from # KubeObjectStore . getStatuses getTotalCount # \u25b8 getTotalCount (): number Returns # number Inherited from # KubeObjectStore . getTotalCount hasContext # \u25b8 hasContext ( namespaces ): boolean Parameters # Name Type namespaces string | string [] Returns # boolean isSelected # \u25b8 isSelected ( item ): boolean Parameters # Name Type item Namespace Returns # boolean Inherited from # KubeObjectStore . isSelected isSelectedAll # \u25b8 isSelectedAll ( visibleItems? ): boolean Parameters # Name Type visibleItems Namespace [] Returns # boolean Inherited from # KubeObjectStore . isSelectedAll load # \u25b8 load ( params ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Namespace > Inherited from # KubeObjectStore . load loadAll # \u25b8 loadAll ( options? ): Promise < void | Namespace []> Parameters # Name Type options Object options.merge? boolean options.namespaces? string [] options.reqInit? RequestInit Returns # Promise < void | Namespace []> Inherited from # KubeObjectStore . loadAll loadFromPath # \u25b8 loadFromPath ( resourcePath ): Promise < Namespace > Parameters # Name Type resourcePath string Returns # Promise < Namespace > Inherited from # KubeObjectStore . loadFromPath loadItem # \u25b8 Protected loadItem ( params ): Promise < Namespace > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < Namespace > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( params ): Promise < Namespace []> Parameters # Name Type params KubeObjectStoreLoadingParams < Namespace > Returns # Promise < Namespace []> Overrides # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Namespace [] Parameters # Name Type partialItems Namespace [] __namedParameters Object __namedParameters.filter boolean __namedParameters.replace boolean __namedParameters.sort boolean __namedParameters.updateStore boolean Returns # Namespace [] Inherited from # KubeObjectStore . mergeItems onContextChange # \u25b8 onContextChange ( callback , opts? ): IReactionDisposer Parameters # Name Type callback ( namespaces : string []) => void opts IReactionOptions Returns # IReactionDisposer patch # \u25b8 patch ( item , patch ): Promise < Namespace > Parameters # Name Type item Namespace patch Patch Returns # Promise < Namespace > Inherited from # KubeObjectStore . patch reloadAll # \u25b8 reloadAll ( opts? ): Promise < void | Namespace []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < void | Namespace []> Inherited from # KubeObjectStore . reloadAll remove # \u25b8 remove ( item ): Promise < void > Parameters # Name Type item Namespace Returns # Promise < void > Overrides # KubeObjectStore . remove removeItem # \u25b8 Protected removeItem ( item , request ): Promise < void > Parameters # Name Type item Namespace request () => Promise < any > Returns # Promise < void > Inherited from # KubeObjectStore . removeItem removeSelectedItems # \u25b8 removeSelectedItems (): Promise < void []> Returns # Promise < void []> Inherited from # KubeObjectStore . removeSelectedItems reset # \u25b8 reset (): void Returns # void Inherited from # KubeObjectStore . reset resetOnError # \u25b8 Protected resetOnError ( error ): void Parameters # Name Type error any Returns # void Inherited from # KubeObjectStore . resetOnError resetSelection # \u25b8 resetSelection (): void Returns # void Inherited from # KubeObjectStore . resetSelection select # \u25b8 select ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore . select selectNamespaces # \u25b8 selectNamespaces ( namespace ): void Parameters # Name Type namespace string | string [] Returns # void sortItems # \u25b8 Protected sortItems ( items? , sorting? , order? ): Namespace [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort). Parameters # Name Type Description items Namespace [] the items to be sorted (default: the current items in this store) sorting ( item : Namespace ) => any [] list of functions to determine sort order (default: sorting by name) order? \"desc\" | \"asc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Namespace [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe (): (... args : T ) => void Returns # fn \u25b8 < T >(... args ): void A function that does nothing Type parameters # Name Type T extends any [] Parameters # Name Type ...args T Returns # void Overrides # KubeObjectStore . subscribe toggleAll # \u25b8 toggleAll ( showAll? ): void Parameters # Name Type showAll? boolean Returns # void toggleContext # \u25b8 toggleContext ( namespaces ): void Parameters # Name Type namespaces string | string [] Returns # void toggleSelection # \u25b8 toggleSelection ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore . toggleSelection toggleSelectionAll # \u25b8 toggleSelectionAll ( visibleItems? ): void Parameters # Name Type visibleItems Namespace [] Returns # void Inherited from # KubeObjectStore . toggleSelectionAll toggleSingle # \u25b8 toggleSingle ( namespace ): void Parameters # Name Type namespace string Returns # void unselect # \u25b8 unselect ( item ): void Parameters # Name Type item Namespace Returns # void Inherited from # KubeObjectStore . unselect update # \u25b8 update ( item , data ): Promise < Namespace > Parameters # Name Type item Namespace data Partial < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore . update updateFromEventsBuffer # \u25b8 Protected updateFromEventsBuffer (): void Returns # void Inherited from # KubeObjectStore . updateFromEventsBuffer updateItem # \u25b8 Protected updateItem ( item , request ): Promise < Namespace > Parameters # Name Type item Namespace request () => Promise < Namespace > Returns # Promise < Namespace > Inherited from # KubeObjectStore . updateItem","title":"Class: NamespaceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#class-namespacestore","text":"Renderer . K8sApi .NamespaceStore","title":"Class: NamespaceStore"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hierarchy","text":"KubeObjectStore < Namespace > \u21b3 NamespaceStore","title":"Hierarchy"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#table-of-contents","text":"","title":"Table of contents"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors","text":"constructor","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties","text":"api bufferSize eventsBuffer failedLoading isLoaded isLoading items limit selectedItemsIds defaultContext","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors","text":"allowedNamespaces context contextItems contextNamespaces contextReady hasAllContexts namespacesReady query selectedItems selectedNamespaces","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods","text":"[iterator] bindWatchEventsUpdater clearSelected create createItem defaultSorting filterItemsOnLoad getAllByNs getById getByLabel getByName getByPath getIndexById getItems getStatuses getTotalCount hasContext isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems onContextChange patch reloadAll remove removeItem removeSelectedItems reset resetOnError resetSelection select selectNamespaces sortItems subscribe toggleAll toggleContext toggleSelection toggleSelectionAll toggleSingle unselect update updateFromEventsBuffer updateItem","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructors_1","text":"","title":"Constructors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#constructor","text":"\u2022 new NamespaceStore ()","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#api","text":"\u2022 api : NamespaceApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#buffersize","text":"\u2022 Readonly bufferSize : number = 50000","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData >>","title":"eventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#failedloading","text":"\u2022 failedLoading : boolean = false","title":"failedLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloaded","text":"\u2022 isLoaded : boolean = false","title":"isLoaded"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isloading","text":"\u2022 isLoading : boolean = false","title":"isLoading"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#items","text":"\u2022 items : IObservableArray < Namespace >","title":"items"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#limit","text":"\u2022 Optional Readonly limit : number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableMap < string , boolean >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#defaultcontext","text":"\u25aa Static defaultContext : IObservableValue < ClusterContext >","title":"defaultContext"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#allowednamespaces","text":"\u2022 get allowedNamespaces (): string []","title":"allowedNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#context","text":"\u2022 get context (): ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextitems","text":"\u2022 get contextItems (): T []","title":"contextItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextnamespaces","text":"\u2022 get contextNamespaces (): string []","title":"contextNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#contextready","text":"\u2022 get contextReady (): Promise < void > & { cancel : () => void }","title":"contextReady"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hasallcontexts","text":"\u2022 get hasAllContexts (): boolean","title":"hasAllContexts"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#namespacesready","text":"\u2022 get namespacesReady (): Promise < void > & { cancel : () => void }","title":"namespacesReady"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#query","text":"\u2022 get query (): IKubeApiQueryParams","title":"query"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selecteditems","text":"\u2022 get selectedItems (): Item []","title":"selectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectednamespaces","text":"\u2022 get selectedNamespaces (): string []","title":"selectedNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#iterator","text":"\u25b8 [iterator] (): Generator < Namespace , void , undefined >","title":"[iterator]"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#bindwatcheventsupdater","text":"\u25b8 Protected bindWatchEventsUpdater ( delay? ): void","title":"bindWatchEventsUpdater"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#clearselected","text":"\u25b8 clearSelected ( namespaces? ): void","title":"clearSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#create","text":"\u25b8 create ( params , data? ): Promise < Namespace >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#createitem","text":"\u25b8 Protected createItem ( params , data? ): Promise < Namespace >","title":"createItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#defaultsorting","text":"\u25b8 Protected defaultSorting ( item ): string","title":"defaultSorting"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#filteritemsonload","text":"\u25b8 Protected filterItemsOnLoad ( items ): Namespace []","title":"filterItemsOnLoad"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getallbyns","text":"\u25b8 getAllByNs ( namespace , strict? ): Namespace []","title":"getAllByNs"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyid","text":"\u25b8 getById ( id ): Namespace","title":"getById"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbylabel","text":"\u25b8 getByLabel ( labels ): Namespace []","title":"getByLabel"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbyname","text":"\u25b8 getByName ( name , namespace? ): Namespace","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getbypath","text":"\u25b8 getByPath ( path ): Namespace","title":"getByPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getindexbyid","text":"\u25b8 getIndexById ( id ): number","title":"getIndexById"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getitems","text":"\u25b8 getItems (): Namespace []","title":"getItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#getstatuses","text":"\u25b8 Optional getStatuses ( items ): Record < string , number >","title":"getStatuses"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#gettotalcount","text":"\u25b8 getTotalCount (): number","title":"getTotalCount"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#hascontext","text":"\u25b8 hasContext ( namespaces ): boolean","title":"hasContext"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselected","text":"\u25b8 isSelected ( item ): boolean","title":"isSelected"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#isselectedall","text":"\u25b8 isSelectedAll ( visibleItems? ): boolean","title":"isSelectedAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#load","text":"\u25b8 load ( params ): Promise < Namespace >","title":"load"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadall","text":"\u25b8 loadAll ( options? ): Promise < void | Namespace []>","title":"loadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loadfrompath","text":"\u25b8 loadFromPath ( resourcePath ): Promise < Namespace >","title":"loadFromPath"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditem","text":"\u25b8 Protected loadItem ( params ): Promise < Namespace >","title":"loadItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#loaditems","text":"\u25b8 Protected loadItems ( params ): Promise < Namespace []>","title":"loadItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#mergeitems","text":"\u25b8 Protected mergeItems ( partialItems , __namedParameters? ): Namespace []","title":"mergeItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#oncontextchange","text":"\u25b8 onContextChange ( callback , opts? ): IReactionDisposer","title":"onContextChange"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#patch","text":"\u25b8 patch ( item , patch ): Promise < Namespace >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < void | Namespace []>","title":"reloadAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#remove","text":"\u25b8 remove ( item ): Promise < void >","title":"remove"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeitem","text":"\u25b8 Protected removeItem ( item , request ): Promise < void >","title":"removeItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#removeselecteditems","text":"\u25b8 removeSelectedItems (): Promise < void []>","title":"removeSelectedItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#reset","text":"\u25b8 reset (): void","title":"reset"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetonerror","text":"\u25b8 Protected resetOnError ( error ): void","title":"resetOnError"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#resetselection","text":"\u25b8 resetSelection (): void","title":"resetSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#select","text":"\u25b8 select ( item ): void","title":"select"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#selectnamespaces","text":"\u25b8 selectNamespaces ( namespace ): void","title":"selectNamespaces"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#sortitems","text":"\u25b8 Protected sortItems ( items? , sorting? , order? ): Namespace [] Return items sorted by the given ordering functions. If two elements of items are sorted to the same \"index\" then the next sorting function is used to determine where to place them relative to each other. Once the sorting functions have been all exhausted then the order is unchanged (ie a stable sort).","title":"sortItems"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#subscribe","text":"\u25b8 subscribe (): (... args : T ) => void","title":"subscribe"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleall","text":"\u25b8 toggleAll ( showAll? ): void","title":"toggleAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#togglecontext","text":"\u25b8 toggleContext ( namespaces ): void","title":"toggleContext"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselection","text":"\u25b8 toggleSelection ( item ): void","title":"toggleSelection"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#toggleselectionall","text":"\u25b8 toggleSelectionAll ( visibleItems? ): void","title":"toggleSelectionAll"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#togglesingle","text":"\u25b8 toggleSingle ( namespace ): void","title":"toggleSingle"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#unselect","text":"\u25b8 unselect ( item ): void","title":"unselect"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#update","text":"\u25b8 update ( item , data ): Promise < Namespace >","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updatefromeventsbuffer","text":"\u25b8 Protected updateFromEventsBuffer (): void","title":"updateFromEventsBuffer"},{"location":"extensions/api/classes/Renderer.K8sApi.NamespaceStore/#updateitem","text":"\u25b8 Protected updateItem ( item , request ): Promise < Namespace >","title":"updateItem"},{"location":"extensions/api/classes/Renderer.K8sApi.NetworkPolicy/","text":"Class: NetworkPolicy # Renderer . K8sApi .NetworkPolicy Hierarchy # KubeObject \u21b3 NetworkPolicy Table of contents # Constructors # constructor Properties # apiVersion kind managedFields metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getFinalizers getId getLabels getMatchLabels getName getNs getOwnerRefs getResourceVersion getSearchFields getTimeDiffFromNow getTypes patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new NetworkPolicy ( data ) Parameters # Name Type data KubeJsonApiData Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind managedFields # \u2022 Optional managedFields : any Inherited from # KubeObject . managedFields metadata # \u2022 metadata : KubeObjectMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : Object Type declaration # Name Type egress IPolicyEgress [] ingress IPolicyIngress [] podSelector Object podSelector.matchLabels Object podSelector.matchLabels.role string policyTypes string [] Inherited from # KubeObject . spec status # \u2022 Optional status : any Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/networking.k8s.io/v1/networkpolicies\" kind # \u25aa Static kind : string = \"NetworkPolicy\" Inherited from # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Inherited from # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData > Parameters # Name Type params? JsonApiParams < any > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number Parameters # Name Type Default value humanize boolean true compact boolean true fromNow boolean false Returns # string | number Inherited from # KubeObject . getAge getAnnotations # \u25b8 getAnnotations ( filter? ): string [] Parameters # Name Type Default value filter boolean false Returns # string [] Inherited from # KubeObject . getAnnotations getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getMatchLabels # \u25b8 getMatchLabels (): string [] Returns # string [] getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): string Returns # string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion : boolean ; controller : boolean ; kind : string ; name : string ; namespace : string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTypes # \u25b8 getTypes (): string [] Returns # string [] patch # \u25b8 patch ( patch ): Promise < KubeJsonApiData > Parameters # Name Type patch Patch Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): object Returns # object Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < KubeJsonApiData > Perform a full update (or more specifically a replace) Note: this is brittle if data is not actually partial (but instead whole). As fields such as resourceVersion will probably out of date. This is a common race condition. Parameters # Name Type data Partial < NetworkPolicy > Returns # Promise < KubeJsonApiData > Inherited from # KubeObject . update create # \u25b8 Static create ( data ): KubeObject < KubeObjectMetadata , any , any > Parameters # Name Type data KubeJsonApiData Returns # KubeObject < KubeObjectMetadata , any , any > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData Parameters # Name Type object unknown Returns # object is KubeJsonApiData Inherited from # KubeObject . isJsonApiData isJsonApiDataList # \u25b8 Static isJsonApiDataList < T >( object , verifyItem ): object is KubeJsonApiDataList Type parameters # Name T Parameters # Name Type object unknown verifyItem ( val : unknown ) => val is T Returns # object is KubeJsonApiDataList Inherited from # KubeObject . isJsonApiDataList isKubeJsonApiListMetadata # \u25b8 Static isKubeJsonApiListMetadata ( object ): object is KubeJsonApiListMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiListMetadata Inherited from # KubeObject . isKubeJsonApiListMetadata isKubeJsonApiMetadata # \u25b8 Static isKubeJsonApiMetadata ( object ): object is KubeJsonApiMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeObject < KubeObjectMetadata , any , any > | KubeJsonApiData Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial