isDisabled
@@ -811,12 +818,16 @@
Table of contents
Properties
Properties
+id
+• Optional id: string
+
isDisabled
• Optional isDisabled: boolean
diff --git a/master/search/search_index.json b/master/search/search_index.json
index 1d6c7c7521..5ac7769a28 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 getBadge getId getMaxListeners getName 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 The version of category that you are wanting to declare. Currently supported values: \"catalog.k8slens.dev/v1alpha1\" filters # \u2022 Protected Readonly filters : ObservableSet < AddMenuFilter > kind # \u2022 Readonly Abstract kind : string The kind of item you wish to declare. Currently supported values: \"CatalogCategory\" metadata # \u2022 Readonly Abstract metadata : CatalogCategoryMetadata The data about the category itself spec # \u2022 Readonly Abstract spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared. 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 getBadge # \u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu Returns # ReactNode getId # \u25b8 getId (): string Get the ID of this category Returns # string getMaxListeners # \u25b8 getMaxListeners (): number Returns # number Inherited from # (EventEmitter as new () => TypedEmitter).getMaxListeners getName # \u25b8 getName (): string Get the name of this category Returns # string 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 Parse a category ID into parts. Parameters # Name Type Description id string The id of a category is parse Returns # Object The group and kind parts of the ID 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 getBadge getId getMaxListeners getName 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 The version of category that you are wanting to declare. Currently supported values: \"catalog.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#filters","text":"\u2022 Protected Readonly filters : ObservableSet < AddMenuFilter >","title":"filters"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#kind","text":"\u2022 Readonly Abstract kind : string The kind of item you wish to declare. Currently supported values: \"CatalogCategory\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#metadata","text":"\u2022 Readonly Abstract metadata : CatalogCategoryMetadata The data about the category itself","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#spec","text":"\u2022 Readonly Abstract spec : CatalogCategorySpec The most important part of a category, as it is where entity versions are declared.","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/#getbadge","text":"\u25b8 getBadge (): ReactNode Get the badge of this category. Defaults to no badge. The badge is displayed next to the Category name in the Catalog Category menu","title":"getBadge"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getid","text":"\u25b8 getId (): string Get the ID of this category","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getmaxlisteners","text":"\u25b8 getMaxListeners (): number","title":"getMaxListeners"},{"location":"extensions/api/classes/Common.Catalog.CatalogCategory/#getname","text":"\u25b8 getName (): string Get the name of this category","title":"getName"},{"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 Parse a category ID into parts.","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 getSource isEnabled onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new CatalogEntity < Metadata , Status , Spec >( __namedParameters ) Type parameters # Name Type Metadata extends CatalogEntityMetadata < Metadata > = CatalogEntityMetadata Status extends CatalogEntityStatus = CatalogEntityStatus Spec extends CatalogEntitySpec = CatalogEntitySpec Parameters # Name Type __namedParameters CatalogEntityData < Metadata , Status , Spec > Properties # apiVersion # \u2022 Readonly Abstract apiVersion : string The group and version of this class. Implementation of # CatalogEntityKindData . apiVersion kind # \u2022 Readonly Abstract kind : string A DNS label name of the entity. Implementation of # CatalogEntityKindData . kind metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 status : Status Methods # getId # \u25b8 getId (): string Get the UID of this entity Returns # string getName # \u25b8 getName (): string Get the name of this entity Returns # string getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean onContextMenuOpen # \u25b8 Optional onContextMenuOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityContextMenuContext Returns # void | Promise < void > onRun # \u25b8 Optional onRun ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityActionContext Returns # void | Promise < void > onSettingsOpen # \u25b8 Optional 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 getSource isEnabled 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 >( __namedParameters )","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 The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#kind","text":"\u2022 Readonly Abstract kind : string A DNS label name of the entity.","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 Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#oncontextmenuopen","text":"\u25b8 Optional onContextMenuOpen ( context ): void | Promise < void >","title":"onContextMenuOpen"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onrun","text":"\u25b8 Optional onRun ( context ): void | Promise < void >","title":"onRun"},{"location":"extensions/api/classes/Common.Catalog.CatalogEntity/#onsettingsopen","text":"\u25b8 Optional onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/","text":"Class: GeneralEntity # Common . Catalog .GeneralEntity Hierarchy # CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > \u21b3 GeneralEntity Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status Methods # getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new GeneralEntity ( __namedParameters ) Parameters # Name Type __namedParameters CatalogEntityData < CatalogEntityMetadata , CatalogEntityStatus , GeneralEntitySpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class. Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"General\" A DNS label name of the entity. 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 Get the UID of this entity Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Get the name of this entity Returns # string Inherited from # CatalogEntity . getName getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string Inherited from # CatalogEntity . getSource isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean Inherited from # CatalogEntity . isEnabled onContextMenuOpen # \u25b8 Optional onContextMenuOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntityContextMenuContext Returns # void | Promise < void > Inherited from # CatalogEntity . onContextMenuOpen onRun # \u25b8 onRun (): Promise < void > Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 Optional onSettingsOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise < void > Inherited from # CatalogEntity . onSettingsOpen","title":"Class: GeneralEntity"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#class-generalentity","text":"Common . Catalog .GeneralEntity","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 getSource isEnabled onContextMenuOpen 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 ( __namedParameters )","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\" The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#kind","text":"\u2022 Readonly kind : \"General\" A DNS label name of the entity.","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 Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.GeneralEntity/#oncontextmenuopen","text":"\u25b8 Optional onContextMenuOpen ( context ): void | Promise < void >","title":"onContextMenuOpen"},{"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 Optional onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/","text":"Class: KubernetesCluster # Common . Catalog .KubernetesCluster Type parameters # Name Type Metadata extends KubernetesClusterMetadata = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec = KubernetesClusterSpec Hierarchy # CatalogEntity < Metadata , Status , Spec > \u21b3 KubernetesCluster Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiVersion kind Methods # connect disconnect getId getName getSource isEnabled onContextMenuOpen onDetailsOpen onRun onSettingsOpen Constructors # constructor # \u2022 new KubernetesCluster < Metadata , Status , Spec >( __namedParameters ) Type parameters # Name Type Metadata extends KubernetesClusterMetadata < Metadata > = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec < Spec > = KubernetesClusterSpec Parameters # Name Type __namedParameters CatalogEntityData < Metadata , Status , Spec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : string = KubernetesCluster.apiVersion The group and version of this class. Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : string = KubernetesCluster.kind A DNS label name of the entity. Overrides # CatalogEntity . kind metadata # \u2022 metadata : Metadata Inherited from # CatalogEntity . metadata spec # \u2022 spec : Spec Inherited from # CatalogEntity . spec status # \u2022 status : Status Inherited from # CatalogEntity . status apiVersion # \u25aa Static Readonly apiVersion : string = \"entity.k8slens.dev/v1alpha1\" kind # \u25aa Static Readonly kind : string = \"KubernetesCluster\" Methods # connect # \u25b8 connect (): Promise < void > Returns # Promise < void > disconnect # \u25b8 disconnect (): Promise < void > Returns # Promise < void > getId # \u25b8 getId (): string Get the UID of this entity Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Get the name of this entity Returns # string Inherited from # CatalogEntity . getName getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string Inherited from # CatalogEntity . getSource isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean Inherited from # CatalogEntity . isEnabled onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): void Parameters # Name Type context CatalogEntityContextMenuContext Returns # 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-kubernetesclustermetadata-status-spec","text":"Common . Catalog .KubernetesCluster","title":"Class: KubernetesCluster<Metadata, Status, Spec>"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#type-parameters","text":"Name Type Metadata extends KubernetesClusterMetadata = KubernetesClusterMetadata Status extends KubernetesClusterStatus = KubernetesClusterStatus Spec extends KubernetesClusterSpec = KubernetesClusterSpec","title":"Type parameters"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#hierarchy","text":"CatalogEntity < Metadata , Status , Spec > \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 getSource isEnabled 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 < Metadata , Status , Spec >( __namedParameters )","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 : string = KubernetesCluster.apiVersion The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind","text":"\u2022 Readonly kind : string = KubernetesCluster.kind A DNS label name of the entity.","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#metadata","text":"\u2022 metadata : Metadata","title":"metadata"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#spec","text":"\u2022 spec : Spec","title":"spec"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#status","text":"\u2022 status : Status","title":"status"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#apiversion_1","text":"\u25aa Static Readonly apiVersion : string = \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#kind_1","text":"\u25aa Static Readonly kind : string = \"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 Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.KubernetesCluster/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): 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 Hierarchy # CatalogEntity < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > \u21b3 WebLink Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiVersion kind Methods # getId getName getSource isEnabled onContextMenuOpen onRun onSettingsOpen Constructors # constructor # \u2022 new WebLink ( __namedParameters ) Parameters # Name Type __namedParameters CatalogEntityData < CatalogEntityMetadata , WebLinkStatus , WebLinkSpec > Inherited from # CatalogEntity . constructor Properties # apiVersion # \u2022 Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" The group and version of this class. Overrides # CatalogEntity . apiVersion kind # \u2022 Readonly kind : \"WebLink\" A DNS label name of the entity. 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 apiVersion # \u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\" kind # \u25aa Static Readonly kind : \"WebLink\" Methods # getId # \u25b8 getId (): string Get the UID of this entity Returns # string Inherited from # CatalogEntity . getId getName # \u25b8 getName (): string Get the name of this entity Returns # string Inherited from # CatalogEntity . getName getSource # \u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided Returns # string Inherited from # CatalogEntity . getSource isEnabled # \u25b8 isEnabled (): boolean Get if this entity is enabled. Returns # boolean Inherited from # CatalogEntity . isEnabled onContextMenuOpen # \u25b8 onContextMenuOpen ( context ): void Parameters # Name Type context CatalogEntityContextMenuContext Returns # void Overrides # CatalogEntity . onContextMenuOpen onRun # \u25b8 onRun (): Promise < void > Returns # Promise < void > Overrides # CatalogEntity . onRun onSettingsOpen # \u25b8 Optional onSettingsOpen ( context ): void | Promise < void > Parameters # Name Type context CatalogEntitySettingsContext Returns # void | Promise < void > Inherited from # CatalogEntity . onSettingsOpen","title":"Class: WebLink"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#class-weblink","text":"Common . Catalog .WebLink","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 apiVersion kind","title":"Properties"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods","text":"getId getName getSource isEnabled 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 ( __namedParameters )","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\" The group and version of this class.","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind","text":"\u2022 Readonly kind : \"WebLink\" A DNS label name of the entity.","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/#apiversion_1","text":"\u25aa Static Readonly apiVersion : \"entity.k8slens.dev/v1alpha1\"","title":"apiVersion"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#kind_1","text":"\u25aa Static Readonly kind : \"WebLink\"","title":"kind"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getid","text":"\u25b8 getId (): string Get the UID of this entity","title":"getId"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getname","text":"\u25b8 getName (): string Get the name of this entity","title":"getName"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#getsource","text":"\u25b8 getSource (): string Get the specified source of this entity, defaulting to \"unknown\" if not provided","title":"getSource"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#isenabled","text":"\u25b8 isEnabled (): boolean Get if this entity is enabled.","title":"isEnabled"},{"location":"extensions/api/classes/Common.Catalog.WebLink/#oncontextmenuopen","text":"\u25b8 onContextMenuOpen ( context ): 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 Optional onSettingsOpen ( context ): void | Promise < void >","title":"onSettingsOpen"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/","text":"Class: ExtensionStore # Common . Store .ExtensionStore Type parameters # Name T Hierarchy # BaseStore < T > \u21b3 ExtensionStore Table of contents # Constructors # constructor Properties # displayName 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 # displayName # \u2022 Readonly displayName : \"ExtensionStore\" Overrides # BaseStore.displayName extension # \u2022 Protected Optional extension : LensExtension < LensExtensionDependencies > 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 Inherited from # BaseStore.name path # \u2022 get path (): string Returns # string Inherited from # BaseStore.path syncMainChannel # \u2022 Protected get syncMainChannel (): string Returns # string Inherited from # BaseStore.syncMainChannel syncRendererChannel # \u2022 Protected get syncRendererChannel (): string Returns # string Inherited from # BaseStore.syncRendererChannel 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 < LensExtensionDependencies > Returns # void onModelChange # \u25b8 Protected onModelChange ( model ): void Parameters # Name Type model T Returns # 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 ): void Parameters # Name Type model T Returns # 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 >( this , ... 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 this StaticThis < T , R > Implicit argument that is the child class type ...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 >( this , 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 this StaticThis < T , R > Implicit argument that is the child class type strict? true 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 \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T 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","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":"displayName 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/#displayname","text":"\u2022 Readonly displayName : \"ExtensionStore\"","title":"displayName"},{"location":"extensions/api/classes/Common.Store.ExtensionStore/#extension","text":"\u2022 Protected Optional extension : LensExtension < LensExtensionDependencies >","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 ): 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 ): 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 >( this , ... 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 >( this , 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 Table of contents # Constructors # constructor Methods # createInstance getInstance resetInstance Constructors # constructor # \u2022 new Singleton () Methods # createInstance # \u25b8 Static createInstance < T , R >( this , ... 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 this StaticThis < T , R > Implicit argument that is the child class type ...args R The constructor arguments for the child class Returns # T An instance of the child class getInstance # \u25b8 Static getInstance < T , R >( this , 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 this StaticThis < T , R > Implicit argument that is the child class type strict? true If false will return undefined instead of throwing when an instance doesn't exist. Default: true Returns # T An instance of the child class \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T 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","title":"Class: Singleton"},{"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 >( this , ... 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 >( this , 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.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@80377 extension # \u2022 Protected extension : LensExtension < LensExtensionDependencies > 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 >( this , ... 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 this StaticThis < T , R > Implicit argument that is the child class type ...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 >( this , 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 this StaticThis < T , R > Implicit argument that is the child class type strict? true 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 \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T 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 < LensExtensionDependencies >","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 >( this , ... 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 >( this , 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 < LensMainExtensionDependencies > \u21b3 LensExtension Table of contents # Constructors # constructor Properties # [Disposers] [lensExtensionDependencies] appMenus id isBundled manifest manifestPath protocolHandlers terminalShellEnvModifier trayMenus Accessors # description isEnabled name sanitizedExtensionId version Methods # activate 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@29707 [lensExtensionDependencies] # \u2022 Readonly [lensExtensionDependencies] : LensMainExtensionDependencies Inherited from # LensExtension.__@lensExtensionDependencies@29710 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 terminalShellEnvModifier # \u2022 Optional terminalShellEnvModifier : ShellEnvModifier implement this to modify the shell environment that Lens terminals are opened with. The ShellEnvModifier type has the signature (ctx: ShellEnvContext, env: Record ) => Record param the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get cluster-specific information that can be made available in the shell environment by the implementation of terminalShellEnvModifier param the current shell environment that the terminal will be opened with. The implementation should modify this as desired. trayMenus # \u2022 trayMenus : TrayMenuRegistration [] = [] Accessors # description # \u2022 get description (): undefined | string Returns # undefined | string Inherited from # LensExtension.description isEnabled # \u2022 get isEnabled (): boolean Returns # boolean Inherited from # LensExtension.isEnabled name # \u2022 get name (): string Returns # string Inherited from # LensExtension.name sanitizedExtensionId # \u2022 get sanitizedExtensionId (): string Returns # string Inherited from # LensExtension.sanitizedExtensionId version # \u2022 get version (): string Returns # string Inherited from # LensExtension.version Methods # activate # \u25b8 activate (): Promise < void > Returns # Promise < void > Inherited from # LensExtension.activate 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 < LensMainExtensionDependencies > \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] [lensExtensionDependencies] appMenus id isBundled manifest manifestPath protocolHandlers terminalShellEnvModifier trayMenus","title":"Properties"},{"location":"extensions/api/classes/Main.LensExtension/#accessors","text":"description isEnabled name sanitizedExtensionId version","title":"Accessors"},{"location":"extensions/api/classes/Main.LensExtension/#methods","text":"activate 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/#lensextensiondependencies","text":"\u2022 Readonly [lensExtensionDependencies] : LensMainExtensionDependencies","title":"[lensExtensionDependencies]"},{"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/#terminalshellenvmodifier","text":"\u2022 Optional terminalShellEnvModifier : ShellEnvModifier implement this to modify the shell environment that Lens terminals are opened with. The ShellEnvModifier type has the signature (ctx: ShellEnvContext, env: Record ) => Record param the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get cluster-specific information that can be made available in the shell environment by the implementation of terminalShellEnvModifier param the current shell environment that the terminal will be opened with. The implementation should modify this as desired.","title":"terminalShellEnvModifier"},{"location":"extensions/api/classes/Main.LensExtension/#traymenus","text":"\u2022 trayMenus : TrayMenuRegistration [] = []","title":"trayMenus"},{"location":"extensions/api/classes/Main.LensExtension/#accessors_1","text":"","title":"Accessors"},{"location":"extensions/api/classes/Main.LensExtension/#description","text":"\u2022 get description (): undefined | string","title":"description"},{"location":"extensions/api/classes/Main.LensExtension/#isenabled","text":"\u2022 get isEnabled (): boolean","title":"isEnabled"},{"location":"extensions/api/classes/Main.LensExtension/#name","text":"\u2022 get name (): string","title":"name"},{"location":"extensions/api/classes/Main.LensExtension/#sanitizedextensionid","text":"\u2022 get sanitizedExtensionId (): string","title":"sanitizedExtensionId"},{"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/#activate","text":"\u25b8 activate (): Promise < void >","title":"activate"},{"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 (): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Currently active/visible entity Returns # undefined | 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 ): undefined | CatalogEntity < CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > Parameters # Name Type id string Returns # undefined | 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 (): undefined | 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 ): undefined | 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.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 <{ children? : ReactNode }> 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 - 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 - 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 - 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 - 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 - 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 - 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 null | State | ( prevState : Readonly < State >, props : Readonly < DrawerParamTogglerProps >) => null | 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 <{ children? : ReactNode }>","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 - 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 - 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 - 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 - 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 - 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 - 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.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 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 input # \u2022 input : null | InputElement = null props # \u2022 Readonly props : Readonly < InputProps > & Readonly <{ children? : ReactNode }> 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 : DebouncedFunc <() => void > state # \u2022 state : State Overrides # React.Component.state validators # \u2022 validators : InputValidator < 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 : object Accessors # isUncontrolled # \u2022 get isUncontrolled (): boolean Returns # boolean showMaxLenIndicator # \u2022 get showMaxLenIndicator (): undefined | boolean | 0 Returns # undefined | boolean | 0 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 - 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 - 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 - 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 - 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 - 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 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 - 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 ): Promise < void > Parameters # Name Type evt ChangeEvent < any > Returns # Promise < 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 null | State | ( prevState : Readonly < State >, props : Readonly < InputProps >) => null | 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 : null | InputElement = null","title":"input"},{"location":"extensions/api/classes/Renderer.Component.Input/#props","text":"\u2022 Readonly props : Readonly < InputProps > & Readonly <{ children? : ReactNode }>","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 : DebouncedFunc <() => void >","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 < boolean >[] = []","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 (): undefined | boolean | 0","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 - 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 - 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 - 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 - 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 - 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 componentWillUnmount (): void","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 - 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 ): Promise < 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.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 isClosed 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 : null | HTMLUListElement = null items # \u2022 Protected items : Object = {} Index signature # \u25aa [index: number ]: MenuItem opener # \u2022 opener : null | HTMLElement = null props # \u2022 Readonly props : Readonly < MenuProps > & Readonly <{ children? : ReactNode }> 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 (): undefined | MenuItem Returns # undefined | MenuItem isClosed # \u2022 get isClosed (): boolean Returns # boolean 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 - 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 - 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 - 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 - 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 - 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 - 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 | KeyboardEvent < Element > Returns # void onScrollOutside # \u25b8 onScrollOutside ( evt ): void Parameters # Name Type evt Event Returns # void onWindowResize # \u25b8 onWindowResize (): void Returns # void open # \u25b8 open (): void Returns # void refreshPosition # \u25b8 refreshPosition (): number Returns # number 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 null | State | ( prevState : Readonly < State >, props : Readonly < MenuProps >) => null | 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 isClosed 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 : null | HTMLUListElement = null","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 : null | HTMLElement = null","title":"opener"},{"location":"extensions/api/classes/Renderer.Component.Menu/#props","text":"\u2022 Readonly props : Readonly < MenuProps > & Readonly <{ children? : ReactNode }>","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 (): undefined | MenuItem","title":"focusedItem"},{"location":"extensions/api/classes/Renderer.Component.Menu/#isclosed","text":"\u2022 get isClosed (): boolean","title":"isClosed"},{"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 - 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 - 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 - 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 - 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 - 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 - 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 (): number","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.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 : null | HTMLElement = null props # \u2022 Readonly props : Readonly < MenuItemProps > & Readonly <{ children? : ReactNode }> 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 <{}> Inherited from # React.Component.state contextType # \u25aa Static contextType : Context < null | Menu > = MenuContext 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuItemProps > nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < MenuItemProps > nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < MenuItemProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 : null | HTMLElement = null","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#props","text":"\u2022 Readonly props : Readonly < MenuItemProps > & Readonly <{ children? : ReactNode }>","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 <{}>","title":"state"},{"location":"extensions/api/classes/Renderer.Component.MenuItem/#contexttype","text":"\u25aa Static contextType : Context < null | Menu > = MenuContext","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 - 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 - 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 - 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 - 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 - 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 - 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.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 < Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>>> Methods # add # \u25b8 add ( rawNotification ): () => void Parameters # Name Type rawNotification Notification Returns # fn \u25b8 (): void Returns # void addAutoHideTimer # \u25b8 addAutoHideTimer ( id ): void Parameters # Name Type id NotificationId Returns # void getById # \u25b8 getById ( id ): undefined | Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>> Parameters # Name Type id NotificationId Returns # undefined | Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>> 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 < Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>>>","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 ( rawNotification ): () => 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 ): undefined | Simplify < Except < Notification , \"id\" > & Required < Pick < Notification , \"id\" >>>","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 <{ children? : ReactNode }> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < SettingLayoutProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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.PodDetailsList/","text":"Class: PodDetailsList # Renderer . Component .PodDetailsList Hierarchy # Component < PodDetailsListProps > \u21b3 PodDetailsList 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 getTableRow render renderCpuUsage renderMemoryUsage setState shouldComponentUpdate Constructors # constructor # \u2022 new PodDetailsList ( props ) Parameters # Name Type props PodDetailsListProps 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 < PodDetailsListProps > & Readonly <{ children? : ReactNode }> 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 <{}> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < PodDetailsListProps > 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < PodDetailsListProps > nextState Readonly <{}> 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 < PodDetailsListProps > prevState Readonly <{}> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < PodDetailsListProps > 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < PodDetailsListProps > nextState Readonly <{}> 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 < PodDetailsListProps > prevState Readonly <{}> Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate getTableRow # \u25b8 getTableRow ( uid ): undefined | Element Parameters # Name Type uid string Returns # undefined | Element render # \u25b8 render (): null | Element Returns # null | 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < PodDetailsListProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 < PodDetailsListProps > nextState Readonly <{}> 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 < PodDetailsListProps > \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","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 < PodDetailsListProps > & Readonly <{ children? : ReactNode }>","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 <{}>","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/#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 - 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 - 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 - 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 - 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 - 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 - 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 ): undefined | Element","title":"getTableRow"},{"location":"extensions/api/classes/Renderer.Component.PodDetailsList/#render","text":"\u25b8 render (): null | 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.SearchInput/","text":"Class: SearchInput # Renderer . Component .SearchInput Hierarchy # Component < SearchInputProps > \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 SearchInputProps 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 < SearchInputProps > & Readonly <{ children? : ReactNode }> 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 <{}> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SearchInputProps > 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SearchInputProps > nextState Readonly <{}> 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 < SearchInputProps > prevState Readonly <{}> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SearchInputProps > 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SearchInputProps > nextState Readonly <{}> 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 < SearchInputProps > prevState Readonly <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < SearchInputProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 < SearchInputProps > nextState Readonly <{}> 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 < SearchInputProps > \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 < SearchInputProps > & Readonly <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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.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 <{ children? : ReactNode }> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SettingLayoutProps > nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < SettingLayoutProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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 <{ children? : ReactNode }> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SliderProps > nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SliderProps > nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < SliderProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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 , {}> \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 <{ children? : ReactNode }> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SpinnerProps > nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SpinnerProps > nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < SpinnerProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 , {}> \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 <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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.Stepper/","text":"Class: Stepper # Renderer . Component .Stepper Hierarchy # Component < StepperProps , {}> \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 <{ children? : ReactNode }> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StepperProps > nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < StepperProps > nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < StepperProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 , {}> \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 <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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 < SubTitleProps > \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 SubTitleProps | Readonly < SubTitleProps > Inherited from # React.Component.constructor \u2022 new SubTitle ( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Parameters # Name Type props SubTitleProps 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 < SubTitleProps > & Readonly <{ children? : ReactNode }> 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 <{}> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SubTitleProps > 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SubTitleProps > nextState Readonly <{}> 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 < SubTitleProps > prevState Readonly <{}> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SubTitleProps > 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < SubTitleProps > nextState Readonly <{}> 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 < SubTitleProps > prevState Readonly <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < SubTitleProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 < SubTitleProps > nextState Readonly <{}> 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 < SubTitleProps > \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 < SubTitleProps > & Readonly <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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 > Overrides # React.PureComponent.constructor Properties # context # \u2022 context : TabsContextValue < any > Overrides # React.PureComponent.context props # \u2022 Readonly props : Readonly < TabProps < any >> & Readonly <{ children? : ReactNode }> 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 <{}> Inherited from # React.PureComponent.state contextType # \u25aa Static contextType : Context < TabsContextValue < any >> = TabsContext 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabProps < any >> nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabProps < any >> nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < TabProps < any >>) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 <{ children? : ReactNode }>","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 <{}>","title":"state"},{"location":"extensions/api/classes/Renderer.Component.Tab/#contexttype","text":"\u25aa Static contextType : Context < TabsContextValue < any >> = TabsContext","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 - 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 - 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 - 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 - 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 - 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 - 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.TableCell/","text":"Class: TableCell # Renderer . Component .TableCell Hierarchy # Component < TableCellProps > \u21b3 TableCell 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 onClick render renderCheckbox renderSortIcon setState shouldComponentUpdate Constructors # constructor # \u2022 new TableCell ( props ) Parameters # Name Type props TableCellProps 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 < TableCellProps > & Readonly <{ children? : ReactNode }> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableCellProps > nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableCellProps > nextState Readonly <{}> 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 <{}> 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 (): null | Element Returns # null | Element renderSortIcon # \u25b8 renderSortIcon (): null | Element Returns # null | Element setState # \u25b8 setState < K >( state , callback? ): void Type parameters # Name Type K extends never Parameters # Name Type state null | {} | ( prevState : Readonly <{}>, props : Readonly < TableCellProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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/#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 <{ children? : ReactNode }>","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 <{}>","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/#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 - 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 - 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 - 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 - 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 - 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 - 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 (): null | Element","title":"renderCheckbox"},{"location":"extensions/api/classes/Renderer.Component.TableCell/#rendersorticon","text":"\u25b8 renderSortIcon (): null | 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 <{ children? : ReactNode }> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableHeadProps > nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableHeadProps > nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < TableHeadProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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 Type parameters # Name Item Hierarchy # Component < TableRowProps < Item >> \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 < Item >( props ) Type parameters # Name Item Parameters # Name Type props TableRowProps < Item > | Readonly < TableRowProps < Item >> Inherited from # React.Component>.constructor \u2022 new TableRow < Item >( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Type parameters # Name Item Parameters # Name Type props TableRowProps < Item > 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 < Item >> & Readonly <{ children? : ReactNode }> 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 <{}> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableRowProps < 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableRowProps < Item >> nextState Readonly <{}> 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 < Item >> prevState Readonly <{}> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableRowProps < 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TableRowProps < Item >> nextState Readonly <{}> 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 < Item >> prevState Readonly <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < TableRowProps < Item >>) => null | {} | Pick <{}, K > | Pick <{}, 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 < Item >> nextState Readonly <{}> nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: TableRow"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#class-tablerowitem","text":"Renderer . Component .TableRow","title":"Class: TableRow<Item>"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#type-parameters","text":"Name Item","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.TableRow/#hierarchy","text":"Component < TableRowProps < Item >> \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 < Item >( 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 < Item >> & Readonly <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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 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 : null | HTMLDivElement = null props # \u2022 Readonly props : Readonly < TabsProps < any >> & Readonly <{ children? : ReactNode }> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabsProps < any >> nextState Readonly <{}> 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 < TabsProps < any >> prevState Readonly <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TabsProps < any >> nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < TabsProps < any >>) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 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 : null | HTMLDivElement = null","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Tabs/#props","text":"\u2022 Readonly props : Readonly < TabsProps < any >> & Readonly <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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/#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 - 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 - 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 - 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 Table of contents # Constructors # constructor Methods # createInstance getInstance resetInstance Constructors # constructor # \u2022 new TerminalStore () Methods # createInstance # \u25b8 Static createInstance (): TerminalStore & { sendCommand : ( command : string , options : SendCommandOptions ) => Promise < void > } Returns # TerminalStore & { sendCommand : ( command : string , options : SendCommandOptions ) => Promise < void > } getInstance # \u25b8 Static getInstance (): TerminalStore & { sendCommand : ( command : string , options : SendCommandOptions ) => Promise < void > } Returns # TerminalStore & { sendCommand : ( command : string , options : SendCommandOptions ) => Promise < void > } resetInstance # \u25b8 Static resetInstance (): void Returns # void","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/#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/#methods","text":"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/#methods_1","text":"","title":"Methods"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#createinstance","text":"\u25b8 Static createInstance (): TerminalStore & { sendCommand : ( command : string , options : SendCommandOptions ) => Promise < void > }","title":"createInstance"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#getinstance","text":"\u25b8 Static getInstance (): TerminalStore & { sendCommand : ( command : string , options : SendCommandOptions ) => Promise < void > }","title":"getInstance"},{"location":"extensions/api/classes/Renderer.Component.TerminalStore/#resetinstance","text":"\u25b8 Static resetInstance (): void","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 isContentVisible isVisible props refs state contextType defaultProps Accessors # hoverTarget targetElem Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate 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 Optional 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 : null | HTMLDivElement = null isContentVisible # \u2022 isContentVisible : boolean = false isVisible # \u2022 isVisible : boolean = false props # \u2022 Readonly props : Readonly < TooltipProps > & Readonly <{ children? : ReactNode }> 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 <{}> 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 (): null | HTMLElement Returns # null | HTMLElement targetElem # \u2022 get targetElem (): null | HTMLElement Returns # null | 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TooltipProps > nextState Readonly <{}> 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 componentDidUpdate (): void 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < TooltipProps > nextState Readonly <{}> 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 <{}> 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 (): null | Element Returns # null | Element Overrides # React.Component.render setPosition # \u25b8 Protected setPosition ( elem , pos ): void Parameters # Name Type elem HTMLDivElement 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < TooltipProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 isContentVisible 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 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 Optional 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 : null | HTMLDivElement = null","title":"elem"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#iscontentvisible","text":"\u2022 isContentVisible : boolean = false","title":"isContentVisible"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#isvisible","text":"\u2022 isVisible : boolean = false","title":"isVisible"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#props","text":"\u2022 Readonly props : Readonly < TooltipProps > & Readonly <{ children? : ReactNode }>","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 <{}>","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 (): null | HTMLElement","title":"hoverTarget"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#targetelem","text":"\u2022 get targetElem (): null | 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 - 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 - 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 - 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/#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 componentDidUpdate (): void","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 - 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 - 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 - 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 (): null | Element","title":"render"},{"location":"extensions/api/classes/Renderer.Component.Tooltip/#setposition","text":"\u25b8 Protected setPosition ( elem , 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 Type parameters # Name D Hierarchy # Component < WizardProps < D >, 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 < D >( props ) Type parameters # Name D Parameters # Name Type props WizardProps < D > | Readonly < WizardProps < D >> Inherited from # React.Component, State>.constructor \u2022 new Wizard < D >( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Type parameters # Name D Parameters # Name Type props WizardProps < D > context any Inherited from # React.Component, State>.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 < D >> & Readonly <{ children? : ReactNode }> 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 < D >, string | JSXElementConstructor < any >>[] Returns # ReactElement < WizardStepProps < D >, 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardProps < D >> 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardProps < D >> 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 < D >> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardProps < D >> 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardProps < D >> 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 < D >> 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 null | State | ( prevState : Readonly < State >, props : Readonly < WizardProps < D >>) => null | 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 < D >> nextState Readonly < State > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: Wizard"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#class-wizardd","text":"Renderer . Component .Wizard","title":"Class: Wizard<D>"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.Wizard/#hierarchy","text":"Component < WizardProps < D >, 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 < D >( 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 < D >> & Readonly <{ children? : ReactNode }>","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 < D >, 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 - 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 - 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 - 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 - 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 - 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 - 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 <{ children? : ReactNode }> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardLayoutProps > nextState Readonly <{}> 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 <{}> 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 - 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardLayoutProps > nextState Readonly <{}> 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 <{}> 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 null | {} | ( prevState : Readonly <{}>, props : Readonly < WizardLayoutProps >) => null | {} | Pick <{}, K > | Pick <{}, 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 <{}> 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 <{ children? : ReactNode }>","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 <{}>","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 - 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 - 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 - 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 - 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 - 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 - 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 Type parameters # Name D Hierarchy # Component < WizardStepProps < D >, WizardStepState > \u21b3 WizardStep Table of contents # Constructors # constructor Properties # context props refs state submit contextType defaultProps Methods # UNSAFE_componentWillMount UNSAFE_componentWillReceiveProps UNSAFE_componentWillUpdate componentDidCatch componentDidMount componentDidUpdate componentWillMount componentWillReceiveProps componentWillUnmount componentWillUpdate forceUpdate getSnapshotBeforeUpdate keyDown next prev render renderLoading setState shouldComponentUpdate Constructors # constructor # \u2022 new WizardStep < D >( props ) Type parameters # Name D Parameters # Name Type props WizardStepProps < D > | Readonly < WizardStepProps < D >> Inherited from # React.Component, WizardStepState>.constructor \u2022 new WizardStep < D >( props , context ) deprecated see https://reactjs.org/docs/legacy-context.html Type parameters # Name D Parameters # Name Type props WizardStepProps < D > context any Inherited from # React.Component, WizardStepState>.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 < D >> & Readonly <{ children? : ReactNode }> 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 submit # \u2022 submit : DebouncedFunc <() => void > 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardStepProps < D >> 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardStepProps < D >> 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 < D >> 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 - 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardStepProps < D >> 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 - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path Parameters # Name Type nextProps Readonly < WizardStepProps < D >> 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 < D >> prevState Readonly < WizardStepState > Returns # any Inherited from # React.Component.getSnapshotBeforeUpdate keyDown # \u25b8 keyDown ( evt ): void Parameters # Name Type evt KeyboardEvent < HTMLElement > Returns # void next # \u25b8 next (): void Returns # void prev # \u25b8 prev (): void Returns # void render # \u25b8 render (): null | Element Returns # null | 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 null | WizardStepState | ( prevState : Readonly < WizardStepState >, props : Readonly < WizardStepProps < D >>) => null | 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 < D >> nextState Readonly < WizardStepState > nextContext any Returns # boolean Inherited from # React.Component.shouldComponentUpdate","title":"Class: WizardStep"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#class-wizardstepd","text":"Renderer . Component .WizardStep","title":"Class: WizardStep<D>"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#type-parameters","text":"Name D","title":"Type parameters"},{"location":"extensions/api/classes/Renderer.Component.WizardStep/#hierarchy","text":"Component < WizardStepProps < D >, 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 submit 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 keyDown next prev render renderLoading setState shouldComponentUpdate","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 < D >( 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 < D >> & Readonly <{ children? : ReactNode }>","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/#submit","text":"\u2022 submit : DebouncedFunc <() => void >","title":"submit"},{"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 - 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 - 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 - 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 - 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 - 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 - 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/#keydown","text":"\u25b8 keyDown ( evt ): void","title":"keyDown"},{"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 (): null | 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.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@80377 extension # \u2022 Protected extension : LensExtension < LensExtensionDependencies > 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 >( this , ... 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 this StaticThis < T , R > Implicit argument that is the child class type ...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 >( this , 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 this StaticThis < T , R > Implicit argument that is the child class type strict? true 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 \u25b8 Static getInstance < T , R >( this , strict ): undefined | T Type parameters # Name Type T T R extends any [] Parameters # Name Type this StaticThis < T , R > strict false Returns # undefined | T 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 < LensExtensionDependencies >","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 >( this , ... 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 >( this , 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 , KubeApi < 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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems 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 < KubeObjectScope >, unknown , unknown , K > Parameters # Name Type api KubeApi < K , KubeJsonApiDataFor < K >> Overrides # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : KubeApi < K , KubeJsonApiDataFor < K >> Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiDataFor < K > extends KubeJsonApiDataFor < K > ? KubeJsonApiDataFor < K > : never >> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialDeep < K > Returns # Promise < K > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | K > Parameters # Name Type params Object params.name string params.namespace? string data? PartialDeep < K > Returns # Promise < null | 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 ): undefined | K Parameters # Name Type id string Returns # undefined | K Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): K [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # K [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | K Parameters # Name Type name string namespace? string Returns # undefined | K Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | K Parameters # Name Type path string Returns # undefined | 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 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 ( __namedParameters? ): Promise < undefined | K []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | K > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | K > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < K []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < K []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): K [] Parameters # Name Type partialItems K [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): K [] Parameters # Name Type items K [] Returns # K [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | K []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items K [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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? \"asc\" | \"desc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # K [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialDeep < 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 , KubeApi < 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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems 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 Readonly api : KubeApi < K , KubeJsonApiDataFor < K >>","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiDataFor < K > extends KubeJsonApiDataFor < K > ? KubeJsonApiDataFor < K > : never >>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | K","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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/#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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): K []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDResourceStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 , CustomResourceDefinitionApi > \u21b3 CRDStore Table of contents # Constructors # constructor Properties # api bufferSize dependencies 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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CRDStore ( dependencies , api , opts? ) Parameters # Name Type dependencies CustomResourceDefinitionStoreDependencies api CustomResourceDefinitionApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : CustomResourceDefinitionApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize dependencies # \u2022 Protected Readonly dependencies : CustomResourceDefinitionStoreDependencies eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec >>> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady groups # \u2022 get groups (): Record < string , CustomResourceDefinition []> Returns # Record < string , CustomResourceDefinition []> namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < CustomResourceDefinition > Returns # Promise < CustomResourceDefinition > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CustomResourceDefinition > Returns # Promise < null | 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 ): undefined | CustomResourceDefinition Parameters # Name Type group string pluralName string Returns # undefined | CustomResourceDefinition getById # \u25b8 getById ( id ): undefined | CustomResourceDefinition Parameters # Name Type id string Returns # undefined | CustomResourceDefinition Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): CustomResourceDefinition [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | CustomResourceDefinition Parameters # Name Type name string namespace? string Returns # undefined | CustomResourceDefinition Inherited from # KubeObjectStore . getByName getByObject # \u25b8 getByObject ( obj ): undefined | null | CustomResourceDefinition Parameters # Name Type obj KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # undefined | null | CustomResourceDefinition getByPath # \u25b8 getByPath ( path ): undefined | CustomResourceDefinition Parameters # Name Type path string Returns # undefined | 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 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 ( __namedParameters? ): Promise < undefined | CustomResourceDefinition []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | CustomResourceDefinition > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | CustomResourceDefinition > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < CustomResourceDefinition []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < CustomResourceDefinition []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): CustomResourceDefinition [] Parameters # Name Type partialItems CustomResourceDefinition [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): CustomResourceDefinition [] Parameters # Name Type items CustomResourceDefinition [] Returns # CustomResourceDefinition [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | CustomResourceDefinition []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items CustomResourceDefinition [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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 Description items CustomResourceDefinition [] the items to be sorted (default: the current items in this store) Returns # CustomResourceDefinition [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , CustomResourceDefinitionApi > \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 dependencies 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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems 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 ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#api","text":"\u2022 Readonly api : CustomResourceDefinitionApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#dependencies","text":"\u2022 Protected Readonly dependencies : CustomResourceDefinitionStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec >>>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | CustomResourceDefinition","title":"getByGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyid","text":"\u25b8 getById ( id ): undefined | 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? ): undefined | CustomResourceDefinition","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbyobject","text":"\u25b8 getByObject ( obj ): undefined | null | CustomResourceDefinition","title":"getByObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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/#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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): CustomResourceDefinition []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CRDStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 < ClusterScopedMetadata , void , void > \u21b3 ClusterRole Table of contents # Constructors # constructor Properties # aggregationRule apiVersion kind metadata rules spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRole ( __namedParameters ) Parameters # Name Type __namedParameters ClusterRoleData Overrides # KubeObject . constructor Properties # aggregationRule # \u2022 Optional aggregationRule : AggregationRule apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata rules # \u2022 Optional rules : PolicyRule [] spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterroles\" Overrides # KubeObject . apiBase kind # \u25aa Static kind : string = \"ClusterRole\" Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp 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 (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getRules # \u25b8 getRules (): PolicyRule [] Returns # PolicyRule [] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < ClusterRole > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> 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 < ClusterScopedMetadata , void , void > \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":"aggregationRule apiVersion kind 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 getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getRules getScopedName 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 ( __namedParameters )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#aggregationrule","text":"\u2022 Optional aggregationRule : AggregationRule","title":"aggregationRule"},{"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/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#rules","text":"\u2022 Optional rules : PolicyRule []","title":"rules"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#status","text":"\u2022 Optional status : void","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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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 (): undefined","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; 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 (): PolicyRule []","title":"getRules"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | string )[]","title":"getSearchFields"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRole/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 < ClusterScopedMetadata , void , void > \u21b3 ClusterRoleBinding Table of contents # Constructors # constructor Properties # apiVersion kind metadata roleRef spec status subjects apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSubjectNames getSubjects getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ClusterRoleBinding ( __namedParameters ) Parameters # Name Type __namedParameters ClusterRoleBindingData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata roleRef # \u2022 roleRef : RoleRef spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status subjects # \u2022 Optional subjects : Subject [] apiBase # \u25aa Static apiBase : string = \"/apis/rbac.authorization.k8s.io/v1/clusterrolebindings\" Overrides # KubeObject . apiBase kind # \u25aa Static kind : string = \"ClusterRoleBinding\" Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp 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 (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getSubjectNames # \u25b8 getSubjectNames (): string Returns # string getSubjects # \u25b8 getSubjects (): Subject [] Returns # Subject [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < ClusterRoleBinding > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> 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 < ClusterScopedMetadata , void , void > \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 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 getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName 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 ( __namedParameters )","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/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#roleref","text":"\u2022 roleRef : RoleRef","title":"roleRef"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#subjects","text":"\u2022 Optional subjects : Subject []","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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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 (): undefined","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; 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/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | 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 (): Subject []","title":"getSubjects"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ClusterRoleBinding/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 < NamespaceScopedMetadata , void , void > \u21b3 ConfigMap Table of contents # Constructors # constructor Properties # apiVersion binaryData data immutable kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new ConfigMap ( __namedParameters ) Parameters # Name Type __namedParameters ConfigMapData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion binaryData # \u2022 binaryData : Partial < Record < string , string >> data # \u2022 data : Partial < Record < string , string >> immutable # \u2022 Optional immutable : boolean kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/api/v1/configmaps\" Overrides # KubeObject . apiBase kind # \u25aa Static kind : string = \"ConfigMap\" Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp 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 getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < ConfigMap > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> 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 < NamespaceScopedMetadata , void , void > \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 binaryData data immutable kind 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 getCreationTimestamp getFinalizers getId getKeys getLabels getName getNs getOwnerRefs getResourceVersion getScopedName 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 ( __namedParameters )","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/#binarydata","text":"\u2022 binaryData : Partial < Record < string , string >>","title":"binaryData"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#data","text":"\u2022 data : Partial < Record < string , string >>","title":"data"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#immutable","text":"\u2022 Optional immutable : boolean","title":"immutable"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#kind","text":"\u2022 kind : string","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#status","text":"\u2022 Optional status : void","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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"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 deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMap/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 , ConfigMapApi , ConfigMapData > \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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new ConfigMapsStore ( api , opts? ) Parameters # Name Type api ConfigMapApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore . constructor \u2022 new ConfigMapsStore () deprecated Supply API instance through constructor Inherited from # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : ConfigMapApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < ConfigMapData >> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < ConfigMap > Returns # Promise < ConfigMap > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < ConfigMap > Returns # Promise < null | 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 ): undefined | ConfigMap Parameters # Name Type id string Returns # undefined | ConfigMap Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): ConfigMap [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # ConfigMap [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | ConfigMap Parameters # Name Type name string namespace? string Returns # undefined | ConfigMap Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | ConfigMap Parameters # Name Type path string Returns # undefined | 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 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 ( __namedParameters? ): Promise < undefined | ConfigMap []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | ConfigMap > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | ConfigMap > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < ConfigMap []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < ConfigMap []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): ConfigMap [] Parameters # Name Type partialItems ConfigMap [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): ConfigMap [] Parameters # Name Type items ConfigMap [] Returns # ConfigMap [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | ConfigMap []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items ConfigMap [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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? \"asc\" | \"desc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # ConfigMap [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , ConfigMapApi , ConfigMapData > \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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems 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 , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#api","text":"\u2022 Readonly api : ConfigMapApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < ConfigMapData >>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | ConfigMap","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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/#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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): ConfigMap []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.ConfigMapsStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 < NamespaceScopedMetadata , CronJobStatus , CronJobSpec > \u21b3 CronJob Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getScopedName 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 < NamespaceScopedMetadata , CronJobStatus , CronJobSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : CronJobSpec Inherited from # KubeObject . spec status # \u2022 Optional status : CronJobStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/batch/v1beta1/cronjobs\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"CronJob\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp 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 getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSuspendFlag # \u25b8 getSuspendFlag (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow isNeverRun # \u25b8 isNeverRun (): boolean Returns # boolean isSuspend # \u25b8 isSuspend (): undefined | boolean Returns # undefined | boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < CronJob > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> 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 < NamespaceScopedMetadata , CronJobStatus , CronJobSpec > \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 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 getCreationTimestamp getFinalizers getId getLabels getLastScheduleTime getName getNs getOwnerRefs getResourceVersion getSchedule getScopedName 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/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#spec","text":"\u2022 spec : CronJobSpec","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#status","text":"\u2022 Optional status : CronJobStatus","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/batch/v1beta1/cronjobs\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#kind_1","text":"\u25aa Static Readonly kind : \"CronJob\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#namespaced","text":"\u25aa Static Readonly namespaced : 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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"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 deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","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 (): undefined | boolean","title":"isSuspend"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJob/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 , CronJobApi > \u21b3 CronJobStore Table of contents # Constructors # constructor Properties # api bufferSize dependencies 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 pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new CronJobStore ( dependencies , api , opts? ) Parameters # Name Type dependencies Dependencies api CronJobApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : CronJobApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize dependencies # \u2022 Protected Readonly dependencies : Dependencies eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , CronJobStatus , CronJobSpec >>> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < CronJob > Returns # Promise < CronJob > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | CronJob > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < CronJob > Returns # Promise < null | 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 ): undefined | CronJob Parameters # Name Type id string Returns # undefined | CronJob Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): CronJob [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # CronJob [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | CronJob Parameters # Name Type name string namespace? string Returns # undefined | CronJob Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | CronJob Parameters # Name Type path string Returns # undefined | 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 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 ( __namedParameters? ): Promise < undefined | CronJob []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | CronJob > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | CronJob > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < CronJob []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < CronJob []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): CronJob [] Parameters # Name Type partialItems CronJob [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): CronJob [] Parameters # Name Type items CronJob [] Returns # CronJob [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | CronJob []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items CronJob [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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? \"asc\" | \"desc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # CronJob [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , CronJobApi > \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 dependencies 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 pickOnlySelected reloadAll remove removeItem removeItems 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 ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#api","text":"\u2022 Readonly api : CronJobApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , CronJobStatus , CronJobSpec >>>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | CronJob","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): CronJob []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.CronJobStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec > \u21b3 CustomResourceDefinition Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getConversion getCreationTimestamp getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getScopedName 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 KubeJsonApiData < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : ClusterScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : CustomResourceDefinitionSpec Inherited from # KubeObject . spec status # \u2022 Optional status : CustomResourceDefinitionStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/apiextensions.k8s.io/v1/customresourcedefinitions\" Overrides # KubeObject . apiBase kind # \u25aa Static kind : string = \"CustomResourceDefinition\" Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = false Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] getConversion # \u25b8 getConversion (): string Returns # string getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp 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 (): CustomResourceDefinitionNames Returns # CustomResourceDefinitionNames getNs # \u25b8 getNs (): undefined Returns # undefined Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getPluralName # \u25b8 getPluralName (): string Returns # string getPreferedVersion # \u25b8 getPreferedVersion (): CustomResourceDefinitionVersion Returns # CustomResourceDefinitionVersion 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 (): \"Cluster\" | \"Namespaced\" Returns # \"Cluster\" | \"Namespaced\" getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getStoredVersions # \u25b8 getStoredVersions (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. 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 < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < CustomResourceDefinition > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> 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 < ClusterScopedMetadata , CustomResourceDefinitionStatus , CustomResourceDefinitionSpec > \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 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 getCreationTimestamp getFinalizers getGroup getId getLabels getName getNames getNs getOwnerRefs getPluralName getPreferedVersion getPrinterColumns getResourceApiBase getResourceKind getResourceTitle getResourceUrl getResourceVersion getScope getScopedName 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/#metadata","text":"\u2022 metadata : ClusterScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#spec","text":"\u2022 spec : CustomResourceDefinitionSpec","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#status","text":"\u2022 Optional status : CustomResourceDefinitionStatus","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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","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 : \"True\" | \"False\" | \"Unknown\" ; 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/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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 (): CustomResourceDefinitionNames","title":"getNames"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getns","text":"\u25b8 getNs (): undefined","title":"getNs"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getownerrefs","text":"\u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined ; 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 (): CustomResourceDefinitionVersion","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 (): \"Cluster\" | \"Namespaced\"","title":"getScope"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | 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 deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","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 < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.CustomResourceDefinition/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 # KubeObject < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec > \u21b3 DaemonSet Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getScopedName 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 < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : DaemonSetSpec Inherited from # KubeObject . spec status # \u2022 Optional status : DaemonSetStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/apps/v1/daemonsets\" Overrides # KubeObject . apiBase kind # \u25aa Static kind : string = \"DaemonSet\" Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # 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 getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < DaemonSet > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . 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":"KubeObject < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec > \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 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 getCreationTimestamp getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getResourceVersion getScopedName 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/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#spec","text":"\u2022 spec : DaemonSetSpec","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#status","text":"\u2022 Optional status : DaemonSetStatus","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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","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 deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"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 deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSet/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 , DaemonSetApi > \u21b3 DaemonSetStore Table of contents # Constructors # constructor Properties # api bufferSize dependencies 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 pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DaemonSetStore ( dependencies , api , opts? ) Parameters # Name Type dependencies DaemonSetStoreDependencies api DaemonSetApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : DaemonSetApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize dependencies # \u2022 Protected Readonly dependencies : DaemonSetStoreDependencies eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec >>> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < DaemonSet > Returns # Promise < DaemonSet > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < DaemonSet > Returns # Promise < null | 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 ): undefined | DaemonSet Parameters # Name Type id string Returns # undefined | DaemonSet Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): DaemonSet [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # DaemonSet [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | DaemonSet Parameters # Name Type name string namespace? string Returns # undefined | DaemonSet Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | DaemonSet Parameters # Name Type path string Returns # undefined | 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 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 ( __namedParameters? ): Promise < undefined | DaemonSet []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | DaemonSet > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | DaemonSet > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < DaemonSet []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < DaemonSet []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): DaemonSet [] Parameters # Name Type partialItems DaemonSet [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): DaemonSet [] Parameters # Name Type items DaemonSet [] Returns # DaemonSet [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | DaemonSet []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items DaemonSet [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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? \"asc\" | \"desc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # DaemonSet [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , DaemonSetApi > \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 dependencies 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 pickOnlySelected reloadAll remove removeItem removeItems 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 ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#api","text":"\u2022 Readonly api : DaemonSetApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#dependencies","text":"\u2022 Protected Readonly dependencies : DaemonSetStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DaemonSetStatus , DaemonSetSpec >>>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | DaemonSet","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): DaemonSet []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DaemonSetStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 # KubeObject < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec > \u21b3 Deployment Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getConditions getConditionsText getCreationTimestamp getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName 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 < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : DeploymentSpec Inherited from # KubeObject . spec status # \u2022 Optional status : DeploymentStatus Inherited from # KubeObject . status apiBase # \u25aa Static apiBase : string = \"/apis/apps/v1/deployments\" Overrides # KubeObject . apiBase kind # \u25aa Static kind : string = \"Deployment\" Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 ( activeOnly? ): BaseKubeObjectCondition [] Parameters # Name Type Default value activeOnly boolean false Returns # BaseKubeObjectCondition [] getConditionsText # \u25b8 getConditionsText ( activeOnly? ): string Parameters # Name Type Default value activeOnly boolean true Returns # string getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp 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 getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # 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 getReplicas # \u25b8 getReplicas (): number Returns # number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < Deployment > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . 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":"KubeObject < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec > \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 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 getCreationTimestamp getFinalizers getId getLabels getName getNodeSelectors getNs getOwnerRefs getReplicas getResourceVersion getScopedName 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/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#spec","text":"\u2022 spec : DeploymentSpec","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#status","text":"\u2022 Optional status : DeploymentStatus","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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","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 deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","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? ): BaseKubeObjectCondition []","title":"getConditions"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getconditionstext","text":"\u25b8 getConditionsText ( activeOnly? ): string","title":"getConditionsText"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"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 deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.Deployment/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 doCheckPreferredVersion fallbackApiBases fullApiPathname isNamespaced kind objectConstructor request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getReplicas getResourceVersion getScaleApiUrl getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse patch refreshResourceVersion restart scale setResourceVersion update watch Constructors # constructor # \u2022 new DeploymentApi ( opts? ) Parameters # Name Type opts? DerivedKubeApiOptions Overrides # KubeApi . constructor Properties # apiBase # \u2022 apiBase : string Inherited from # KubeApi . apiBase apiGroup # \u2022 apiGroup : string Inherited from # KubeApi . apiGroup apiPrefix # \u2022 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 apiVersionPreferred : undefined | string Inherited from # KubeApi . apiVersionPreferred doCheckPreferredVersion # \u2022 Protected Readonly doCheckPreferredVersion : boolean Inherited from # KubeApi . doCheckPreferredVersion fallbackApiBases # \u2022 Protected Readonly fallbackApiBases : undefined | string [] Inherited from # KubeApi . fallbackApiBases fullApiPathname # \u2022 Protected Readonly fullApiPathname : string Inherited from # KubeApi . fullApiPathname isNamespaced # \u2022 Readonly isNamespaced : boolean Inherited from # KubeApi . isNamespaced kind # \u2022 Readonly kind : string Inherited from # KubeApi . kind objectConstructor # \u2022 Readonly objectConstructor : KubeObjectConstructor < Deployment , KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec >> Inherited from # KubeApi . objectConstructor request # \u2022 Protected Readonly request : KubeJsonApi Inherited from # KubeApi . request resourceVersions # \u2022 Protected Readonly resourceVersions : Map < string , string > Inherited from # KubeApi . resourceVersions watchDisposer # \u2022 Protected Readonly watchDisposer : undefined | Disposer Inherited from # KubeApi . watchDisposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Inherited from # KubeApi.apiVersionWithGroup Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise < void > Returns # Promise < void > Inherited from # KubeApi . checkPreferredVersion create # \u25b8 create ( __namedParameters , partialData? ): Promise < null | Deployment > Parameters # Name Type __namedParameters Partial < ResourceDescriptor > partialData? PartialObjectDeep < Deployment > Returns # Promise < null | Deployment > Inherited from # KubeApi . create delete # \u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Parameters # Name Type __namedParameters DeleteResourceDescriptor Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeApi . delete get # \u25b8 get ( desc , query? ): Promise < null | Deployment > Parameters # Name Type desc ResourceDescriptor query? KubeApiQueryParams Returns # Promise < null | 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? ): undefined | string Parameters # Name Type Default value namespace string \"\" Returns # undefined | 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 Partial < ResourceDescriptor > query? Partial < KubeApiQueryParams > Returns # string Inherited from # KubeApi . getUrl getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query KubeApiQueryParams {} Returns # string Inherited from # KubeApi . getWatchUrl list # \u25b8 list ( __namedParameters? , query? ): Promise < null | Deployment []> Parameters # Name Type __namedParameters KubeApiListOptions query? KubeApiQueryParams Returns # Promise < null | Deployment []> Inherited from # KubeApi . list modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent < KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >> Returns # void Inherited from # KubeApi . modifyWatchEvent normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial < KubeApiQueryParams > Parameters # Name Type query Partial < KubeApiQueryParams > Returns # Partial < KubeApiQueryParams > Inherited from # KubeApi . normalizeQuery parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): null | Deployment | Deployment [] Parameters # Name Type data unknown namespace? string Returns # null | Deployment | Deployment [] Inherited from # KubeApi . parseResponse patch # \u25b8 patch ( desc , data , strategy? ): Promise < null | Deployment > Parameters # Name Type Default value desc ResourceDescriptor undefined data Patch | PartialObjectDeep < Deployment > undefined strategy KubeApiPatchType \"strategic\" Returns # Promise < null | Deployment > Inherited from # KubeApi . patch refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < null | Deployment []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < null | Deployment []> Inherited from # KubeApi . refreshResourceVersion restart # \u25b8 restart ( params ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Parameters # Name Type params Object params.name string params.namespace string Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> scale # \u25b8 scale ( params , replicas ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Parameters # Name Type params Object params.name string params.namespace string replicas number Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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 < null | Deployment > Parameters # Name Type __namedParameters ResourceDescriptor data PartialObjectDeep < Deployment > Returns # Promise < null | Deployment > Inherited from # KubeApi . update watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions < Deployment , KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec >> 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 doCheckPreferredVersion fallbackApiBases fullApiPathname isNamespaced kind objectConstructor 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 patch 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 ( opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apibase","text":"\u2022 apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apigroup","text":"\u2022 apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#apiprefix","text":"\u2022 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 apiVersionPreferred : undefined | string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#docheckpreferredversion","text":"\u2022 Protected Readonly doCheckPreferredVersion : boolean","title":"doCheckPreferredVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#fallbackapibases","text":"\u2022 Protected Readonly fallbackApiBases : undefined | string []","title":"fallbackApiBases"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#fullapipathname","text":"\u2022 Protected Readonly fullApiPathname : string","title":"fullApiPathname"},{"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 Readonly objectConstructor : KubeObjectConstructor < Deployment , KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec >>","title":"objectConstructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#request","text":"\u2022 Protected Readonly request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#resourceversions","text":"\u2022 Protected Readonly resourceVersions : Map < string , string >","title":"resourceVersions"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#watchdisposer","text":"\u2022 Protected Readonly watchDisposer : undefined | Disposer","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 , partialData? ): Promise < null | Deployment >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >>","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#get","text":"\u25b8 get ( desc , query? ): Promise < null | 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? ): undefined | 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 < null | 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 < KubeApiQueryParams >","title":"normalizeQuery"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): null | Deployment | Deployment []","title":"parseResponse"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#patch","text":"\u25b8 patch ( desc , data , strategy? ): Promise < null | Deployment >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < null | Deployment []>","title":"refreshResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#restart","text":"\u25b8 restart ( params ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >>","title":"restart"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentApi/#scale","text":"\u25b8 scale ( params , replicas ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >>","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 < null | 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 , DeploymentApi > \u21b3 DeploymentStore Table of contents # Constructors # constructor Properties # api bufferSize dependencies 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 pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new DeploymentStore ( dependencies , api , opts? ) Parameters # Name Type dependencies DeploymentStoreDependencies api DeploymentApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : DeploymentApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize dependencies # \u2022 Protected Readonly dependencies : DeploymentStoreDependencies eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec >>> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < Deployment > Returns # Promise < Deployment > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Deployment > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Deployment > Returns # Promise < null | 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 ): undefined | Deployment Parameters # Name Type id string Returns # undefined | Deployment Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Deployment [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Deployment [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Deployment Parameters # Name Type name string namespace? string Returns # undefined | Deployment Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | Deployment Parameters # Name Type path string Returns # undefined | 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 ): DeploymentStatuses Parameters # Name Type deployments Deployment [] Returns # DeploymentStatuses \u25b8 getStatuses ( deployments ): DeploymentStatuses deprecated Parameters # Name Type deployments undefined | Deployment [] Returns # DeploymentStatuses 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 ( __namedParameters? ): Promise < undefined | Deployment []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | Deployment > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Deployment > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Deployment []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < Deployment []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): Deployment [] Parameters # Name Type partialItems Deployment [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): Deployment [] Parameters # Name Type items Deployment [] Returns # Deployment [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Deployment []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Deployment [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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 Description items Deployment [] the items to be sorted (default: the current items in this store) Returns # Deployment [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , DeploymentApi > \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 dependencies 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 pickOnlySelected reloadAll remove removeItem removeItems 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 ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#api","text":"\u2022 Readonly api : DeploymentApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#dependencies","text":"\u2022 Protected Readonly dependencies : DeploymentStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , DeploymentStatus , DeploymentSpec >>>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | Deployment","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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 ): DeploymentStatuses","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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Deployment []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.DeploymentStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 < NamespaceScopedMetadata , void , void > \u21b3 Endpoint Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status subsets apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getTimeDiffFromNow patch toPlainObject toString update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new Endpoint ( __namedParameters ) Parameters # Name Type __namedParameters EndpointsData Overrides # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : void Inherited from # KubeObject . spec status # \u2022 Optional status : void Inherited from # KubeObject . status subsets # \u2022 Optional subsets : EndpointSubset [] apiBase # \u25aa Static apiBase : string = \"/api/v1/endpoints\" Overrides # KubeObject . apiBase kind # \u25aa Static kind : string = \"Endpoints\" Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getEndpointSubsets # \u25b8 getEndpointSubsets (): Required < EndpointSubset >[] Returns # Required < 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 getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject toString # \u25b8 toString (): string Returns # string update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < Endpoint > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> 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 < NamespaceScopedMetadata , void , void > \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 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 getCreationTimestamp getEndpointSubsets getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName 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 ( __namedParameters )","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/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#spec","text":"\u2022 spec : void","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#status","text":"\u2022 Optional status : void","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#subsets","text":"\u2022 Optional subsets : EndpointSubset []","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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#getendpointsubsets","text":"\u25b8 getEndpointSubsets (): Required < 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/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"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 deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","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 < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.Endpoint/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 , EndpointsApi , EndpointsData > \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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EndpointStore ( api , opts? ) Parameters # Name Type api EndpointsApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore . constructor \u2022 new EndpointStore () deprecated Supply API instance through constructor Inherited from # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : EndpointsApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < EndpointsData >> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < Endpoint > Returns # Promise < Endpoint > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Endpoint > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Endpoint > Returns # Promise < null | 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 ): undefined | Endpoint Parameters # Name Type id string Returns # undefined | Endpoint Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Endpoint [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Endpoint [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Endpoint Parameters # Name Type name string namespace? string Returns # undefined | Endpoint Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | Endpoint Parameters # Name Type path string Returns # undefined | 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 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 ( __namedParameters? ): Promise < undefined | Endpoint []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | Endpoint > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Endpoint > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Endpoint []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < Endpoint []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): Endpoint [] Parameters # Name Type partialItems Endpoint [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): Endpoint [] Parameters # Name Type items Endpoint [] Returns # Endpoint [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Endpoint []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Endpoint [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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? \"asc\" | \"desc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Endpoint [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , EndpointsApi , EndpointsData > \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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems 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 , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#api","text":"\u2022 Readonly api : EndpointsApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < EndpointsData >>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | Endpoint","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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/#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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Endpoint []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EndpointStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 , KubeEventApi > \u21b3 EventStore Table of contents # Constructors # constructor Properties # api bufferSize dependencies 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 getEventsByObject getIndexById getItems getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new EventStore ( dependencies , api , opts? ) Parameters # Name Type dependencies EventStoreDependencies api KubeEventApi opts KubeObjectStoreOptions Overrides # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : KubeEventApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize dependencies # \u2022 Protected Readonly dependencies : EventStoreDependencies eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeEventData >> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < KubeEvent > Returns # Promise < KubeEvent > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < KubeEvent > Returns # Promise < null | 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 ): undefined | KubeEvent Parameters # Name Type id string Returns # undefined | KubeEvent Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): KubeEvent [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # KubeEvent [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | KubeEvent Parameters # Name Type name string namespace? string Returns # undefined | KubeEvent Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | KubeEvent Parameters # Name Type path string Returns # undefined | KubeEvent Inherited from # KubeObjectStore . getByPath getEventsByObject # \u25b8 getEventsByObject ( obj ): KubeEvent [] Parameters # Name Type obj KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > 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 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 ( __namedParameters? ): Promise < undefined | KubeEvent []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | KubeEvent > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | KubeEvent > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < KubeEvent []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < KubeEvent []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): KubeEvent [] Parameters # Name Type partialItems KubeEvent [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): KubeEvent [] Parameters # Name Type items KubeEvent [] Returns # KubeEvent [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | KubeEvent []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items KubeEvent [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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 Description items KubeEvent [] the items to be sorted (default: the current items in this store) Returns # KubeEvent [] Overrides # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , KubeEventApi > \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 dependencies eventsBuffer failedLoading isLoaded isLoading items limit 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 getTotalCount getWarnings getWarningsCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems 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 ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#api","text":"\u2022 Readonly api : KubeEventApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#dependencies","text":"\u2022 Protected Readonly dependencies : EventStoreDependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeEventData >>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | KubeEvent","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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/#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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): KubeEvent []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.EventStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 , HorizontalPodAutoscalerApi > \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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new HPAStore ( api , opts? ) Parameters # Name Type api HorizontalPodAutoscalerApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore . constructor \u2022 new HPAStore () deprecated Supply API instance through constructor Inherited from # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : HorizontalPodAutoscalerApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec >>> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < HorizontalPodAutoscaler > Returns # Promise < HorizontalPodAutoscaler > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < HorizontalPodAutoscaler > Returns # Promise < null | 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 ): undefined | HorizontalPodAutoscaler Parameters # Name Type id string Returns # undefined | HorizontalPodAutoscaler Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): HorizontalPodAutoscaler [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | HorizontalPodAutoscaler Parameters # Name Type name string namespace? string Returns # undefined | HorizontalPodAutoscaler Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | HorizontalPodAutoscaler Parameters # Name Type path string Returns # undefined | 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 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 ( __namedParameters? ): Promise < undefined | HorizontalPodAutoscaler []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | HorizontalPodAutoscaler > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | HorizontalPodAutoscaler > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < HorizontalPodAutoscaler []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < HorizontalPodAutoscaler []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): HorizontalPodAutoscaler [] Parameters # Name Type partialItems HorizontalPodAutoscaler [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): HorizontalPodAutoscaler [] Parameters # Name Type items HorizontalPodAutoscaler [] Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | HorizontalPodAutoscaler []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items HorizontalPodAutoscaler [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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? \"asc\" | \"desc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # HorizontalPodAutoscaler [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , HorizontalPodAutoscalerApi > \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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems 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 , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#api","text":"\u2022 Readonly api : HorizontalPodAutoscalerApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec >>>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | HorizontalPodAutoscaler","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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/#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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): HorizontalPodAutoscaler []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.HPAStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec > \u21b3 HorizontalPodAutoscaler Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getConditions getContainerResourceMetricValue getCreationTimestamp getCurrentMetrics getExternalMetricValue getFinalizers getId getLabels getMaxPods getMetricCurrentTarget getMetricName getMetricValues getMetrics getMinPods getName getNs getObjectMetricValue getOwnerRefs getPodsMetricValue getReadyConditions getReplicas getResourceMetricValue getResourceVersion getScopedName 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 < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : HorizontalPodAutoscalerSpec Inherited from # KubeObject . spec status # \u2022 Optional status : HorizontalPodAutoscalerStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/autoscaling/v2beta1/horizontalpodautoscalers\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"HorizontalPodAutoscaler\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] getContainerResourceMetricValue # \u25b8 Protected getContainerResourceMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget Parameters # Name Type currentMetric undefined | ContainerResourceMetricSource targetMetric ContainerResourceMetricSource Returns # MetricCurrentTarget getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getCurrentMetrics # \u25b8 getCurrentMetrics (): HorizontalPodAutoscalerMetricSpec [] Returns # HorizontalPodAutoscalerMetricSpec [] getExternalMetricValue # \u25b8 Protected getExternalMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget Parameters # Name Type currentMetric undefined | ExternalMetricSource targetMetric ExternalMetricSource Returns # MetricCurrentTarget 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 getMetricCurrentTarget # \u25b8 Protected getMetricCurrentTarget ( metric ): MetricCurrentTarget Parameters # Name Type metric HorizontalPodAutoscalerMetricSpec Returns # MetricCurrentTarget getMetricName # \u25b8 Protected getMetricName ( metric ): string Parameters # Name Type metric HorizontalPodAutoscalerMetricSpec Returns # string getMetricValues # \u25b8 getMetricValues ( metric ): string Parameters # Name Type metric HorizontalPodAutoscalerMetricSpec Returns # string getMetrics # \u25b8 getMetrics (): HorizontalPodAutoscalerMetricSpec [] Returns # HorizontalPodAutoscalerMetricSpec [] 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 getObjectMetricValue # \u25b8 Protected getObjectMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget Parameters # Name Type currentMetric undefined | ObjectMetricSource targetMetric ObjectMetricSource Returns # MetricCurrentTarget 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 getPodsMetricValue # \u25b8 Protected getPodsMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget Parameters # Name Type currentMetric undefined | PodsMetricSource targetMetric PodsMetricSource Returns # MetricCurrentTarget getReadyConditions # \u25b8 getReadyConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] Returns # { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[] getReplicas # \u25b8 getReplicas (): number Returns # number getResourceMetricValue # \u25b8 Protected getResourceMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget Parameters # Name Type currentMetric undefined | ResourceMetricSource targetMetric ResourceMetricSource Returns # MetricCurrentTarget getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < HorizontalPodAutoscaler > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> 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 < NamespaceScopedMetadata , HorizontalPodAutoscalerStatus , HorizontalPodAutoscalerSpec > \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 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 getContainerResourceMetricValue getCreationTimestamp getCurrentMetrics getExternalMetricValue getFinalizers getId getLabels getMaxPods getMetricCurrentTarget getMetricName getMetricValues getMetrics getMinPods getName getNs getObjectMetricValue getOwnerRefs getPodsMetricValue getReadyConditions getReplicas getResourceMetricValue getResourceVersion getScopedName 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/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#spec","text":"\u2022 spec : HorizontalPodAutoscalerSpec","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#status","text":"\u2022 Optional status : HorizontalPodAutoscalerStatus","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/autoscaling/v2beta1/horizontalpodautoscalers\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#kind_1","text":"\u25aa Static Readonly kind : \"HorizontalPodAutoscaler\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#namespaced","text":"\u25aa Static Readonly namespaced : 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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","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 : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[]","title":"getConditions"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getcontainerresourcemetricvalue","text":"\u25b8 Protected getContainerResourceMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget","title":"getContainerResourceMetricValue"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getcurrentmetrics","text":"\u25b8 getCurrentMetrics (): HorizontalPodAutoscalerMetricSpec []","title":"getCurrentMetrics"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getexternalmetricvalue","text":"\u25b8 Protected getExternalMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget","title":"getExternalMetricValue"},{"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/#getmetriccurrenttarget","text":"\u25b8 Protected getMetricCurrentTarget ( metric ): MetricCurrentTarget","title":"getMetricCurrentTarget"},{"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 (): HorizontalPodAutoscalerMetricSpec []","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/#getobjectmetricvalue","text":"\u25b8 Protected getObjectMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget","title":"getObjectMetricValue"},{"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/#getpodsmetricvalue","text":"\u25b8 Protected getPodsMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget","title":"getPodsMetricValue"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getreadyconditions","text":"\u25b8 getReadyConditions (): { isReady : boolean ; lastTransitionTime? : string ; message? : string ; reason? : string ; status : \"True\" | \"False\" | \"Unknown\" ; tooltip : string ; type : string }[]","title":"getReadyConditions"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getreplicas","text":"\u25b8 getReplicas (): number","title":"getReplicas"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getresourcemetricvalue","text":"\u25b8 Protected getResourceMetricValue ( currentMetric , targetMetric ): MetricCurrentTarget","title":"getResourceMetricValue"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"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 deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.HorizontalPodAutoscaler/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 < NamespaceScopedMetadata , IngressStatus , IngressSpec > \u21b3 Ingress Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getRules getScopedName 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 < NamespaceScopedMetadata , IngressStatus , IngressSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : IngressSpec Inherited from # KubeObject . spec status # \u2022 Optional status : IngressStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/ingresses\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Ingress\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp 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 (): ( undefined | string )[] Returns # ( undefined | 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 [] getRules # \u25b8 getRules (): IngressRule [] Returns # IngressRule [] getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getServiceNamePort # \u25b8 getServiceNamePort (): undefined | ExtensionsBackend Returns # undefined | ExtensionsBackend getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < Ingress > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> 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 < NamespaceScopedMetadata , IngressStatus , IngressSpec > \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 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 getCreationTimestamp getFinalizers getHosts getId getLabels getLoadBalancers getName getNs getOwnerRefs getPorts getResourceVersion getRoutes getRules getScopedName 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/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#spec","text":"\u2022 spec : IngressSpec","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#status","text":"\u2022 Optional status : IngressStatus","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/networking.k8s.io/v1/ingresses\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#kind_1","text":"\u25aa Static Readonly kind : \"Ingress\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#namespaced","text":"\u25aa Static Readonly namespaced : 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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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 (): ( undefined | 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/#getrules","text":"\u25b8 getRules (): IngressRule []","title":"getRules"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"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 (): undefined | ExtensionsBackend","title":"getServiceNamePort"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#gettimedifffromnow","text":"\u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.Ingress/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 doCheckPreferredVersion fallbackApiBases fullApiPathname isNamespaced kind objectConstructor request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse patch refreshResourceVersion setResourceVersion update watch Constructors # constructor # \u2022 new IngressApi ( opts? ) Parameters # Name Type opts DerivedKubeApiOptions & IgnoredKubeApiOptions Overrides # KubeApi . constructor Properties # apiBase # \u2022 apiBase : string Inherited from # KubeApi . apiBase apiGroup # \u2022 apiGroup : string Inherited from # KubeApi . apiGroup apiPrefix # \u2022 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 apiVersionPreferred : undefined | string Inherited from # KubeApi . apiVersionPreferred doCheckPreferredVersion # \u2022 Protected Readonly doCheckPreferredVersion : boolean Inherited from # KubeApi . doCheckPreferredVersion fallbackApiBases # \u2022 Protected Readonly fallbackApiBases : undefined | string [] Inherited from # KubeApi . fallbackApiBases fullApiPathname # \u2022 Protected Readonly fullApiPathname : string Inherited from # KubeApi . fullApiPathname isNamespaced # \u2022 Readonly isNamespaced : boolean Inherited from # KubeApi . isNamespaced kind # \u2022 Readonly kind : string Inherited from # KubeApi . kind objectConstructor # \u2022 Readonly objectConstructor : KubeObjectConstructor < Ingress , KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec >> Inherited from # KubeApi . objectConstructor request # \u2022 Protected Readonly request : KubeJsonApi Inherited from # KubeApi . request resourceVersions # \u2022 Protected Readonly resourceVersions : Map < string , string > Inherited from # KubeApi . resourceVersions watchDisposer # \u2022 Protected Readonly watchDisposer : undefined | Disposer Inherited from # KubeApi . watchDisposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Inherited from # KubeApi.apiVersionWithGroup Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise < void > Returns # Promise < void > Inherited from # KubeApi . checkPreferredVersion create # \u25b8 create ( __namedParameters , partialData? ): Promise < null | Ingress > Parameters # Name Type __namedParameters Partial < ResourceDescriptor > partialData? PartialObjectDeep < Ingress > Returns # Promise < null | Ingress > Inherited from # KubeApi . create delete # \u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Parameters # Name Type __namedParameters DeleteResourceDescriptor Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeApi . delete get # \u25b8 get ( desc , query? ): Promise < null | Ingress > Parameters # Name Type desc ResourceDescriptor query? KubeApiQueryParams Returns # Promise < null | Ingress > Inherited from # KubeApi . get getResourceVersion # \u25b8 getResourceVersion ( namespace? ): undefined | string Parameters # Name Type Default value namespace string \"\" Returns # undefined | string Inherited from # KubeApi . getResourceVersion getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Partial < ResourceDescriptor > query? Partial < KubeApiQueryParams > Returns # string Inherited from # KubeApi . getUrl getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query KubeApiQueryParams {} Returns # string Inherited from # KubeApi . getWatchUrl list # \u25b8 list ( __namedParameters? , query? ): Promise < null | Ingress []> Parameters # Name Type __namedParameters KubeApiListOptions query? KubeApiQueryParams Returns # Promise < null | Ingress []> Inherited from # KubeApi . list modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent < KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >> Returns # void Inherited from # KubeApi . modifyWatchEvent normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial < KubeApiQueryParams > Parameters # Name Type query Partial < KubeApiQueryParams > Returns # Partial < KubeApiQueryParams > Inherited from # KubeApi . normalizeQuery parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): null | Ingress | Ingress [] Parameters # Name Type data unknown namespace? string Returns # null | Ingress | Ingress [] Inherited from # KubeApi . parseResponse patch # \u25b8 patch ( desc , data , strategy? ): Promise < null | Ingress > Parameters # Name Type Default value desc ResourceDescriptor undefined data Patch | PartialObjectDeep < Ingress > undefined strategy KubeApiPatchType \"strategic\" Returns # Promise < null | Ingress > Inherited from # KubeApi . patch refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < null | Ingress []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < null | 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 < null | Ingress > Parameters # Name Type __namedParameters ResourceDescriptor data PartialObjectDeep < Ingress > Returns # Promise < null | Ingress > Inherited from # KubeApi . update watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions < Ingress , KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec >> 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 doCheckPreferredVersion fallbackApiBases fullApiPathname isNamespaced kind objectConstructor 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 patch 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 ( opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apibase","text":"\u2022 apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apigroup","text":"\u2022 apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#apiprefix","text":"\u2022 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 apiVersionPreferred : undefined | string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#docheckpreferredversion","text":"\u2022 Protected Readonly doCheckPreferredVersion : boolean","title":"doCheckPreferredVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#fallbackapibases","text":"\u2022 Protected Readonly fallbackApiBases : undefined | string []","title":"fallbackApiBases"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#fullapipathname","text":"\u2022 Protected Readonly fullApiPathname : string","title":"fullApiPathname"},{"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 Readonly objectConstructor : KubeObjectConstructor < Ingress , KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec >>","title":"objectConstructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#request","text":"\u2022 Protected Readonly request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#resourceversions","text":"\u2022 Protected Readonly resourceVersions : Map < string , string >","title":"resourceVersions"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#watchdisposer","text":"\u2022 Protected Readonly watchDisposer : undefined | Disposer","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 , partialData? ): Promise < null | Ingress >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >>","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#get","text":"\u25b8 get ( desc , query? ): Promise < null | Ingress >","title":"get"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): undefined | 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 < null | 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 < KubeApiQueryParams >","title":"normalizeQuery"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): null | Ingress | Ingress []","title":"parseResponse"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#patch","text":"\u25b8 patch ( desc , data , strategy? ): Promise < null | Ingress >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressApi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < null | 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 < null | 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 , IngressApi > \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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new IngressStore ( api , opts? ) Parameters # Name Type api IngressApi opts? KubeObjectStoreOptions Inherited from # KubeObjectStore . constructor \u2022 new IngressStore () deprecated Supply API instance through constructor Inherited from # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : IngressApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec >>> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < Ingress > Returns # Promise < Ingress > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Ingress > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Ingress > Returns # Promise < null | 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 ): undefined | Ingress Parameters # Name Type id string Returns # undefined | Ingress Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Ingress [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Ingress [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Ingress Parameters # Name Type name string namespace? string Returns # undefined | Ingress Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | Ingress Parameters # Name Type path string Returns # undefined | 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 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 ( __namedParameters? ): Promise < undefined | Ingress []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | Ingress > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Ingress > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Ingress []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < Ingress []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): Ingress [] Parameters # Name Type partialItems Ingress [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): Ingress [] Parameters # Name Type items Ingress [] Returns # Ingress [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Ingress []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Ingress [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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? \"asc\" | \"desc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Ingress [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , IngressApi > \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 getTotalCount isSelected isSelectedAll load loadAll loadFromPath loadItem loadItems mergeItems patch pickOnlySelected reloadAll remove removeItem removeItems 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 , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#api","text":"\u2022 Readonly api : IngressApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , IngressStatus , IngressSpec >>>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | Ingress","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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/#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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Ingress []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.IngressStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 # KubeObject < NamespaceScopedMetadata , JobStatus , JobSpec > \u21b3 Job Table of contents # Constructors # constructor Properties # apiVersion kind metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAffinity getAffinityNumber getAge getAnnotations getCompletions getCondition getCreationTimestamp getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getScopedName 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 < NamespaceScopedMetadata , JobStatus , JobSpec > Inherited from # KubeObject . constructor Properties # apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion kind # \u2022 kind : string Inherited from # KubeObject . kind metadata # \u2022 metadata : NamespaceScopedMetadata Inherited from # KubeObject . metadata spec # \u2022 spec : JobSpec Inherited from # KubeObject . spec status # \u2022 Optional status : JobStatus Inherited from # KubeObject . status apiBase # \u25aa Static Readonly apiBase : \"/apis/batch/v1/jobs\" Overrides # KubeObject . apiBase kind # \u25aa Static Readonly kind : \"Job\" Overrides # KubeObject . kind namespaced # \u25aa Static Readonly namespaced : true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAffinity # \u25b8 getAffinity (): undefined | Affinity Returns # undefined | Affinity getAffinityNumber # \u25b8 getAffinityNumber (): number Returns # number getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 getCompletions # \u25b8 getCompletions (): number Returns # number getCondition # \u25b8 getCondition (): undefined | BaseKubeObjectCondition Returns # undefined | BaseKubeObjectCondition getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getDesiredCompletions # \u25b8 getDesiredCompletions (): number Returns # number getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getId # \u25b8 getId (): string Returns # string Inherited from # KubeObject . getId getImages # \u25b8 getImages (): string [] Returns # string [] getLabels # \u25b8 getLabels (): string [] Returns # string [] Inherited from # KubeObject . getLabels getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNodeSelectors # \u25b8 getNodeSelectors (): string [] Returns # 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 getParallelism # \u25b8 getParallelism (): undefined | number Returns # undefined | number getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): string [] Returns # string [] Inherited from # KubeObject . getSearchFields getSelectors # \u25b8 getSelectors (): string [] Returns # string [] getTemplateLabels # \u25b8 getTemplateLabels (): string [] Returns # string [] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow getTolerations # \u25b8 getTolerations (): Toleration [] Returns # Toleration [] patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < Job > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> Returns # string [] Inherited from # KubeObject . 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":"KubeObject < NamespaceScopedMetadata , JobStatus , JobSpec > \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 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 getCreationTimestamp getDesiredCompletions getFinalizers getId getImages getLabels getName getNodeSelectors getNs getOwnerRefs getParallelism getResourceVersion getScopedName 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/#metadata","text":"\u2022 metadata : NamespaceScopedMetadata","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#spec","text":"\u2022 spec : JobSpec","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#status","text":"\u2022 Optional status : JobStatus","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#apibase","text":"\u25aa Static Readonly apiBase : \"/apis/batch/v1/jobs\"","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#kind_1","text":"\u25aa Static Readonly kind : \"Job\"","title":"kind"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#namespaced","text":"\u25aa Static Readonly namespaced : 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 ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getaffinity","text":"\u25b8 getAffinity (): undefined | Affinity","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 deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","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 (): undefined | BaseKubeObjectCondition","title":"getCondition"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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 (): undefined | number","title":"getParallelism"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getresourceversion","text":"\u25b8 getResourceVersion (): string","title":"getResourceVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"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 deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","title":"getTimeDiffFromNow"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#gettolerations","text":"\u25b8 getTolerations (): Toleration []","title":"getTolerations"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#patch","text":"\u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.Job/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 , JobApi > \u21b3 JobStore Table of contents # Constructors # constructor Properties # api bufferSize dependencies 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 pickOnlySelected reloadAll remove removeItem removeItems removeSelectedItems reset resetOnError resetSelection select sortItems subscribe toggleSelection toggleSelectionAll unselect update updateFromEventsBuffer updateItem Constructors # constructor # \u2022 new JobStore ( dependencies , api , opts? ) Parameters # Name Type dependencies Dependencies api JobApi opts? KubeObjectStoreOptions Overrides # KubeObjectStore . constructor Properties # api # \u2022 Readonly api : JobApi Inherited from # KubeObjectStore . api bufferSize # \u2022 Readonly bufferSize : number Inherited from # KubeObjectStore . bufferSize dependencies # \u2022 Protected Readonly dependencies : Dependencies eventsBuffer # \u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , JobStatus , JobSpec >>> 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 Readonly limit : undefined | number Inherited from # KubeObjectStore . limit selectedItemsIds # \u2022 selectedItemsIds : ObservableSet < string > Inherited from # KubeObjectStore . selectedItemsIds defaultContext # \u25aa Static Readonly defaultContext : IObservableValue < undefined | ClusterContext > Inherited from # KubeObjectStore . defaultContext Accessors # context # \u2022 get context (): undefined | ClusterContext Returns # undefined | ClusterContext Inherited from # KubeObjectStore.context contextItems # \u2022 get contextItems (): K [] Returns # K [] Inherited from # KubeObjectStore.contextItems contextReady # \u2022 get contextReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.contextReady namespacesReady # \u2022 get namespacesReady (): Promise < void > & { cancel : () => void } Returns # Promise < void > & { cancel : () => void } Inherited from # KubeObjectStore.namespacesReady query # \u2022 get query (): KubeApiQueryParams Returns # KubeApiQueryParams Inherited from # KubeObjectStore.query selectedItems # \u2022 get selectedItems (): Item [] Returns # Item [] Inherited from # KubeObjectStore.selectedItems 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? PartialObjectDeep < Job > Returns # Promise < Job > Inherited from # KubeObjectStore . create createItem # \u25b8 Protected createItem ( params , data? ): Promise < null | Job > Parameters # Name Type params Object params.name string params.namespace? string data? PartialObjectDeep < Job > Returns # Promise < null | 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 ): undefined | Job Parameters # Name Type id string Returns # undefined | Job Inherited from # KubeObjectStore . getById getByLabel # \u25b8 getByLabel ( labels ): Job [] Parameters # Name Type labels string [] | Partial < Record < string , string >> Returns # Job [] Inherited from # KubeObjectStore . getByLabel getByName # \u25b8 getByName ( name , namespace? ): undefined | Job Parameters # Name Type name string namespace? string Returns # undefined | Job Inherited from # KubeObjectStore . getByName getByPath # \u25b8 getByPath ( path ): undefined | Job Parameters # Name Type path string Returns # undefined | 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 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 ( __namedParameters? ): Promise < undefined | Job []> Parameters # Name Type __namedParameters KubeObjectStoreLoadAllParams Returns # Promise < undefined | 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 < null | Job > Parameters # Name Type params Object params.name string params.namespace? string Returns # Promise < null | Job > Inherited from # KubeObjectStore . loadItem loadItems # \u25b8 Protected loadItems ( __namedParameters ): Promise < Job []> Parameters # Name Type __namedParameters KubeObjectStoreLoadingParams Returns # Promise < Job []> Inherited from # KubeObjectStore . loadItems mergeItems # \u25b8 Protected mergeItems ( partialItems , __namedParameters ): Job [] Parameters # Name Type partialItems Job [] __namedParameters MergeItemsOptions 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 pickOnlySelected # \u25b8 pickOnlySelected ( items ): Job [] Parameters # Name Type items Job [] Returns # Job [] Inherited from # KubeObjectStore . pickOnlySelected reloadAll # \u25b8 reloadAll ( opts? ): Promise < undefined | Job []> Parameters # Name Type opts Object opts.force? boolean opts.merge? boolean opts.namespaces? string [] Returns # Promise < undefined | 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 removeItems # \u25b8 removeItems ( items ): Promise < void > Parameters # Name Type items Job [] Returns # Promise < void > Inherited from # KubeObjectStore . removeItems 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? \"asc\" | \"desc\" whether to sort from least to greatest ( \"asc\" (default)) or vice-versa ( \"desc\" ) Returns # Job [] Inherited from # KubeObjectStore . sortItems subscribe # \u25b8 subscribe ( __namedParameters? ): Disposer Parameters # Name Type __namedParameters KubeObjectStoreSubscribeParams Returns # Disposer 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 PartialObjectDeep < 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 , JobApi > \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 dependencies 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 pickOnlySelected reloadAll remove removeItem removeItems 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 ( dependencies , api , opts? )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#api","text":"\u2022 Readonly api : JobApi","title":"api"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#buffersize","text":"\u2022 Readonly bufferSize : number","title":"bufferSize"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#dependencies","text":"\u2022 Protected Readonly dependencies : Dependencies","title":"dependencies"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#eventsbuffer","text":"\u2022 Protected eventsBuffer : IObservableArray < IKubeWatchEvent < KubeJsonApiData < NamespaceScopedMetadata , JobStatus , JobSpec >>>","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 Readonly limit : undefined | number","title":"limit"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#selecteditemsids","text":"\u2022 selectedItemsIds : ObservableSet < string >","title":"selectedItemsIds"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#defaultcontext","text":"\u25aa Static Readonly defaultContext : IObservableValue < undefined | 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 (): undefined | ClusterContext","title":"context"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#contextitems","text":"\u2022 get contextItems (): K []","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 (): KubeApiQueryParams","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 < null | 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 ): undefined | 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? ): undefined | Job","title":"getByName"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#getbypath","text":"\u25b8 getByPath ( path ): undefined | 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 ( __namedParameters? ): Promise < undefined | 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 < null | 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/#pickonlyselected","text":"\u25b8 pickOnlySelected ( items ): Job []","title":"pickOnlySelected"},{"location":"extensions/api/classes/Renderer.K8sApi.JobStore/#reloadall","text":"\u25b8 reloadAll ( opts? ): Promise < undefined | 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/#removeitems","text":"\u25b8 removeItems ( items ): Promise < void >","title":"removeItems"},{"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 ( __namedParameters? ): Disposer","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 Object extends KubeObject = KubeObject Data extends KubeJsonApiDataFor < Object > = KubeJsonApiDataFor < Object > Hierarchy # KubeApi \u21b3 PodsApi \u21b3 NodesApi \u21b3 DeploymentApi \u21b3 IngressApi \u21b3 PersistentVolumeClaimsApi Table of contents # Constructors # constructor Properties # apiBase apiGroup apiPrefix apiResource apiVersion apiVersionPreferred doCheckPreferredVersion fallbackApiBases fullApiPathname isNamespaced kind objectConstructor request resourceVersions watchDisposer Accessors # apiVersionWithGroup Methods # checkPreferredVersion create delete get getResourceVersion getUrl getWatchUrl list modifyWatchEvent normalizeQuery parseResponse patch refreshResourceVersion setResourceVersion update watch Constructors # constructor # \u2022 new KubeApi < Object , Data >( opts ) Type parameters # Name Type Object extends KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Object > = KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Data extends KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown , Data > = KubeJsonApiDataFor < Object > Parameters # Name Type opts KubeApiOptions < Object , Data > Properties # apiBase # \u2022 apiBase : string apiGroup # \u2022 apiGroup : string apiPrefix # \u2022 apiPrefix : string apiResource # \u2022 Readonly apiResource : string apiVersion # \u2022 Readonly apiVersion : string apiVersionPreferred # \u2022 apiVersionPreferred : undefined | string doCheckPreferredVersion # \u2022 Protected Readonly doCheckPreferredVersion : boolean fallbackApiBases # \u2022 Protected Readonly fallbackApiBases : undefined | string [] fullApiPathname # \u2022 Protected Readonly fullApiPathname : string isNamespaced # \u2022 Readonly isNamespaced : boolean kind # \u2022 Readonly kind : string objectConstructor # \u2022 Readonly objectConstructor : KubeObjectConstructor < Object , Data > request # \u2022 Protected Readonly request : KubeJsonApi resourceVersions # \u2022 Protected Readonly resourceVersions : Map < string , string > watchDisposer # \u2022 Protected Readonly watchDisposer : undefined | Disposer Accessors # apiVersionWithGroup # \u2022 get apiVersionWithGroup (): string Returns # string Methods # checkPreferredVersion # \u25b8 Protected checkPreferredVersion (): Promise < void > Returns # Promise < void > create # \u25b8 create ( __namedParameters , partialData? ): Promise < null | Object > Parameters # Name Type __namedParameters Partial < ResourceDescriptor > partialData? PartialDeep < Object > Returns # Promise < null | Object > delete # \u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Parameters # Name Type __namedParameters DeleteResourceDescriptor Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> get # \u25b8 get ( desc , query? ): Promise < null | Object > Parameters # Name Type desc ResourceDescriptor query? KubeApiQueryParams Returns # Promise < null | Object > getResourceVersion # \u25b8 getResourceVersion ( namespace? ): undefined | string Parameters # Name Type Default value namespace string \"\" Returns # undefined | string getUrl # \u25b8 getUrl ( __namedParameters? , query? ): string Parameters # Name Type __namedParameters Partial < ResourceDescriptor > query? Partial < KubeApiQueryParams > Returns # string getWatchUrl # \u25b8 getWatchUrl ( namespace? , query? ): string Parameters # Name Type Default value namespace string \"\" query KubeApiQueryParams {} Returns # string list # \u25b8 list ( __namedParameters? , query? ): Promise < null | Object []> Parameters # Name Type __namedParameters KubeApiListOptions query? KubeApiQueryParams Returns # Promise < null | Object []> modifyWatchEvent # \u25b8 Protected modifyWatchEvent ( event ): void Parameters # Name Type event IKubeWatchEvent < KubeJsonApiData < KubeObjectMetadata < KubeObjectScope >, unknown , unknown >> Returns # void normalizeQuery # \u25b8 Protected normalizeQuery ( query? ): Partial < KubeApiQueryParams > Parameters # Name Type query Partial < KubeApiQueryParams > Returns # Partial < KubeApiQueryParams > parseResponse # \u25b8 Protected parseResponse ( data , namespace? ): null | Object | Object [] Parameters # Name Type data unknown namespace? string Returns # null | Object | Object [] patch # \u25b8 patch ( desc , data , strategy? ): Promise < null | Object > Parameters # Name Type Default value desc ResourceDescriptor undefined data Patch | PartialDeep < Object > undefined strategy KubeApiPatchType \"strategic\" Returns # Promise < null | Object > refreshResourceVersion # \u25b8 refreshResourceVersion ( params? ): Promise < null | Object []> Parameters # Name Type params? KubeApiListOptions Returns # Promise < null | Object []> setResourceVersion # \u25b8 setResourceVersion ( namespace? , newVersion ): void Parameters # Name Type Default value namespace string \"\" newVersion string undefined Returns # void update # \u25b8 update ( __namedParameters , data ): Promise < null | Object > Parameters # Name Type __namedParameters ResourceDescriptor data PartialDeep < Object > Returns # Promise < null | Object > watch # \u25b8 watch ( opts? ): () => void Parameters # Name Type opts KubeApiWatchOptions < Object , Data > Returns # fn \u25b8 (): void Returns # void","title":"Class: KubeApi"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#class-kubeapiobject-data","text":"Renderer . K8sApi .KubeApi","title":"Class: KubeApi<Object, Data>"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#type-parameters","text":"Name Type Object extends KubeObject = KubeObject Data extends KubeJsonApiDataFor < Object > = KubeJsonApiDataFor < Object >","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 doCheckPreferredVersion fallbackApiBases fullApiPathname isNamespaced kind objectConstructor 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 patch 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 < Object , Data >( opts )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apibase","text":"\u2022 apiBase : string","title":"apiBase"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apigroup","text":"\u2022 apiGroup : string","title":"apiGroup"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#apiprefix","text":"\u2022 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 apiVersionPreferred : undefined | string","title":"apiVersionPreferred"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#docheckpreferredversion","text":"\u2022 Protected Readonly doCheckPreferredVersion : boolean","title":"doCheckPreferredVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#fallbackapibases","text":"\u2022 Protected Readonly fallbackApiBases : undefined | string []","title":"fallbackApiBases"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#fullapipathname","text":"\u2022 Protected Readonly fullApiPathname : string","title":"fullApiPathname"},{"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 Readonly objectConstructor : KubeObjectConstructor < Object , Data >","title":"objectConstructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#request","text":"\u2022 Protected Readonly request : KubeJsonApi","title":"request"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#resourceversions","text":"\u2022 Protected Readonly resourceVersions : Map < string , string >","title":"resourceVersions"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#watchdisposer","text":"\u2022 Protected Readonly watchDisposer : undefined | Disposer","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 , partialData? ): Promise < null | Object >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#delete","text":"\u25b8 delete ( __namedParameters ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >>","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#get","text":"\u25b8 get ( desc , query? ): Promise < null | Object >","title":"get"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#getresourceversion","text":"\u25b8 getResourceVersion ( namespace? ): undefined | 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 < null | Object []>","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 < KubeApiQueryParams >","title":"normalizeQuery"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#parseresponse","text":"\u25b8 Protected parseResponse ( data , namespace? ): null | Object | Object []","title":"parseResponse"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#patch","text":"\u25b8 patch ( desc , data , strategy? ): Promise < null | Object >","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeApi/#refreshresourceversion","text":"\u25b8 refreshResourceVersion ( params? ): Promise < null | Object []>","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 < null | Object >","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 # action apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp message metadata reason related reportingComponent reportingInstance series source spec status type apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getScopedName getSearchFields getSource getTimeDiffFromNow isWarning patch toPlainObject update create isJsonApiData isJsonApiDataList isKubeJsonApiListMetadata isKubeJsonApiMetadata isNonSystem isPartialJsonApiData isPartialJsonApiMetadata stringifyLabels Constructors # constructor # \u2022 new KubeEvent ( __namedParameters ) Parameters # Name Type __namedParameters KubeEventData Overrides # KubeObject . constructor Properties # action # \u2022 Optional action : string apiVersion # \u2022 apiVersion : string Inherited from # KubeObject . apiVersion count # \u2022 Optional count : number eventTime # \u2022 Optional eventTime : string firstTimestamp # \u2022 Optional firstTimestamp : string involvedObject # \u2022 involvedObject : Required < ObjectReference > kind # \u2022 kind : string Inherited from # KubeObject . kind lastTimestamp # \u2022 Optional lastTimestamp : string message # \u2022 Optional message : string metadata # \u2022 metadata : KubeObjectMetadata < KubeObjectScope > Inherited from # KubeObject . metadata reason # \u2022 Optional reason : string related # \u2022 Optional related : ObjectReference reportingComponent # \u2022 Optional reportingComponent : string reportingInstance # \u2022 Optional reportingInstance : string series # \u2022 Optional series : EventSeries source # \u2022 Optional source : EventSource spec # \u2022 spec : unknown Inherited from # KubeObject . spec status # \u2022 Optional status : unknown Inherited from # KubeObject . status type # \u2022 Optional type : string Current supported values are: - \"Normal\" - \"Warning\" apiBase # \u25aa Static apiBase : string = \"/api/v1/events\" Overrides # KubeObject . apiBase kind # \u25aa Static kind : string = \"Event\" Overrides # KubeObject . kind namespaced # \u25aa Static namespaced : boolean = true Overrides # KubeObject . namespaced Accessors # selfLink # \u2022 get selfLink (): string Returns # string Inherited from # KubeObject.selfLink Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . delete getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number Inherited from # KubeObject . getCreationTimestamp getFinalizers # \u25b8 getFinalizers (): string [] Returns # string [] Inherited from # KubeObject . getFinalizers getFirstSeenTime # \u25b8 getFirstSeenTime (): string deprecated This function is not reactive to changing of time. If rendering use instead 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 deprecated This function is not reactive to changing of time. If rendering use instead Returns # string getName # \u25b8 getName (): string Returns # string Inherited from # KubeObject . getName getNs # \u25b8 getNs (): undefined | string Returns # undefined | string Inherited from # KubeObject . getNs getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined | string ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : undefined | string ; uid : string }[] Inherited from # KubeObject . getOwnerRefs getResourceVersion # \u25b8 getResourceVersion (): string Returns # string Inherited from # KubeObject . getResourceVersion getScopedName # \u25b8 getScopedName (): string Returns # string Inherited from # KubeObject . getScopedName getSearchFields # \u25b8 getSearchFields (): ( undefined | string )[] Returns # ( undefined | string )[] Inherited from # KubeObject . getSearchFields getSource # \u25b8 getSource (): string Returns # string getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number Inherited from # KubeObject . getTimeDiffFromNow isWarning # \u25b8 isWarning (): boolean Returns # boolean patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . patch toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject Inherited from # KubeObject . toPlainObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < KubeEvent > Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> Inherited from # KubeObject . update create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > Inherited from # KubeObject . create isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData, unknown, unknown> 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 KubeJsonApiObjectMetadata Parameters # Name Type object unknown Returns # object is KubeJsonApiObjectMetadata Inherited from # KubeObject . isKubeJsonApiMetadata isNonSystem # \u25b8 Static isNonSystem ( item ): boolean Parameters # Name Type item KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown > | KubeObject < KubeObjectMetadata < KubeObjectScope >, unknown , unknown > Returns # boolean Inherited from # KubeObject . isNonSystem isPartialJsonApiData # \u25b8 Static isPartialJsonApiData ( object ): object is Partial, unknown, unknown>> Parameters # Name Type object unknown Returns # object is Partial, unknown, unknown>> 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? Partial < Record < string , string >> 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":"action apiVersion count eventTime firstTimestamp involvedObject kind lastTimestamp message metadata reason related reportingComponent reportingInstance series 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 getCreationTimestamp getFinalizers getFirstSeenTime getId getLabels getLastSeenTime getName getNs getOwnerRefs getResourceVersion getScopedName 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 ( __namedParameters )","title":"constructor"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#properties_1","text":"","title":"Properties"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#action","text":"\u2022 Optional action : string","title":"action"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#apiversion","text":"\u2022 apiVersion : string","title":"apiVersion"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#count","text":"\u2022 Optional count : number","title":"count"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#eventtime","text":"\u2022 Optional eventTime : string","title":"eventTime"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#firsttimestamp","text":"\u2022 Optional firstTimestamp : string","title":"firstTimestamp"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#involvedobject","text":"\u2022 involvedObject : Required < ObjectReference >","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 Optional lastTimestamp : string","title":"lastTimestamp"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#message","text":"\u2022 Optional message : string","title":"message"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#metadata","text":"\u2022 metadata : KubeObjectMetadata < KubeObjectScope >","title":"metadata"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#reason","text":"\u2022 Optional reason : string","title":"reason"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#related","text":"\u2022 Optional related : ObjectReference","title":"related"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#reportingcomponent","text":"\u2022 Optional reportingComponent : string","title":"reportingComponent"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#reportinginstance","text":"\u2022 Optional reportingInstance : string","title":"reportingInstance"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#series","text":"\u2022 Optional series : EventSeries","title":"series"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#source","text":"\u2022 Optional source : EventSource","title":"source"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#spec","text":"\u2022 spec : unknown","title":"spec"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#status","text":"\u2022 Optional status : unknown","title":"status"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#type","text":"\u2022 Optional type : string Current supported values are: - \"Normal\" - \"Warning\"","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 < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead","title":"delete"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getage","text":"\u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering","title":"getAge"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getannotations","text":"\u25b8 getAnnotations ( filter? ): string []","title":"getAnnotations"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getcreationtimestamp","text":"\u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object.","title":"getCreationTimestamp"},{"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 deprecated This function is not reactive to changing of time. If rendering use instead","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 deprecated This function is not reactive to changing of time. If rendering use instead","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 (): undefined | 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 : undefined | 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/#getscopedname","text":"\u25b8 getScopedName (): string","title":"getScopedName"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#getsearchfields","text":"\u25b8 getSearchFields (): ( undefined | 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 deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead.","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 < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead","title":"patch"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#toplainobject","text":"\u25b8 toPlainObject (): JsonObject","title":"toPlainObject"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#update","text":"\u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead","title":"update"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#create","text":"\u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec >","title":"create"},{"location":"extensions/api/classes/Renderer.K8sApi.KubeEvent/#isjsonapidata","text":"\u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown>","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 KubeJsonApiObjectMetadata","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, unknown, unknown>>","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 < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Hierarchy # KubeObject \u21b3 Pod \u21b3 Node \u21b3 Deployment \u21b3 DaemonSet \u21b3 StatefulSet \u21b3 Job \u21b3 CronJob \u21b3 ConfigMap \u21b3 Secret \u21b3 ReplicaSet \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 metadata spec status apiBase kind namespaced Accessors # selfLink Methods # delete getAge getAnnotations getCreationTimestamp getFinalizers getId getLabels getName getNs getOwnerRefs getResourceVersion getScopedName 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 < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Properties # apiVersion # \u2022 apiVersion : string kind # \u2022 kind : string metadata # \u2022 metadata : Metadata spec # \u2022 spec : Spec status # \u2022 Optional status : Status apiBase # \u25aa Static Optional Readonly apiBase : string kind # \u25aa Static Optional Readonly kind : string namespaced # \u25aa Static Optional Readonly namespaced : boolean Accessors # selfLink # \u2022 get selfLink (): string Returns # string Methods # delete # \u25b8 delete ( params? ): Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.delete instead Parameters # Name Type params? object Returns # Promise < KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> getAge # \u25b8 getAge ( humanize? , compact? , fromNow? ): string | number deprecated This function computes a new \"now\" on every call might cause subtle issues if called multiple times NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering 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 [] getCreationTimestamp # \u25b8 getCreationTimestamp (): number This function computes the number of milliseconds from the UNIX EPOCH to the creation timestamp of this object. Returns # number 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 (): Metadata [ \"namespace\" ] Returns # Metadata [ \"namespace\" ] getOwnerRefs # \u25b8 getOwnerRefs (): { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : Metadata [ \"namespace\" ] ; uid : string }[] Returns # { apiVersion : string ; blockOwnerDeletion? : boolean ; controller? : boolean ; kind : string ; name : string ; namespace : Metadata [ \"namespace\" ] ; uid : string }[] getResourceVersion # \u25b8 getResourceVersion (): string Returns # string getScopedName # \u25b8 getScopedName (): string Returns # string getSearchFields # \u25b8 getSearchFields (): ( string | Metadata [ \"namespace\" ])[] Returns # ( string | Metadata [ \"namespace\" ])[] getTimeDiffFromNow # \u25b8 getTimeDiffFromNow (): number deprecated This function computes a new \"now\" on every call which might cause subtle issues if called multiple times NOTE: Generally you can use getCreationTimestamp instead. Returns # number patch # \u25b8 patch ( patch ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> deprecated use KubeApi.patch instead Parameters # Name Type patch Patch Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> toPlainObject # \u25b8 toPlainObject (): JsonObject Returns # JsonObject update # \u25b8 update ( data ): Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> 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. deprecated use KubeApi.update instead Parameters # Name Type data Partial < KubeObject < Metadata , Status , Spec >> Returns # Promise < null | KubeJsonApiData < KubeJsonApiObjectMetadata < KubeObjectScope >, unknown , unknown >> create # \u25b8 Static create < Metadata , Status , Spec >( data ): KubeObject < Metadata , Status , Spec > Type parameters # Name Type Metadata extends KubeObjectMetadata < KubeObjectScope > = KubeObjectMetadata < KubeObjectScope > Status unknown Spec unknown Parameters # Name Type data KubeJsonApiData < Metadata , Status , Spec > Returns # KubeObject < Metadata , Status , Spec > isJsonApiData # \u25b8 Static isJsonApiData ( object ): object is KubeJsonApiData, unknown, unknown> Parameters # Name Type object unknown Returns # object is KubeJsonApiData